-
Notifications
You must be signed in to change notification settings - Fork 11
feat(docs): add Catalog playbook #2101
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
Open
uwe-mayer
wants to merge
5
commits into
main
Choose a base branch
from
chore/add-catalog-playbook
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| --- | ||
| title: "CatalogNotReady" | ||
| linkTitle: "CatalogNotReady" | ||
| landingSectionIndex: false | ||
| weight: 1 | ||
| description: > | ||
| Playbook for the GreenhouseCatalogNotReady Alert | ||
| --- | ||
|
|
||
| ## Alert Description | ||
|
|
||
| This alert fires when a Greenhouse catalog has not been ready for more than 15 minutes. | ||
|
|
||
| ## What does this alert mean? | ||
|
|
||
| A Catalog in Greenhouse holds the available PluginDefinitions and acts as the source of truth for which plugins can be deployed within an organization. When a catalog is not ready, it indicates that the catalog source cannot be synchronized or that the catalog controller is unable to process it correctly. | ||
|
|
||
| This could be due to: | ||
|
|
||
| - The catalog source (e.g. Helm repository, OCI registry) being unavailable or unreachable | ||
| - Invalid or expired credentials for accessing the catalog source | ||
| - A misconfigured catalog resource (e.g. wrong URL, invalid reference) | ||
| - The catalog controller encountering errors during reconciliation | ||
| - Network connectivity issues between the Greenhouse operator and the catalog source | ||
|
|
||
| ## Diagnosis | ||
|
|
||
| ### Get the Catalog Resource | ||
|
|
||
| Retrieve the catalog resource to view its current status: | ||
|
|
||
| ```bash | ||
| kubectl get catalog <catalog-name> -n <namespace> -o yaml | ||
| ``` | ||
|
|
||
| Or use kubectl describe for a more readable output: | ||
|
|
||
| ```bash | ||
| kubectl describe catalog <catalog-name> -n <namespace> | ||
| ``` | ||
|
|
||
| ### Check the Status Conditions | ||
|
|
||
| Look at the `status.statusConditions` section in the catalog resource. Pay special attention to: | ||
|
|
||
| - **Ready**: The main indicator of catalog health | ||
| - **SourceSynced**: Indicates whether the catalog source was successfully synchronized | ||
|
|
||
| ### Check Controller Logs | ||
|
|
||
| Review the Greenhouse controller logs for more detailed error messages: | ||
|
|
||
| ```bash | ||
| kubectl logs -n greenhouse -l app=greenhouse | ||
| --tail=100 | grep -i catalog # requires permissions on the greenhouse namespace | ||
|
Copilot marked this conversation as resolved.
Outdated
|
||
| ``` | ||
|
|
||
| Or access your logs sink for Greenhouse logs. | ||
|
|
||
| ### List All Catalogs | ||
|
|
||
| Check if multiple catalogs are affected: | ||
|
|
||
| ```bash | ||
| kubectl get catalog -A | ||
| ``` | ||
|
|
||
| ## Additional Resources | ||
|
|
||
| - [Greenhouse Catalog Documentation](../../../../reference/components/catalog) | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.