diff --git a/vuepress/docs/.vuepress/next.js b/vuepress/docs/.vuepress/next.js index 6eb55275fd..82478b0e6b 100644 --- a/vuepress/docs/.vuepress/next.js +++ b/vuepress/docs/.vuepress/next.js @@ -91,6 +91,10 @@ module.exports = { title: 'Entando Component Repository', path: path + 'compose/ecr-overview.md' }, + { + title: 'Entando Component Manager', + path: path + 'compose/ecm-overview.md' + }, ] }, { diff --git a/vuepress/docs/.vuepress/v632.js b/vuepress/docs/.vuepress/v632.js index 2346b4bcb0..20694cf6aa 100644 --- a/vuepress/docs/.vuepress/v632.js +++ b/vuepress/docs/.vuepress/v632.js @@ -87,6 +87,10 @@ module.exports = { title: 'Entando Component Repository', path: path + 'compose/ecr-overview.md' }, + { + title: 'Entando Component Manager', + path: path + 'compose/ecm-overview.md' + }, ] }, { diff --git a/vuepress/docs/next/docs/compose/ecm-overview.md b/vuepress/docs/next/docs/compose/ecm-overview.md new file mode 100644 index 0000000000..fcc2f85581 --- /dev/null +++ b/vuepress/docs/next/docs/compose/ecm-overview.md @@ -0,0 +1,31 @@ +--- +sidebarDepth: 2 +--- + +# Entando Component Manager + +​​An Entando Application is composed of the Entando App Builder, [Entando App Engine](../getting-started/concepts-overview.md#entando-app-engine), and Entando Component Manager. The Entando Component Manager (ECM) provides functionality to build and organize micro frontends and widgets from within the App Builder. It also manages the connections between an application and the installed plugins. + +The Component Manager is a service that links the [Entando Component Repository](ecr-overview.md) (ECR) of the App Builder to the core application instance. It appears as `quickstart-cm-deployment` in the Kubernetes pod list: + +![pods.png](./img/pods.png) + +The ECM communicates with the Kubernetes service to populate the ECR with the bundles available as [Custom Resources](../consume/custom-resources.md) in the Entando namespace. These bundles can be installed in the application and managed from within the ECR. + +![ecm-flow.png](./img/ecm-flow.png) + +In the flow pictured above: +1. A user visits the ECR page in the App Builder +2. The ECR makes a REST call to the `digital-exchange` endpoint +3. The Component Manager receives the `digital-exchange` request +4. The Component Manager calls the `k8s-service` to return the list of available `EntandoDeBundles` in the namespace + +A similar process occurs when bundles are installed or uninstalled. The [Entando Operator](../consume/operator-intro.md) performs actions based on lifecycle events for affected Entando Custom Resources. + +### Key Features: + +* Manages the installation and removal of project bundles + +* Makes components available in the App Builder through the Component Repository + +* Handles versioning of component bundles for sharing and collaborating diff --git a/vuepress/docs/next/docs/compose/img/ecm-flow.png b/vuepress/docs/next/docs/compose/img/ecm-flow.png new file mode 100644 index 0000000000..1ef2256833 Binary files /dev/null and b/vuepress/docs/next/docs/compose/img/ecm-flow.png differ diff --git a/vuepress/docs/next/docs/compose/img/pods.png b/vuepress/docs/next/docs/compose/img/pods.png new file mode 100644 index 0000000000..99dc2a1115 Binary files /dev/null and b/vuepress/docs/next/docs/compose/img/pods.png differ diff --git a/vuepress/docs/v6.3.2/docs/compose/ecm-overview.md b/vuepress/docs/v6.3.2/docs/compose/ecm-overview.md new file mode 100644 index 0000000000..fcc2f85581 --- /dev/null +++ b/vuepress/docs/v6.3.2/docs/compose/ecm-overview.md @@ -0,0 +1,31 @@ +--- +sidebarDepth: 2 +--- + +# Entando Component Manager + +​​An Entando Application is composed of the Entando App Builder, [Entando App Engine](../getting-started/concepts-overview.md#entando-app-engine), and Entando Component Manager. The Entando Component Manager (ECM) provides functionality to build and organize micro frontends and widgets from within the App Builder. It also manages the connections between an application and the installed plugins. + +The Component Manager is a service that links the [Entando Component Repository](ecr-overview.md) (ECR) of the App Builder to the core application instance. It appears as `quickstart-cm-deployment` in the Kubernetes pod list: + +![pods.png](./img/pods.png) + +The ECM communicates with the Kubernetes service to populate the ECR with the bundles available as [Custom Resources](../consume/custom-resources.md) in the Entando namespace. These bundles can be installed in the application and managed from within the ECR. + +![ecm-flow.png](./img/ecm-flow.png) + +In the flow pictured above: +1. A user visits the ECR page in the App Builder +2. The ECR makes a REST call to the `digital-exchange` endpoint +3. The Component Manager receives the `digital-exchange` request +4. The Component Manager calls the `k8s-service` to return the list of available `EntandoDeBundles` in the namespace + +A similar process occurs when bundles are installed or uninstalled. The [Entando Operator](../consume/operator-intro.md) performs actions based on lifecycle events for affected Entando Custom Resources. + +### Key Features: + +* Manages the installation and removal of project bundles + +* Makes components available in the App Builder through the Component Repository + +* Handles versioning of component bundles for sharing and collaborating diff --git a/vuepress/docs/v6.3.2/docs/compose/img/ecm-flow.png b/vuepress/docs/v6.3.2/docs/compose/img/ecm-flow.png new file mode 100644 index 0000000000..1ef2256833 Binary files /dev/null and b/vuepress/docs/v6.3.2/docs/compose/img/ecm-flow.png differ diff --git a/vuepress/docs/v6.3.2/docs/compose/img/pods.png b/vuepress/docs/v6.3.2/docs/compose/img/pods.png new file mode 100644 index 0000000000..99dc2a1115 Binary files /dev/null and b/vuepress/docs/v6.3.2/docs/compose/img/pods.png differ