Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document implementation details of the operator #661

Merged
merged 11 commits into from
Jun 20, 2023

Conversation

jmazzitelli
Copy link
Contributor

No description provided.

@jmazzitelli jmazzitelli self-assigned this Jun 14, 2023
@jmazzitelli jmazzitelli marked this pull request as ready for review June 15, 2023 18:46
Copy link
Contributor

@jshaughn jshaughn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A lot of good info that should save you/us from repeatedly repeating it in ad-hoc locations. No real content changes, just a few nit recommendations. Only thing I wonder is whether we need a section on "What to do after every release?".

DEVELOPING.adoc Outdated Show resolved Hide resolved
IMPLEMENTATION.adoc Outdated Show resolved Hide resolved

NOTE: If you need to add support for a new version or remove support for an obsolete version, see link:./DEVELOPING.adoc[DEVELOPING.adoc] for those instructions.

To tell the KO which version of Kiali to install, you set the `spec.version` field in the Kiali CR. If no `spec.version` is defined in the Kiali CR, the default Ansible role that is executed is defined in link:https://github.com/kiali/kiali-operator/blob/v1.69.0/playbooks/default-playbook.yml[default-playbook.yml] (side note: the file, and the field inside it, are technically named incorrectly. This isn't the default _playbook_, instead it is the default _role_. But ignore that.) Today, the default version of the Ansible role that is invoked is called, literally, link:https://github.com/kiali/kiali-operator/tree/v1.69.0/roles/default[default]. This `default` version is the only one that the upstream Kiali project officially supports.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add a line of why the other roles exist if default is the only one needed for upstream.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done.

IMPLEMENTATION.adoc Outdated Show resolved Hide resolved
IMPLEMENTATION.adoc Outdated Show resolved Hide resolved
IMPLEMENTATION.adoc Outdated Show resolved Hide resolved
IMPLEMENTATION.adoc Outdated Show resolved Hide resolved
IMPLEMENTATION.adoc Outdated Show resolved Hide resolved
IMPLEMENTATION.adoc Outdated Show resolved Hide resolved
IMPLEMENTATION.adoc Outdated Show resolved Hide resolved
jmazzitelli and others added 10 commits June 20, 2023 13:35
Co-authored-by: Jay Shaughnessy <[email protected]>
Co-authored-by: Jay Shaughnessy <[email protected]>
Co-authored-by: Jay Shaughnessy <[email protected]>
Co-authored-by: Jay Shaughnessy <[email protected]>
Co-authored-by: Jay Shaughnessy <[email protected]>
Co-authored-by: Jay Shaughnessy <[email protected]>
Co-authored-by: Jay Shaughnessy <[email protected]>
Co-authored-by: Jay Shaughnessy <[email protected]>
Co-authored-by: Jay Shaughnessy <[email protected]>
@jmazzitelli jmazzitelli requested a review from jshaughn June 20, 2023 18:01
Copy link
Contributor

@jshaughn jshaughn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LG!

@jmazzitelli jmazzitelli merged commit b12c2f8 into kiali:master Jun 20, 2023
@jmazzitelli jmazzitelli deleted the dev-doc branch June 20, 2023 18:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

2 participants