clarify statusInformers field for sdk #3448
Conversation
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
replicated-ci
added
type::docs
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| # list all resources that you want the SDK to report on | ||
| statusInformers: | ||
| - deployment/nginx | ||
| - statefulset/mysql |
There was a problem hiding this comment.
^ would it be helpful to include an example of a resource that's created by a subchart? I wasn't sure how that might look
| :::note | ||
| When `statusInformers` is set, the SDK reports the status of only the resources included in the `statusInformers` field. | ||
| ::: |
There was a problem hiding this comment.
^ add note to make sure they know only the listed resources get reported on
| - statefulset/mysql | ||
| ``` | ||
| * You want the SDK to report on resources outside the Helm release for the chart where it is included as a dependency. For example, your application is installed as multiple charts and you want status data for resources created by subcharts. | ||
| * Your application is installed by running `helm template` then `kubectl apply`, rather than `helm install` or `helm upgrade`. In this case, the SDK is unable to automatically detect resources in the Helm release. |
There was a problem hiding this comment.
^ listed out the use cases for customizing statusInformers
| ### Replicated Installers | ||
|
|
||
| To get instance insights from installations with a Replicated installer (Embedded Cluster, existing cluster KOTS, kURL), configure one or more status informers in the KOTS Application custom resource. For more information, see [Adding Resource Status Informers](admin-console-display-app-status). | ||
|
|
There was a problem hiding this comment.
^ note: unrelated, but I also updated this section to use the term "replicated installers" instead of "kots". Previously, it was assuming that people knew that Embedded Cluster is powered by KOTS
chris-sanders
left a comment
chris-sanders
left a comment
There was a problem hiding this comment.
Yup this addresses the confusion I saw today!
https://deploy-preview-3448--replicated-docs-upgrade.netlify.app/vendor/insights-app-status#helm-cli-installations