ENDOC-498 general update #529
Conversation
| In order to prevent such errors, the user is alerted and required to manually decouple the bundle | ||
| components before beign able to completely remove the bundle from the system. | ||
| A bundle cannot be uninstalled if any of its components are in use elsewhere. To uninstall the bundle, the user must manually remove all references to it and all its components. | ||
| Once the references are removed or deleted, the original content where it was removed from must be republished for the decoupling process to complete. |
There was a problem hiding this comment.
@nshaw: not sure if this is the best way to put it. If there is a better explanation, please advise.
There was a problem hiding this comment.
@jyunmitch I think you can remove the sentence at line 65 or replace it with ", and in some case republish the component (e.g. page or widget) that held those references."
|
|
||
| ### Overview | ||
| Currently the Entando Component Manager logs are available in Kubernetes via Openshift dashboards or CLI tools like k9s or kubectl. |
There was a problem hiding this comment.
"Currently, the Entando Component Manager logs are available in Kubernetes via Openshift dashboards or CLI tools like K9s and kubectl." -> add comma and bolded changes
|
|
||
| Using `kubectl` and assuming for simplicity that you have only one Entando App named `quickstart` and your Entando cluster is only composed of one namespace, also named `quickstart`, | ||
| you can get the component-manager logs using the command | ||
| If your Entando cluster has more than one Entando App custom resource, find the component manager in question using the Entando App name and namespace where the app has been deployed. Assuming you have only one Entando App named `quickstart` and your cluster has one namespace called `YOUR-NAMESPACE`, |
There was a problem hiding this comment.
omit "in question"
"and the namespace" -> add "the"
can you have multiple apps/namespaces with the same name? i can see apps of the same name in different projects/instances but not namespaces of the same name within a given cluster. @nshaw?
"...you have only one..." -> "...you have a single..." (adds some clarity)
"...cluster has a namespace..." -> replace "one" with "a"
There was a problem hiding this comment.
I kept the meaning the same as it was since I didn't have time to investigate. No answers for any of these issues. I cleaned it up a bit.
the second 'the'>> don't think it's necessary >> the entando app name and namespace
| ``` | ||
| **Note**: the `-f` flag is optional and could be used to follow the logs for debugging purposes | ||
| Note the `-f` flag is optional and is used to follow the logs for debugging purposes. |
There was a problem hiding this comment.
"is used to follow" -> follows
There was a problem hiding this comment.
took out 'is' but I think it's strange to say 'the -f flag follows the logs for ..."
|
|
||
| ### Overview | ||
| Sometimes a bundle could have some issues: typos in the `descriptor.yaml` file, wrong references of components or to not available docker images are just a few of the possible errors. | ||
| Sometimes a bundle could have issues: typos in the descriptor.yaml, faulty references for components, or unavailable Docker images are just some of the possibilities. After making the corrections, your bundle will need to be updated. |
There was a problem hiding this comment.
colon should be a semicolon
There was a problem hiding this comment.
it was meant to be list, edited
| 1. If the bundle is shared using a git repository, you can make the required changes to your project and publish the new version to git and generate a new tag for it. | ||
| 2. Once the new tag is published, update the bundle costum-resource avaialble in you Entando Cluster by adding the new tag to the `tags` objects and replacing the latest `dist-tags` to point to this new version. | ||
| 3. Proceed with the new installation | ||
| 1. If the bundle is shared in a git repository, you can make the required changes to your project, publish the new version to git, and generate a new tag for it. |
There was a problem hiding this comment.
Git - capitalize all instances
| The _entando-cms_ project is the _app-builder_ (React JS) side of the Entando WCMS. It is bundled into the | ||
| _app-builder_ at build time and will be included in the default deployment of the _app-builder_ in almost all cases. | ||
| The **entando-cms** project is the App Builder (React JS) side of the Entando WCMS. It is bundled into the | ||
| App Builder at build time and will be included in the default deployment of the App Builder in almost all cases. |
There was a problem hiding this comment.
will be included -> is included
| * GitHub: <https://github.com/entando/entando-components/> | ||
| * DockerHub: None (deployed to maven central) | ||
| In some cases the **entando-cms** may be customized if new custom features are added to CMS specific | ||
| functionality. However, most cases will use the more general App Builder extension points noted above. The **entando-cms** does not expose any dedicated extension interfaces outside of those already provided by the App Builder. |
There was a problem hiding this comment.
cases,
new custom features -> new features
CMS-specific
general -> generic
most cases -> most implementations
There was a problem hiding this comment.
corrected 2 items.
again, it made sense so didn't do a deep dive.
Think 'more general' is better than generic.
| components in an Entando Cluster. Those controllers are small and lightweight images that are executed as | ||
| run to completion pods to manage the installation flow for different parts of the infrastructure. The | ||
| There are a number of controllers that are available to the Entando Operator to manage installations and | ||
| components in an Entando Cluster. These are small and lightweight images that execute as |
| run to completion pods to manage the installation flow for different parts of the infrastructure. The | ||
| There are a number of controllers that are available to the Entando Operator to manage installations and | ||
| components in an Entando Cluster. These are small and lightweight images that execute as | ||
| run to completion pods, managing the installation flow for different parts of the infrastructure. The |
| run to completion pods to manage the installation flow for different parts of the infrastructure. The | ||
| There are a number of controllers that are available to the Entando Operator to manage installations and | ||
| components in an Entando Cluster. These are small and lightweight images that execute as | ||
| run to completion pods, managing the installation flow for different parts of the infrastructure. The | ||
| controllers are implemented using Quarkus. For more information on the controllers, the Entando custom | ||
| resources, and configuring your Entando deployment see also: |
will fix links and add to next in next rounds.
@nshaw, two specific tech notes for you