From a395a49c1cdaa5377123eafadf15f45e6a659360 Mon Sep 17 00:00:00 2001 From: Nathan Shaw Date: Wed, 31 Aug 2022 16:57:16 -0400 Subject: [PATCH 1/3] ENDOC-557 Update Azure install guide --- .../next/tutorials/getting-started/azure-install.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/vuepress/docs/next/tutorials/getting-started/azure-install.md b/vuepress/docs/next/tutorials/getting-started/azure-install.md index b8bc6b1683..5c2f7c3e1a 100644 --- a/vuepress/docs/next/tutorials/getting-started/azure-install.md +++ b/vuepress/docs/next/tutorials/getting-started/azure-install.md @@ -38,7 +38,7 @@ If you're using an Azure free account, you may need to upgrade your account to e 7. Pick your `Region` if it wasn't automatically selected for you. 8. In the `Availability zones` dropdown, pick __one and only one__ availability zone - Generally, you could pick more than one but it will result in a failure in a quickstart environment. If you chose more than one availability zone you will have to provision storage, manage node affinity, and provide the correct network configuration to ensure your application deploys. We recommend only doing this for production clusters. -9. Select an [Entando-compatible Kubernetes version](https://www.entando.com/page/en/compatibility-guide), e.g. 1.21.x +9. Select an [Entando-compatible Kubernetes version](https://www.entando.com/page/en/compatibility-guide), e.g. 1.23.x 10. Keep the default `Node size`, e.g. Standard DS2 v2 11. Keep the `Scale Method` set to `Autoscale` and the `Node count range` set from `1` to `5` 12. (Optional) If you're familiar with AKS, you can change settings under other tabs (e.g. `Node Pools`, `Access`) as desired but the defaults should work. Entando uses base Kubernetes APIs, so as long as you follow the Entando configuration instructions below, you can tune your cluster infrastructure to meet your goals. @@ -56,7 +56,7 @@ Note: A different storage class can be configured for [Clustered Storage](./gke- - The following instructions assume you will use the Azure Cloud Shell but you can also run the commands in a local environment via `kubectl` 5. Deploy the NGINX controller to enable access to the cluster ``` sh -kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v1.1.3/deploy/static/provider/aws/deploy.yaml +kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v1.3.0/deploy/static/provider/cloud/deploy.yaml ``` 6. Get the external IP address for your ingress controller ``` sh @@ -78,7 +78,7 @@ See the [Install Guide for NGINX on Azure](https://kubernetes.github.io/ingress- 1. Apply the cluster-scoped custom resource definitions (CRDs). This is required only once per cluster. ```sh -kubectl apply -f https://raw.githubusercontent.com/entando/entando-releases/v7.0.1/dist/ge-1-1-6/namespace-scoped-deployment/cluster-resources.yaml +kubectl apply -f https://raw.githubusercontent.com/entando/entando-releases/v7.1.0/dist/ge-1-1-6/namespace-scoped-deployment/cluster-resources.yaml ``` 2. Create the namespace for the Entando Application @@ -87,7 +87,7 @@ kubectl create namespace entando ``` 3. Download the `entando-operator-config` template so you can configure the [Entando Operator](../devops/entando-operator.md) ```sh -curl -sLO "https://raw.githubusercontent.com/entando/entando-releases/v7.0.1/dist/ge-1-1-6/samples/entando-operator-config.yaml" +curl -sLO "https://raw.githubusercontent.com/entando/entando-releases/v7.1.0/dist/ge-1-1-6/samples/entando-operator-config.yaml" ``` 4. Edit the `entando-operator-config.yaml` to add two properties ```yaml @@ -103,7 +103,7 @@ kubectl apply -f entando-operator-config.yaml -n entando 6. Apply the namespace-scoped custom resources ```sh -kubectl apply -n entando -f https://raw.githubusercontent.com/entando/entando-releases/v7.0.1/dist/ge-1-1-6/namespace-scoped-deployment/namespace-resources.yaml +kubectl apply -n entando -f https://raw.githubusercontent.com/entando/entando-releases/v7.1.0/dist/ge-1-1-6/namespace-scoped-deployment/namespace-resources.yaml ``` 7. You can use `kubectl get pods -n entando --watch` to see the initial pods start up. Use `Ctrl+C` to exit. ``` @@ -116,7 +116,7 @@ entando-operator-5b5465788b-ghb25 1/1 Running 0 5m53s ### Configure the Entando Application 1. Download the `entando-app.yaml` template ```sh -curl -sLO "https://raw.githubusercontent.com/entando/entando-releases/v7.0.1/dist/ge-1-1-6/samples/entando-app.yaml" +curl -sLO "https://raw.githubusercontent.com/entando/entando-releases/v7.1.0/dist/ge-1-1-6/samples/entando-app.yaml" ``` 2. Edit `entando-app.yaml`. Replace `YOUR-HOST-NAME` with `EXTERNAL-IP` + `.nip.io`. See [the EntandoApp custom resource overview](../../docs/consume/entandoapp-cr.md) for additional options. From 2e1da0d66415caf412d6d54a7192a742d25b182d Mon Sep 17 00:00:00 2001 From: Nathan Shaw Date: Wed, 31 Aug 2022 17:52:44 -0400 Subject: [PATCH 2/3] ENDOC-557 Add EntandoCode component so we can manage the fixpack version per release in one place. --- .../docs/.vuepress/components/EntandoCode.vue | 8 +++++++ vuepress/docs/.vuepress/config.js | 5 +++- .../getting-started/azure-install.md | 24 +++++++++---------- 3 files changed, 24 insertions(+), 13 deletions(-) create mode 100644 vuepress/docs/.vuepress/components/EntandoCode.vue diff --git a/vuepress/docs/.vuepress/components/EntandoCode.vue b/vuepress/docs/.vuepress/components/EntandoCode.vue new file mode 100644 index 0000000000..39362f8e9d --- /dev/null +++ b/vuepress/docs/.vuepress/components/EntandoCode.vue @@ -0,0 +1,8 @@ + + + \ No newline at end of file diff --git a/vuepress/docs/.vuepress/config.js b/vuepress/docs/.vuepress/config.js index 38560c20c3..92eedff94a 100644 --- a/vuepress/docs/.vuepress/config.js +++ b/vuepress/docs/.vuepress/config.js @@ -134,11 +134,14 @@ module.exports = { }, // Custom theme config entando: { + fixpack: { + "v71": "v7.1.0" + }, logoLink: "https://entando.com", section: "Docs", version: "7.0", docs: navLinks.links('Docs', '/docs/'), - tutorials: navLinks.links('Tutorials', '/tutorials/') + tutorials: navLinks.links('Tutorials', '/tutorials/'), }, } } diff --git a/vuepress/docs/next/tutorials/getting-started/azure-install.md b/vuepress/docs/next/tutorials/getting-started/azure-install.md index 5c2f7c3e1a..a61b2afc79 100644 --- a/vuepress/docs/next/tutorials/getting-started/azure-install.md +++ b/vuepress/docs/next/tutorials/getting-started/azure-install.md @@ -77,18 +77,18 @@ See the [Install Guide for NGINX on Azure](https://kubernetes.github.io/ingress- ### Install the Entando Custom Resources 1. Apply the cluster-scoped custom resource definitions (CRDs). This is required only once per cluster. -```sh -kubectl apply -f https://raw.githubusercontent.com/entando/entando-releases/v7.1.0/dist/ge-1-1-6/namespace-scoped-deployment/cluster-resources.yaml -``` +kubectl apply -f https://raw.githubusercontent.com/entando/entando-releases/{{ $site.themeConfig.entando.fixpack.v71 }}/dist/ge-1-1-6/namespace-scoped-deployment/cluster-resources.yaml + + 2. Create the namespace for the Entando Application ```sh kubectl create namespace entando ``` 3. Download the `entando-operator-config` template so you can configure the [Entando Operator](../devops/entando-operator.md) -```sh -curl -sLO "https://raw.githubusercontent.com/entando/entando-releases/v7.1.0/dist/ge-1-1-6/samples/entando-operator-config.yaml" -``` + +curl -sLO "https://raw.githubusercontent.com/entando/entando-releases/{{ $site.themeConfig.entando.fixpack.v71 }}/dist/ge-1-1-6/samples/entando-operator-config.yaml" + 4. Edit the `entando-operator-config.yaml` to add two properties ```yaml data: @@ -102,9 +102,10 @@ kubectl apply -f entando-operator-config.yaml -n entando ``` 6. Apply the namespace-scoped custom resources -```sh -kubectl apply -n entando -f https://raw.githubusercontent.com/entando/entando-releases/v7.1.0/dist/ge-1-1-6/namespace-scoped-deployment/namespace-resources.yaml -``` + +kubectl apply -n entando -f https://raw.githubusercontent.com/entando/entando-releases/{{ $site.themeConfig.entando.fixpack.v71 }}/dist/ge-1-1-6/namespace-scoped-deployment/namespace-resources.yaml + + 7. You can use `kubectl get pods -n entando --watch` to see the initial pods start up. Use `Ctrl+C` to exit. ``` $ kubectl get pods -n entando @@ -115,9 +116,8 @@ entando-operator-5b5465788b-ghb25 1/1 Running 0 5m53s ### Configure the Entando Application 1. Download the `entando-app.yaml` template -```sh -curl -sLO "https://raw.githubusercontent.com/entando/entando-releases/v7.1.0/dist/ge-1-1-6/samples/entando-app.yaml" -``` + +curl -sLO "https://raw.githubusercontent.com/entando/entando-releases/{{ $site.themeConfig.entando.fixpack.v71 }}/dist/ge-1-1-6/samples/entando-app.yaml" 2. Edit `entando-app.yaml`. Replace `YOUR-HOST-NAME` with `EXTERNAL-IP` + `.nip.io`. See [the EntandoApp custom resource overview](../../docs/consume/entandoapp-cr.md) for additional options. ```yaml From cf61f5e15b7901c9dd6c9cc50b144eabb1954b3b Mon Sep 17 00:00:00 2001 From: Nathan Shaw Date: Wed, 31 Aug 2022 21:06:43 -0400 Subject: [PATCH 3/3] ENDOC-557 Apply EntandoCode component to local, Amazon, and Google install guides. --- .../docs/next/docs/getting-started/README.md | 16 +++++-------- .../tutorials/getting-started/eks-install.md | 23 +++++++++--------- .../tutorials/getting-started/gke-install.md | 24 +++++++++---------- 3 files changed, 29 insertions(+), 34 deletions(-) diff --git a/vuepress/docs/next/docs/getting-started/README.md b/vuepress/docs/next/docs/getting-started/README.md index b8154e8efb..a7ad520ec7 100644 --- a/vuepress/docs/next/docs/getting-started/README.md +++ b/vuepress/docs/next/docs/getting-started/README.md @@ -7,7 +7,7 @@ sidebarDepth: 2 ::: warning -If you have a MacBook with an M1 chip, please see our alternative [install guides](../../tutorials/#operations). Entando 7 is not currently compatible with an ARM64-based architecture. +If you have a MacBook with an M1 or M2 chip, please see our alternative [install guides](../../tutorials/#operations). Entando 7 is not currently compatible with an ARM64-based architecture. ::: You can set up Entando in two simple steps or install it manually to meet your specific needs. @@ -164,15 +164,13 @@ From your Ubuntu shell 1. Install the cluster-scoped custom resource definitions (CRDs) -``` shell -sudo kubectl apply -f https://raw.githubusercontent.com/entando/entando-releases/v7.1.0/dist/ge-1-1-6/namespace-scoped-deployment/cluster-resources.yaml -``` +kubectl apply -f https://raw.githubusercontent.com/entando/entando-releases/{{ $site.themeConfig.entando.fixpack.v71 }}/dist/ge-1-1-6/namespace-scoped-deployment/cluster-resources.yaml + 2. Install the namespace-scoped custom resources -``` shell -sudo kubectl apply -n entando -f https://raw.githubusercontent.com/entando/entando-releases/v7.1.0/dist/ge-1-1-6/namespace-scoped-deployment/namespace-resources.yaml -``` +kubectl apply -n entando -f https://raw.githubusercontent.com/entando/entando-releases/{{ $site.themeConfig.entando.fixpack.v71 }}/dist/ge-1-1-6/namespace-scoped-deployment/namespace-resources.yaml + #### Configure Access to Your Cluster ::: tip What about Networking? @@ -195,9 +193,7 @@ Now that you've determined YOUR-HOST-NAME, use it to configure the Entando Appli 1. Download the template `entando-app.yaml`. -``` -curl -sLO "https://raw.githubusercontent.com/entando/entando-releases/v7.1.0/dist/ge-1-1-6/samples/entando-app.yaml" -``` +curl -sLO "https://raw.githubusercontent.com/entando/entando-releases/{{ $site.themeConfig.entando.fixpack.v71 }}/dist/ge-1-1-6/samples/entando-app.yaml" 2. Modify `entando-app.yaml` to set the `ingressHostName` to YOUR-HOST-NAME. Examples: - `ingressHostName`: quickstart.mshome.net diff --git a/vuepress/docs/next/tutorials/getting-started/eks-install.md b/vuepress/docs/next/tutorials/getting-started/eks-install.md index c6df95f74f..b01258c548 100644 --- a/vuepress/docs/next/tutorials/getting-started/eks-install.md +++ b/vuepress/docs/next/tutorials/getting-started/eks-install.md @@ -137,18 +137,18 @@ See the [NGINX AWS Guide](https://kubernetes.github.io/ingress-nginx/deploy/#aws ### Install the Entando Custom Resources 1. Apply the cluster-scoped custom resource definitions (CRDs). This is required only once per cluster. -```sh -kubectl apply -f https://raw.githubusercontent.com/entando/entando-releases/v7.1.0/dist/ge-1-1-6/namespace-scoped-deployment/cluster-resources.yaml -``` + +kubectl apply -f https://raw.githubusercontent.com/entando/entando-releases/{{ $site.themeConfig.entando.fixpack.v71 }}/dist/ge-1-1-6/namespace-scoped-deployment/cluster-resources.yaml + 2. Create the namespace for the Entando Application ```sh kubectl create namespace entando ``` 3. Download the `entando-operator-config` template so you can configure the [Entando Operator](../devops/entando-operator.md). -```sh -curl -sLO "https://raw.githubusercontent.com/entando/entando-releases/v7.1.0/dist/ge-1-1-6/samples/entando-operator-config.yaml" -``` + +curl -sLO "https://raw.githubusercontent.com/entando/entando-releases/{{ $site.themeConfig.entando.fixpack.v71 }}/dist/ge-1-1-6/samples/entando-operator-config.yaml" + 4. Edit the `entando-operator-config.yaml` to set `data/entando.requires.filesystem.group.override: "true"` ```yaml data: @@ -162,9 +162,9 @@ kubectl apply -f entando-operator-config.yaml -n entando ``` 6. Apply the namespace-scoped custom resources -```sh -kubectl apply -n entando -f https://raw.githubusercontent.com/entando/entando-releases/v7.1.0/dist/ge-1-1-6/namespace-scoped-deployment/namespace-resources.yaml -``` + +kubectl apply -n entando -f https://raw.githubusercontent.com/entando/entando-releases/{{ $site.themeConfig.entando.fixpack.v71 }}/dist/ge-1-1-6/namespace-scoped-deployment/namespace-resources.yaml + 7. You can use `kubectl get pods -n entando --watch` to see the initial pods start up. Use `Ctrl+C` to exit. ``` $ kubectl get pods -n entando @@ -175,9 +175,8 @@ entando-operator-5b5465788b-ghb25 1/1 Running 0 5m53s ### Configure the Entando Application 1. Download the `entando-app.yaml` template -```sh -curl -sLO "https://raw.githubusercontent.com/entando/entando-releases/v7.1.0/dist/ge-1-1-6/samples/entando-app.yaml" -``` + +curl -sLO "https://raw.githubusercontent.com/entando/entando-releases/{{ $site.themeConfig.entando.fixpack.v71 }}/dist/ge-1-1-6/samples/entando-app.yaml" 2. Edit `entando-app.yaml` and replace YOUR-HOST-NAME with the NGINX address from above. See the [Custom Resources overview](../../docs/consume/entandoapp-cr.md) for details on other `EntandoApp` options. ```yaml diff --git a/vuepress/docs/next/tutorials/getting-started/gke-install.md b/vuepress/docs/next/tutorials/getting-started/gke-install.md index edded29e94..f46d31097a 100644 --- a/vuepress/docs/next/tutorials/getting-started/gke-install.md +++ b/vuepress/docs/next/tutorials/getting-started/gke-install.md @@ -69,17 +69,18 @@ NGINX is working correctly if a `404 Not Found` NGINX error page is generated wh ### Install the Entando Custom Resources 1. Download and apply the custom resource definitions (CRDs) to the cluster. This must be done once per cluster. -```sh -kubectl apply -f https://raw.githubusercontent.com/entando/entando-releases/v7.1.0/dist/ge-1-1-6/namespace-scoped-deployment/cluster-resources.yaml -``` + +kubectl apply -f https://raw.githubusercontent.com/entando/entando-releases/{{ $site.themeConfig.entando.fixpack.v71 }}/dist/ge-1-1-6/namespace-scoped-deployment/cluster-resources.yaml + + 2. Create a namespace for the Entando Application. If you choose a name other than "entando," update the following commands wherever a namespace is provided. ```sh kubectl create namespace entando ``` 3. Download the `entando-operator-config` template to configure the [Entando Operator](../devops/entando-operator.md) -```sh -curl -sLO "https://raw.githubusercontent.com/entando/entando-releases/v7.1.0/dist/ge-1-1-6/samples/entando-operator-config.yaml" -``` + +curl -sLO "https://raw.githubusercontent.com/entando/entando-releases/{{ $site.themeConfig.entando.fixpack.v71 }}/dist/ge-1-1-6/samples/entando-operator-config.yaml" + 4. Edit the `entando-operator-config.yaml` to add two properties ```yaml data: @@ -91,9 +92,9 @@ data: kubectl apply -f entando-operator-config.yaml -n entando ```` 6. Install the namespace-scoped resources -```sh -kubectl apply -n entando -f https://raw.githubusercontent.com/entando/entando-releases/v7.1.0/dist/ge-1-1-6/namespace-scoped-deployment/namespace-resources.yaml -``` + +kubectl apply -n entando -f https://raw.githubusercontent.com/entando/entando-releases/{{ $site.themeConfig.entando.fixpack.v71 }}/dist/ge-1-1-6/namespace-scoped-deployment/namespace-resources.yaml + 7. Use `kubectl get pods -n entando --watch` to observe the base pods initialize. Exit this command via `Ctrl+C`. ```sh $ kubectl get pods -n entando @@ -104,9 +105,8 @@ entando-operator-5b5465788b-ghb25 1/1 Running 0 95s ### Configure the Entando Application 1. Download the `entando-app.yaml` template -```sh -curl -sLO "https://raw.githubusercontent.com/entando/entando-releases/v7.1.0/dist/ge-1-1-6/samples/entando-app.yaml" -``` + +curl -sLO "https://raw.githubusercontent.com/entando/entando-releases/{{ $site.themeConfig.entando.fixpack.v71 }}/dist/ge-1-1-6/samples/entando-app.yaml" 2. Edit `entando-app.yaml`. Replace `YOUR-HOST-NAME` with `EXTERNAL-IP` + `.nip.io`. See [the EntandoApp custom resource overview](../../docs/consume/entandoapp-cr.md) for additional options. ```yaml