Documentation for ResourceGroup as inventory object (alpha) #1357
Conversation
seans3
force-pushed
the
alpha-rg-docs
branch
3 times, most recently
from
fcb8e04 to
d4e7595
Compare
|
|
||
| ```sh | ||
| export RESOURCE_GROUP_INVENTORY=1 | ||
| kpt live install-resource-group |
There was a problem hiding this comment.
We discussed that in a normal flow, kpt live init automatically attempts to install the CRD, and failing that, this is the manual fallback, right? In the case, then you can just show the happy path and have this as an aside.
There was a problem hiding this comment.
OK. I removed this example to the kpt live install-resource-group. I added an explanation further down that the CRD is normally added as an initial step during kpt live apply. Please let me know what you think.
|
|
||
| [kpt live init](./init) | ||
|
|
||
| ### Troubleshooting and Verifying |
There was a problem hiding this comment.
Is there an error case when running kpt live apply that tells the user to fall back to manual install of CRD? (Related to comment above)
There was a problem hiding this comment.
OK, I used the kpt live apply instead of kpt live install-resource-group to illustrate the error. I added the command to manually install the CRD as the way to fix and verify the error. Please let me know what you think.
| Apply ResourceGroup custom resource definition to the cluster | ||
| --> | ||
|
|
||
| **NOTE**: This command is not available unless the `RESOURCE_GROUP_INVENTORY` |
There was a problem hiding this comment.
Worth repeating here and for migrate command that this is only relevant for the alpha feature. Actually use the name of the relevant feature to tie these pages together.
There was a problem hiding this comment.
I've updated this initial NOTE to include the following:
This is an alpha command for the new ResourceGroup as inventory object
functionality
Please let me know if this is what you are looking for.
| [**ConfigMap**](https://kubernetes.io/docs/concepts/configuration/configmap/) | ||
| file (usually **inventory-template.yaml**). | ||
|
|
||
| ### Examples |
There was a problem hiding this comment.
Thanks for the detailed docs and examples. They're clear and helpful.
seans3
force-pushed
the
alpha-rg-docs
branch
4 times, most recently
from
8cd098f to
b675ee1
Compare
kpt livecommand docs to upgrade to ResourceGroup as inventory (alpha). This adds a single line to the publicly accessible kpt documentation.kpt live migrateandkpt live install-resource-group. These commands are only accessible from minimally accessible ResourceGroup as inventory alpha instructions.kpt live initcommand docs for ResourceGroup as inventory object (only accessible from minimally accessible alpha instructions documents).