diff --git a/docs/helm/README.md b/docs/helm/README.md index f862e89fb..d2f403a5e 100644 --- a/docs/helm/README.md +++ b/docs/helm/README.md @@ -35,7 +35,7 @@ database via [Bitnami charts][bitnami-repo] and an ActiveMQ message broker with a simple [activemq subchart][activemq-readme], both with basic authentication and without any kind of redundancy. -[activemq-readme]: ../../helm/alfresco-content-services/charts/activemq/README.md +[activemq-readme]: https://github.com/Alfresco/alfresco-helm-charts/blob/main/charts/activemq/README.md [bitnami-repo]: https://github.com/bitnami/charts You typically want to disable the embedded postgres and activemq broker and @@ -69,8 +69,7 @@ the installation. ## Deploy -For the best results we recommend [deploying ACS to AWS -EKS](./eks-deployment.md). If you have a machine with at least 16GB of memory +For the best results we recommend [deploying ACS to AWS EKS](./eks-deployment.md). If you have a machine with at least 16GB of memory you can [deploy using Docker Desktop](./desktop-deployment.md) (or similar apps like Rancher and Podman Desktop) or via [KinD](kind-deployment.md) which just requires a working Docker install on any OS. @@ -80,7 +79,7 @@ at least 3 nodes with 12 cpu cores and 32 GB of memory in total. You can install requirements by fine tuning the [resource requests](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-units-in-kubernetes) available in the [values](https://github.com/Alfresco/acs-deployment/blob/master/helm/alfresco-content-services/values.yaml) for each component. -There are also several [examples](./examples) showing how to deploy with various configurations: +There are also several [examples](../helm-examples.md) showing how to deploy with various configurations: * [Deploy with AWS Services (S3, RDS and MQ)](./examples/with-aws-services.md) * [Deploy with Intelligence Services](./examples/with-ai.md) diff --git a/docs/helm/desktop-deployment.md b/docs/helm/desktop-deployment.md index f3d9da0a6..52a3c980a 100644 --- a/docs/helm/desktop-deployment.md +++ b/docs/helm/desktop-deployment.md @@ -34,7 +34,7 @@ Then proceed to the [deployment](#deployment) section to install ingress-nginx. ### Docker Desktop specific configuration On top of the Docker desktop -[Prerequisites](./desktop-deployment.md#Prerequisites), it is essential to +[Prerequisites](./desktop-deployment.md#prerequisites), it is essential to install the latest version of [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl) & [Helm](https://helm.sh/docs/intro/install). @@ -205,7 +205,7 @@ If you deployed Enterprise you'll also have access to: In the event of a deployment failure, it is important to recognize that resource constraints are a common underlying cause. For further insights and guidance. Additionally, you can find more comprehensive troubleshooting advice -in the [Helm Troubleshooting section](./README.md#Troubleshooting) +in the [Helm Troubleshooting section](./README.md#troubleshooting) ### Lack Of Resources @@ -242,5 +242,5 @@ an increased timeout, eg. --timeout 15m0s. Alteratively run without following: ``` and then monitor the logs for any failing pods. Please also consult the -[Helm Troubleshooting section](./README.md#Troubleshooting) for deploying Kubernetes +[Helm Troubleshooting section](./README.md#troubleshooting) for deploying Kubernetes Dashboard and more generic troubleshooting tips and tricks. diff --git a/docs/helm/eks-deployment.md b/docs/helm/eks-deployment.md index 0c566463c..89f9bbf0b 100644 --- a/docs/helm/eks-deployment.md +++ b/docs/helm/eks-deployment.md @@ -60,7 +60,7 @@ Set the cluster name in an environment variable that can be reused later: EKS_CLUSTER_NAME=my-alfresco-eks ``` -Create the cluster using the latest supported version - check the main [README](../../README.md). +Create the cluster using the latest supported version - check the main [README](README.md). Most common choices for instance types are `m5.xlarge` and `t3.xlarge`: ```sh @@ -144,7 +144,7 @@ you can alternatively: ``` 4. Go to the [Security Groups section of the VPC - Console](https://console.aws.amazon.com/vpc/home#SecurityGroups) and search + Console](https://console.aws.amazon.com/vpc/home) and search for the VPC using the ID retrieved in step 2, as shown in the screenshot below: diff --git a/docs/helm/examples/search-services.md b/docs/helm/examples/search-services.md index 65d925ac7..66b9e76bc 100644 --- a/docs/helm/examples/search-services.md +++ b/docs/helm/examples/search-services.md @@ -79,7 +79,7 @@ api, so it doesn't make much sense to use external access. ### Install ACS Helm Chart With Search External Access Follow the [EKS deployment](../eks-deployment.md) guide up until the -[ACS](../eks-deployment.md#acs) section, once the docker registry secret is +[ACS](../eks-deployment.md#development-version-of-charts) section, once the docker registry secret is installed come back here. Deploy the latest version of ACS Enterprise by running the command below diff --git a/docs/helm/examples/with-aws-services.md b/docs/helm/examples/with-aws-services.md index fa7ced251..e2b51451a 100644 --- a/docs/helm/examples/with-aws-services.md +++ b/docs/helm/examples/with-aws-services.md @@ -27,7 +27,7 @@ The diagram below shows the deployment produced by this example: ## Prerequisites Follow the [EKS deployment](../eks-deployment.md) guide up until the -[ACS](../eks-deployment.md#acs) section, once the docker registry secret is +[ACS](../eks-deployment.md#development-version-of-charts) section, once the docker registry secret is installed return to this page. :information_source: In the EKS installation documentation mentioned above, the diff --git a/docs/helm/upgrades.md b/docs/helm/upgrades.md index 2e804a6dc..47e0c8b8f 100644 --- a/docs/helm/upgrades.md +++ b/docs/helm/upgrades.md @@ -403,7 +403,7 @@ according to the standard [kubernetes resources management](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-units-in-kubernetes). For example, in the [alfresco-content-services values -file](../../helm/alfresco-content-services/values.yaml) you can find: +file](https://github.com/Alfresco/acs-deployment/blob/master/helm/alfresco-content-services/values.yaml) you can find: ```yaml repository: