Add documentation for galley.enableAnalysis #5216
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
geeknoid
reviewed
Oct 21, 2019
davidebbo
reviewed
Oct 22, 2019
|
|
||
| *Note that this feature is experimental.* | ||
|
|
||
| Starting with Istio 1.4, Galley can be set up to perform configuration analysis alongside the configuration distribution that it is primarily responsible for. Validation messages from the analysis are written to the status subresource of the affected Istio resource. This lets you find many configuration errors in your mesh without needing to run a separate command. This analysis uses the same logic and error messages as when using `istioctl analyze`. |
There was a problem hiding this comment.
We need to emphasize that this is completely different from 'istioctl analyze'. Specifically:
- You can run analyze against much older clusters, while this only helps with absolute newest clusters
- It only lets you get status messages one by one, so it's not at all a replacement for
analyze, which gives you everything. In this sense, I find the statement This lets you find many configuration errors in your mesh without needing to run a separate command rather confusing.
Is this on by default in 1.4?
There was a problem hiding this comment.
It is off by default in 1.4.
Added a section with some caveats / explanations of what's different.
Co-Authored-By: Martin Taillefer <geeknoid@users.noreply.github.com>
geeknoid
reviewed
Oct 22, 2019
Co-Authored-By: Martin Taillefer <geeknoid@users.noreply.github.com>
geeknoid
approved these changes
Oct 23, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add basic documentation for galley.enableAnalysis
Also add a link to validation message reference docs and fix the format of the CLI message.
For now, at least, I'm bundling this with the
istioctl analyzedoc. At some point it will probably need to get its own page.[ ] Configuration Infrastructure
[X] Docs
[ ] Installation
[ ] Networking
[ ] Performance and Scalability
[ ] Policies and Telemetry
[ ] Security
[ ] Test and Release
[ ] User Experience
[ ] Developer Infrastructure