Improve clarity around namespace usage in k8sgpt operator workflow #131
Conversation
This file contains 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
The current workflow for the k8sgpt operator installation is potentially confusing. During installation, users are instructed to: Create the k8sgpt-operator-system namespace. Deploy a secret into the k8sgpt-operator-system namespace. Deploy the k8sgpt resource into the same namespace. However, when checking the results, the instructions direct users to use the default namespace. This discrepancy can lead to confusion about where resources and results are expected to be located. This commit aims to address and clarify namespace usage throughout the operator installation and result-checking process to ensure consistency and reduce confusion for users. Signed-off-by: 100daysofdevops <47483190+100daysofdevops@users.noreply.github.com>
✅ Deploy Preview for meek-marigold-103c48 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
AlexsJones
approved these changes
Dec 15, 2024
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.
The current workflow for the k8sgpt operator installation is potentially confusing. During installation, users are instructed to:
Create the k8sgpt-operator-system namespace.
Deploy a secret into the k8sgpt-operator-system namespace. Deploy the k8sgpt resource into the same namespace. However, when checking the results, the instructions direct users to use the default namespace. This discrepancy can lead to confusion about where resources and results are expected to be located.
This commit aims to address and clarify namespace usage throughout the operator installation and result-checking process to ensure consistency and reduce confusion for users.
Closes #
📑 Description
This pull request clarifies the namespace usage during the k8sgpt operator installation workflow. It aligns the instructions for namespace creation, secret deployment, and result-checking to reduce user confusion and ensure consistency.
✅ Checks
ℹ Additional Information
This update ensures that all commands and instructions consistently refer to the k8sgpt-operator-system namespace unless explicitly stated otherwise. No breaking changes are introduced. Documentation updates include adjustments to installation and result-checking steps. Screenshots and examples illustrating the workflow have also been added to the documentation.