From def802aea069c752bf274eca0703d1378b57f9f1 Mon Sep 17 00:00:00 2001 From: pmacius Date: Thu, 5 Dec 2024 18:01:52 +0100 Subject: [PATCH] OPSEXP-2930 Point links to support.hyland.com --- README.md | 19 +++++++++++-------- docs/SECRETS.md | 4 +++- docs/_config.yml | 1 + docs/components-upgrade.md | 4 +++- docs/deployment-guide.md | 22 ++++++++++++++++------ docs/overview.md | 4 +++- roles/search_enterprise/defaults/main.yml | 2 +- 7 files changed, 38 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 2ff419347..15cf4aa6d 100644 --- a/README.md +++ b/README.md @@ -191,19 +191,22 @@ doc](./README.md#versioning) Follow this quick checklist: 1. Review currently open dependabot/renovate and merge them. -2. In case of a new ACS major version, copy the versions inside the group_vars/all.yml to a new XX.N-extra-vars.yml -3. Bump versions constraints in scripts/updatecli/updatecli_acs*.yml (workflow will take care of the rest) -4. Ensure that the [versions table in the main readme](docs/overview.md#versioning) has been updated -5. Ensure that docker images and AMI id for the root molecule tests are +2. For minor releases, ensure to update the links beginning with + `https://support.hyland.com/r/Alfresco` to reflect the latest version or + corresponding minor update documentation. +3. In case of a new ACS major version, copy the versions inside the group_vars/all.yml to a new XX.N-extra-vars.yml +4. Bump versions constraints in scripts/updatecli/updatecli_acs*.yml (workflow will take care of the rest) +5. Ensure that the [versions table in the main readme](docs/overview.md#versioning) has been updated +6. Ensure that docker images and AMI id for the root molecule tests are reflecting any minor OS release (e.g. [default suite](../molecule/default/)) -6. Ensure that activemq, tomcat and java versions are up to date (latest patch version) -7. After merging every pending PR, proceed with tagging: +7. Ensure that activemq, tomcat and java versions are up to date (latest patch version) +8. After merging every pending PR, proceed with tagging: * `git tag -s v2.x.x -m v2.x.x` * `git push origin v2.x.x` -8. Wait for the [Release +9. Wait for the [Release workflow](https://github.com/Alfresco/alfresco-ansible-deployment/actions/workflows/release.yml) go green. -9. [Draft a new +10. [Draft a new release](https://github.com/Alfresco/alfresco-ansible-deployment/releases) on GitHub with the tag you just pushed. If the release is for a new ACS major version, mention the ACS release in the title, e.g. v2.x.x (ACS 23.4.0) diff --git a/docs/SECRETS.md b/docs/SECRETS.md index dee80ec05..a8da9bb15 100644 --- a/docs/SECRETS.md +++ b/docs/SECRETS.md @@ -10,7 +10,7 @@ them manually. Links to the official documentation relevant for this subject: -* [Alfresco Authorization](https://docs.alfresco.com/content-services/latest/admin/security/) +* [Alfresco Authorization][security] ## Secrets defined as variables @@ -66,3 +66,5 @@ acs_environment: `metadata-keystore.password` is the same variable handled in `keystore_password`. `metadata-keystore.metadata.password` is the password of the keystore dedicated to repository metadata. + +[security]: https://support.hyland.com/r/Alfresco/Alfresco-Content-Services/23.4/Alfresco-Content-Services/Administer/Manage-Security/Authorization diff --git a/docs/_config.yml b/docs/_config.yml index 01a19e677..8ee285a11 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -6,6 +6,7 @@ color_scheme: alfresco url: https://alfresco.github.io aux_links: + Hyland Support: https://support.hyland.com/p/alfresco Docs: https://docs.alfresco.com/ GitHub Repository: https://github.com/Alfresco/alfresco-ansible-deployment diff --git a/docs/components-upgrade.md b/docs/components-upgrade.md index 185ee8387..b89b8fddc 100644 --- a/docs/components-upgrade.md +++ b/docs/components-upgrade.md @@ -16,7 +16,7 @@ The ACS installation is made of several components among which: Before proceeding to an upgrade, an administrator needs to: -- Make sure the [upgrade path and documentation](https://docs.alfresco.com/content-services/latest/upgrade/) is followed +- Make sure the [upgrade path and documentation][acs-upgrade] is followed - Appropriate backups of database, contentstore and indexes are done and can be restored in case a rollback is needed - Initial deployment must have been done using this Ansible playbook @@ -88,3 +88,5 @@ If something goes wrong with the upgrade, or if tests are not successful after u ### Hotfix "in-place" upgrades This process will restart tomcat on all the repository nodes and there is no guarantee one node is stopped only after the others have restarted. As a consequence a short service outage needs to be scheduled + +[acs-upgrade]: https://support.hyland.com/r/Alfresco/Alfresco-Content-Services/23.4/Alfresco-Content-Services/Upgrade diff --git a/docs/deployment-guide.md b/docs/deployment-guide.md index 31f4623d9..a7ea808c0 100644 --- a/docs/deployment-guide.md +++ b/docs/deployment-guide.md @@ -444,7 +444,7 @@ The sections below describe how you can configure your deployment before running If you have a valid license place your `.lic` file in the `configuration_files/licenses` folder before running the playbook. -> NOTE: You can also [upload a license](https://docs.alfresco.com/content-services/latest/admin/license/) via the Admin Console once the system is running. +> NOTE: You can also [upload a license][upload-license] via the Admin Console once the system is running. ### Secrets management @@ -570,8 +570,8 @@ And then edit `vars/secrets.yml` to fill all the required arguments for the plug ### Alfresco Global Properties -You can provide your [repository configuration](https://docs.alfresco.com/content-services/latest/config/#using-alfresco-globalproperties) -by editing the `configuration_files/alfresco-global.properties` file. +You can provide your [repository configuration][global-properties] by editing +the `configuration_files/alfresco-global.properties` file. > This approach is now discouraged and you should prefer using the [`repository` > group vars](https://github.com/Alfresco/alfresco-ansible-deployment/blob/master/configuration_files/alfresco-global.properties) @@ -663,7 +663,8 @@ Along with the url the database driver binaries need to be provided for one or b The default database username (`repo_db_username` and/or `sync_db_username`) and password (`repo_db_password` and/or `sync_db_password`) in the configuration file `group_vars/all.yml` can also be overridden with your custom values. -Please refer to the [Configuring Databases](https://docs.alfresco.com/content-services/latest/config/databases/) documentation for more detailed information. +Please refer to the [Configuring Databases][databases] documentation for more +detailed information. ### External ActiveMQ @@ -722,7 +723,9 @@ Support for external Identity service will be implemented in a future playbook r ### Custom Keystore -By default the playbook deploys a default keystore to ease the installation process, however, we recommend you [generate your own keystore](https://docs.alfresco.com/content-services/latest/admin/security/#managealfkeystores) following the [instructions here](https://docs.alfresco.com/content-services/latest/admin/security/#keystore-generation). +By default the playbook deploys a default keystore to ease the installation +process, however, we recommend you [generate your own keystore][alf-keystores] +following the [instructions here][keystore-generation]. There are three steps required to use a custom keystore: @@ -1109,7 +1112,7 @@ several repository nodes. This can be achieved rather simply by: * Specifying several hosts within the repository hosts group > :warning: as mention in the -> [Alfresco official documentation](https://docs.alfresco.com/content-services/latest/admin/cluster/#scenarioredundancycluster), +> [Alfresco official documentation][redundancy], > "All the servers in a cluster should have static IP addresses assigned to > them". @@ -1283,3 +1286,10 @@ If the playbook fails for some reason try re-running it with the `-v` option, if ### Alfresco Failures If the playbook completes successfully but the system is not functioning the best place to start is the log files, these can be found in the `/var/log/alfresco` folder on the target hosts. Please note the nginx log files are owned by root as the nginx process is running as root so it can listen on port 80. + +[upload-license]: https://support.hyland.com/r/Alfresco/Alfresco-Content-Services/23.4/Alfresco-Content-Services/Administer/Licenses/Upload-new-license +[global-properties]: https://support.hyland.com/r/Alfresco/Alfresco-Content-Services/23.4/Alfresco-Content-Services/Configure/Overview/Using-alfresco-global.properties +[databases]: https://support.hyland.com/r/Alfresco/Alfresco-Content-Services/23.4/Alfresco-Content-Services/Configure/Databases +[alf-keystores]: https://support.hyland.com/r/Alfresco/Alfresco-Content-Services/23.4/Alfresco-Content-Services/Administer/Manage-Security/Authorization/Manage-Alfresco-keystores +[keystore-generation]: https://support.hyland.com/r/Alfresco/Alfresco-Content-Services/23.4/Alfresco-Content-Services/Administer/Manage-Security/Authorization/Manage-Alfresco-keystores/Keystore-generation +[redundancy]: https://support.hyland.com/r/Alfresco/Alfresco-Content-Services/23.4/Alfresco-Content-Services/Administer/High-availability-features/Clustering/Recommendations-for-split-architecture/Scenario-Clustering-for-redundancy diff --git a/docs/overview.md b/docs/overview.md index d12c72ad7..62990ce51 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -78,7 +78,7 @@ set of instructions. To understand which Operating System the Alfresco Ansible playbook can work against (on the target nodes), please refer to the [Supported platform -doc](https://docs.alfresco.com/content-services/latest/support/) (pick the right +doc][support] (pick the right Alfresco version). We aim to support these stacks **with the exception of** Amazon Linux & Suse @@ -112,3 +112,5 @@ ACS 7.x onward. > Support for ACS 7.1 has been deprecated since November 2024, but you can still use the latest playbook that supported it ([v2.11.2](https://github.com/Alfresco/alfresco-ansible-deployment/releases/tag/v2.11.2)) > Support for ACS 7.0 has been deprecated since April 2024, but you can still use the latest playbook that supported it ([v2.6.0](https://github.com/Alfresco/alfresco-ansible-deployment/releases/tag/v2.6.0)) > Support for ACS 6.2 has been deprecated since November 2022, but you can still use the latest playbook that supported it ([v2.2.0](https://github.com/Alfresco/alfresco-ansible-deployment/releases/tag/v2.2.0)) + +[support]: https://support.hyland.com/r/Alfresco/Alfresco-Content-Services/23.4/Alfresco-Content-Services/Supported-Platforms diff --git a/roles/search_enterprise/defaults/main.yml b/roles/search_enterprise/defaults/main.yml index 33866f8d8..70fcf3d1f 100644 --- a/roles/search_enterprise/defaults/main.yml +++ b/roles/search_enterprise/defaults/main.yml @@ -1,5 +1,5 @@ --- # defaults file for search_enterprise search_enterprise_port: 8081 -# see https://docs.alfresco.com/search-enterprise/latest/admin/#alfresco-elasticsearch-connector +# see https://support.hyland.com/r/Alfresco/Alfresco-Search-Enterprise/4.2/Alfresco-Search-Enterprise/Administer search_enterprise_reindex_options: ''