ENDOC-438 Refine the config profiles, add doc on the config map, exte… #462
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
…nd the CLI reference a bit
Lyd1aCla1r3
reviewed
Mar 28, 2022
| ent prj get-bundle-id --auto | ||
| ``` | ||
|
|
||
| If you have a microservice plugin in your project, an unique identifier will be calculated for it as well. |
There was a problem hiding this comment.
"a unique" (i looked it up to doublecheck :P)
| @@ -64,24 +76,23 @@ data: | |||
| ``` | |||
|
|
|||
| ### Method 3: Default Profile | |||
| 1. Create the parameter profile in the `OperatorConfigMap` in the data profile file at `data/entando.profile.[your-profile]`. | |||
| 1. Create the parameter profile in the `OperatorConfigMap` in the data profile file at `data/entando.profile.[your-profile]`. | |||
There was a problem hiding this comment.
can omit "file" (reads awkwardly and no "file" follows "profile" above)
| ``` | ||
|
|
||
| 2. Add a reference to the profile at data/entando.plugins.defaultProfile: | ||
| 2. Add a reference to the profile at data/entando.plugins.defaultProfile: |
There was a problem hiding this comment.
backticks on path (used above)
| See [this tutorial](../../tutorials/create/ms/run-local.md) for more details. | ||
|
|
||
| ### Get the Bundle ID and Plugin ID | ||
| Entando will use a unique identifier for your bundle as a way to provide additional security controls around bundle-specific resources. You can determine this identifier with this command |
There was a problem hiding this comment.
will use -> uses (present tense convention)
|
|
||
| ## Prerequisites | ||
| The Entando Operator makes use of an optional ```ConfigMap``` named ```entando-operator-config```. It must be present in the same namespace. In a quickstart environment you can check for its presence with this command: | ||
| ```sh |
There was a problem hiding this comment.
i think there should be a comma after "environment"... @jyunmitch?
| kubectl apply -f entando-operator-config.yaml -n entando | ||
| ``` | ||
|
|
||
| The Entando Operator will automatically reload the settings from the new ```ConfigMap```. You can verify the reload by checking the logs in the operator pod. |
There was a problem hiding this comment.
"automatically reloads" (present tense)
| kubectl edit configmap/entando-operator-config -n entando | ||
| ``` | ||
|
|
||
| The Entando Operator will automatically reload the settings from the ```ConfigMap```. You can verify the reload by checking the logs in the operator pod. Some settings may only take effect when a deployment is first created, for example, timeout settings or cpu limits. |
There was a problem hiding this comment.
automatically reloads
"...created, for example, timeout..." -> "...created, e.g. timeout..." (to avoid use of the comma to introduce the example verbiage)
|
|
||
| ### Retrieve the Plugin ID | ||
| First you will need to retrieve the Plugin ID which is calculated during installation and written to the EntandoPlugin Custom Resource as part of the deployment of the plugin micro-service. Use the following command: | ||
| First you will need to [retrieve the Plugin ID](../../docs/reference/entando-cli.md) which is calculated during installation and written to the EntandoPlugin Custom Resource as part of the deployment of the plugin microservice. Use the following command from the project directory |
There was a problem hiding this comment.
comma after "First"
you will need -> you need
comma after "Plugin ID"
jyunmitch
approved these changes
Mar 28, 2022
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.
…nd the CLI reference a bit