diff --git a/docs/helm/README.md b/docs/helm/README.md index 827ca3ee2..f862e89fb 100644 --- a/docs/helm/README.md +++ b/docs/helm/README.md @@ -78,7 +78,7 @@ requires a working Docker install on any OS. The recommended cluster resources for the Enterprise version with the components enabled by default are: at least 3 nodes with 12 cpu cores and 32 GB of memory in total. You can install with lower requirements by fine tuning the [resource requests](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-units-in-kubernetes) -available in the [values](../../helm/alfresco-content-services/values.yaml) for each component. +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: @@ -87,10 +87,10 @@ There are also several [examples](./examples) showing how to deploy with various * [Deploy with Microsoft 365 Connector (Office Online Integration)](./examples/with-ooi.md) * [Deploy with external Keycloak SSO authentication](./examples/with-keycloak.md) * [Deploy with external infrastructure components](./examples/with-external-infrastructure.md) (e.g. elasticsearch, activemq, postgres) -* [Enable access to Search Services](./examples/search-services.mdi#enable-alfresco-search-services-external-access) -* [Enable Email Services](./examples/email-enabled.md) -* [Use a custom metadata keystore](./examples/custom-metadata-keystore.md) -* [Install ACS license as part of the deployment](./examples/alf_license.md) +* [Enable access to Search Services](./examples/search-services.md#enable-alfresco-search-services-external-access) +* [Enable Email Services](https://github.com/Alfresco/alfresco-helm-charts/blob/main/charts/alfresco-repository/docs/email.md) +* [Use a custom metadata keystore](https://github.com/Alfresco/alfresco-helm-charts/blob/main/charts/alfresco-repository/docs/keystores.md) +* [Install ACS license as part of the deployment](https://github.com/Alfresco/alfresco-helm-charts/blob/main/charts/alfresco-repository/docs/enterprise-license.md) ## Upgrade @@ -103,13 +103,6 @@ helm charts versions. An autogenerated list of helm values used in the chart and their default values can be found here: [Alfresco Content Services Helm Chart](./../../helm/alfresco-content-services/README.md) -Since the Alfresco Content Services chart also has local chart dependencies you can find the list of values that can be configured for these charts in their respective base folder: - -* [Alfresco ActiveMQ Helm Chart](./../../helm/alfresco-content-services/charts/activemq/README.md) -* [Alfresco Search Helm Chart](./../../helm/alfresco-content-services/charts/alfresco-search/README.md) -* [Alfresco Insight Zeppelin Helm Chart](./../../helm/alfresco-content-services/charts/alfresco-search/charts/alfresco-insight-zeppelin/README.md) -* [Alfresco Sync Service Helm Chart](./../../helm/alfresco-content-services/charts/alfresco-sync-service/README.md) - ## Customise To customise the Helm deployment, for example applying AMPs, we recommend following the best practice of creating your own custom Docker image(s). The [Customisation Guide](./examples/customisation-guidelines.md) walks you through this process. @@ -118,7 +111,7 @@ To customise the Helm deployment, for example applying AMPs, we recommend follow ### Lens -The easiest way to troubleshoot issues on a Kubernetes deployment is to use the [Lens](https://k8slens.dev) desktop application, which is available for Mac, Windows and Linux. Follow the [getting started guide](https://docs.k8slens.dev/v4.0.3/getting-started) to configure your environment. +The easiest way to troubleshoot issues on a Kubernetes deployment is to use the [Lens](https://k8slens.dev) desktop application, which is available for Mac, Windows and Linux. Follow the [getting started guide](https://docs.k8slens.dev/getting-started/) to configure your environment. ![Lens Application](./images/k8s-lens.png) diff --git a/docs/helm/examples/customisation-guidelines.md b/docs/helm/examples/customisation-guidelines.md index e0a2e1d44..a8a8a7b88 100644 --- a/docs/helm/examples/customisation-guidelines.md +++ b/docs/helm/examples/customisation-guidelines.md @@ -20,8 +20,7 @@ values files. ## Creating Custom Docker Images -The [docker compose Customisation -Guide](../../docker-compose/examples/customisation-guidelines.md) provides a +The [docker compose Customisation Guide](../../docker-compose/examples/customisation-guidelines.md) provides a detailed example of how to apply an AMP in a custom image and a more advanced example of building a custom image with configuration can be found [here](https://github.com/Alfresco/acs-packaging/blob/master/docs/create-custom-image-using-existing-docker-image.md#applying-amps-that-require-additional-configuration-advanced). @@ -30,7 +29,7 @@ example of building a custom image with configuration can be found Once you have created your custom image you can either change the default values in the appropriate values file in [this -folder](../../../helm/alfresco-content-services) or you can override the values +folder](https://github.com/Alfresco/acs-deployment/blob/master/helm/alfresco-content-services) or you can override the values via the `--set` command line option during install as shown below: ```bash diff --git a/docs/helm/examples/external-hazelcast.md b/docs/helm/examples/external-hazelcast.md index 1b45e4bf6..44463092c 100644 --- a/docs/helm/examples/external-hazelcast.md +++ b/docs/helm/examples/external-hazelcast.md @@ -32,8 +32,7 @@ grand_parent: Helm ## Step by step guide -1. Deploy alfresco-content-services. See [desktop - deployment](../desktop-deployment.md) section. Remember to stick to one +1. Deploy alfresco-content-services. See [desktop deployment](../desktop-deployment.md) section. Remember to stick to one namespace in next steps. 2. Prepare a valid Hazelcast xml configuration, which also must include @@ -98,13 +97,13 @@ grand_parent: Helm Now copy generated xml configuration into manifest file. (Remember to correctly indent copied text) -7. Deploy created [manifest](external-hazelcast_files/configmap-hazelcast.yaml) +7. Deploy created [manifest](https://github.com/Alfresco/acs-deployment/blob/master/docs/helm/examples/external-hazelcast_files/configmap-hazelcast.yaml) ```bash kubectl apply -f configmap-hazelcast.yaml ``` -8. Deploy hazelcast with [values](external-hazelcast_files/hazelcast.yaml) +8. Deploy hazelcast with [values](https://github.com/Alfresco/acs-deployment/blob/master/docs/helm/examples/external-hazelcast_files/hazelcast.yaml) presented below ```yaml @@ -125,7 +124,7 @@ grand_parent: Helm ``` 9. Now change the config of alfresco-repository by adding another [values - file](external-hazelcast_files/acs-hazelcast.yaml). In below file specify + file](https://github.com/Alfresco/acs-deployment/blob/master/docs/helm/examples/external-hazelcast_files/acs-hazelcast.yaml). In below file specify properties that will make repository use external hazelcast cluster deployed in previous step. Remember to accordingly change the values if needed. diff --git a/docs/helm/upgrades.md b/docs/helm/upgrades.md index 1f8ea51e2..2e804a6dc 100644 --- a/docs/helm/upgrades.md +++ b/docs/helm/upgrades.md @@ -19,8 +19,7 @@ version in which they have been released. ## 8.0.0 * Search Enterprise is now the default search engine when installing Enterprise - version. For production it's suggested to use an [external elaticsearch - index](examples/with-external-infrastructure.md#elasticsearch-index). + version. For production it's suggested to use an [external elaticsearch index](examples/with-external-infrastructure.md#elasticsearch-index). ## 8.0.0-M.1 diff --git a/helm/acs-sso-example/docs/sso-guide.md b/helm/acs-sso-example/docs/sso-guide.md index b9b82904d..925e6b28d 100644 --- a/helm/acs-sso-example/docs/sso-guide.md +++ b/helm/acs-sso-example/docs/sso-guide.md @@ -6,8 +6,7 @@ grand_parent: Helm # SSO integration with Keycloak (vanilla) -This is an extension of the base setup presented in the [step by step -guide](./step-by-step-guide.md). Make sure you have it running before reading +This is an extension of the base setup presented in the [step by step guide](./step-by-step-guide.md). Make sure you have it running before reading further (unless you just want to look at how to integrate Keycloak with ACS component without trying it on your local machine). diff --git a/helm/acs-sso-example/docs/step-by-step-guide.md b/helm/acs-sso-example/docs/step-by-step-guide.md index 6390364df..da5d920de 100644 --- a/helm/acs-sso-example/docs/step-by-step-guide.md +++ b/helm/acs-sso-example/docs/step-by-step-guide.md @@ -11,7 +11,7 @@ platform to deploy on [Kubernetes](https://kubernetes.io/). ## Why an example charts when there is already the alfresco-content-services? -With [alfresco-content-services chart](../../alfrescocontent-services/) we +With [alfresco-content-services chart](../../alfresco-content-services/README.md) we tried to provide something that can deploy most of our software components - still not all of them are included - but also serves as a basis for customization for real world scenarios. These two paradigms have actually @@ -24,7 +24,7 @@ including third party ones (database, message broker, Identity provider, ...). For that reason we have started creating individual charts for Alfresco components in the [alfresco-helm-charts -repository](https://github.com/Alfresco/alfreso-helm-charts/charts/) (more to +repository](https://github.com/Alfresco/alfresco-helm-charts/tree/main/charts) (more to come and PR are welcome). ## High overview of the example chart @@ -317,7 +317,7 @@ approach we prefer using to configure Alfresco component charts. #### Configuring the repository subchart The [Alfresco repository chart -documentation](ihttps://github.com/Alfresco/alfresco-helm-charts/tree/main/charts/alfresco-repository) +documentation](https://github.com/Alfresco/alfresco-helm-charts/tree/main/charts/alfresco-repository) shows how to configure the repo db and message broker using configmaps and secrets: ```yaml