diff --git a/docs/deploy-and-configure/installation/index.md b/docs/deploy-and-configure/installation/index.md index 6cb2e9c72..8755c2008 100644 --- a/docs/deploy-and-configure/installation/index.md +++ b/docs/deploy-and-configure/installation/index.md @@ -8,14 +8,27 @@ This page describes proven deployment scenarios for eccenca Corporate Memory. All Corporate Memory components are distributed as Docker images and can be obtained from eccenca's container repository service. To run them you need a Docker enabled Linux server. +Corporate Memory uses Ontotext GraphDB triple store as default backend. +You need to copy your license for Ontotext GraphDB to the `license` folder inside Corporate Memory's root folder. + +```shell +# create the License folder within ${HOME}/cmem-orchestration +mkdir -p licenses +#copy YOUR-LICENSE-FILE +cp YOUR_SE_LICENSE_FILE \ + ${HOME}/cmem-orchestration-VERSION/licenses/graphdb-se.license +# or +cp YOUR_EE_LICENSE_FILE \ + ${HOME}/cmem-orchestration-VERSION/licenses/graphdb-ee.license +``` ## Operating Systems (OS) -Corporate Memory is tested on Ubuntu 24.04 (backward compatible with LTS versions older than that) as Debian 11, 12 and 13. +Corporate Memory is tested on Ubuntu 24.04 (backward compatible with older LTS versions) as well as Debian 11, 12, and 13. -Special note on RHEL SELinux Support: there is no limitation for RedHat SELinux. We recommend to keep the SELinux in *enforced* mode. You can keep the default setting of the `/etc/selinux/config` file. +Special note on RHEL SELinux Support: There is no limitation for RedHat SELinux. We recommend keeping the SELinux in *enforced* mode. You can keep the default setting of the `/etc/selinux/config` file. -???+ example "sample config" +???+ example "Sample Config" ```bash title="/etc/selinux/config" linenums="1" # This file controls the state of SELinux on the system. @@ -31,19 +44,19 @@ Special note on RHEL SELinux Support: there is no limitation for RedHat SELinux. SELINUXTYPE=targeted ``` -## Docker compose based Orchestration deployment - -[Docker Compose](https://docs.docker.com/compose/) is a convenient way to provision several Docker containers locally for development -setups or on remote servers for single node setups. - -eccenca is heavily using `docker compose` for all kinds of internal and customer deployments. -For more details on how to use `docker compose` based orchestration refer -to [Scenario: Local Installation](../installation/scenario-local-installation/index.md) and [Scenario: Single Node Cloud Installation](../installation/scenario-single-node-cloud-installation/index.md). - ## Helm based Kubernetes deployment Most production deployments are Kubernetes based. We have deployments in AWS (EKS), Azure (AKS), Red Hat Openshift and self-hosted clusters. We provide Charts for Corporate Memory and Keycloak at our [Helm Repository](https://helm.eccenca.com). -For more details on how to use `helm` based deployments refer -to [Scenario: Kubernetes Deployment](../installation/scenario-k8s-deployment/index.md). +For more details on how to use `helm` based deployments, refer to +[Scenario: Kubernetes Deployment](../installation/scenario-k8s-deployment/index.md). + +## Docker compose based Orchestration deployment + +[Docker Compose](https://docs.docker.com/compose/) is a convenient way to provision several Docker containers locally for development +setups or on remote servers for single node setups. + +eccenca uses `docker compose` for all kinds of internal and customer deployments. +For more details on how to use `docker compose` based orchestration, refer to +[Scenario: Local Installation](../installation/scenario-local-installation/index.md) and [Scenario: Single Node Cloud Installation](../installation/scenario-single-node-cloud-installation/index.md). diff --git a/docs/deploy-and-configure/installation/scenario-k8s-deployment/index.md b/docs/deploy-and-configure/installation/scenario-k8s-deployment/index.md index 362c6803d..dcf086e58 100644 --- a/docs/deploy-and-configure/installation/scenario-k8s-deployment/index.md +++ b/docs/deploy-and-configure/installation/scenario-k8s-deployment/index.md @@ -16,11 +16,11 @@ provisioned cluster. ## Requirements -- Access credentials for the eccenca infrastructre (e.g. Docker Registry) → [contact us to get yours](https://eccenca.com/en/contact) -- A license for [GraphDB](https://www.ontotext.com/products/graphdb/) -- [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) -- [Helm](https://helm.sh/docs/intro/install/) -- If deploying on K3D, download a [static binary](https://github.com/k3d-io/k3d/releases) +- Access credentials for the eccenca infrastructure (e.g. Docker Registry) → [contact us to get yours](https://eccenca.com/en/contact) +- A GraphDB license ([free](https://www.ontotext.com/products/graphdb/) or commercial) +- [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) +- [Helm](https://helm.sh/docs/intro/install/) +- If deploying on K3D, download a [static binary](https://github.com/k3d-io/k3d/releases) ## Architecture @@ -28,16 +28,14 @@ provisioned cluster. ## General Notice -Although this document lists value files for the three charts, we suggest always -looking at the default `values.yaml` file from the archive or repository. -The examples shown here are very basic and should not represent a production -environment. The `CHANGELOG.md` and `README.md` files in the archives or -repositories can also give some insights. +Although this document lists value files for the three charts, we recommend consulting the default `values.yaml` file from the archive or repository. +The examples shown here are very basic and are not intended for a production environment. +The `CHANGELOG.md` and `README.md` files in the archives or repositories can also give some insights. We assume that the k8s namespaces are already created. You can either deploy all three components into one namespace or into separate ones. -``` console +```shell kubectl create namespace graphdb kubectl create namespace keycloak kubectl create namespace cmem @@ -47,11 +45,10 @@ kubectl create namespace cmem To install GraphDB, we will use the Ontotext Helm chart. You can get the source code from [github](https://github.com/Ontotext-AD/graphdb-helm/tree/main). -Additionally have a look at GraphDBs [documentation page](https://graphdb.ontotext.com/documentation/). +Additionally have a look at GraphDB's [documentation page](https://graphdb.ontotext.com/documentation/). -Be aware, that with Version 11 of GraphDB you are required to deploy a license -file, even in the Free edition. -You can aquire one by [filling a form](https://www.ontotext.com/products/graphdb/). +Be aware that with Version 11 of GraphDB you are required to deploy a license file, even in the Free edition. +[You can request one here.](https://www.ontotext.com/products/graphdb/) See also the [licensing documentation](https://graphdb.ontotext.com/documentation/11.1/licensing.html). ### 1. Obtain the chart @@ -59,7 +56,7 @@ See also the [licensing documentation](https://graphdb.ontotext.com/documentatio You can download the GraphDB chart from [github](https://github.com/Ontotext-AD/graphdb-helm/releases) or add their repository to your environment with `helm`: -``` console +```shell helm repo add ontotext https://maven.ontotext.com/repository/helm-public/ helm repo update ``` @@ -117,7 +114,7 @@ persistence: First, create the license secret as mentioned above. Then, install the GraphDB chart using `helm`: -``` console +```shell kubectl --namespace graphdb create secret generic graphdb-license \ --from-file graphdb.license @@ -135,14 +132,14 @@ you can use `kubectl port-forward`. This is useful for initial setup and verific First, get the name of the GraphDB service: -``` console +```shell kubectl get svc --namespace graphdb ``` Assuming the service is named `graphdb`, forward a local port to the service port (`7200`): -``` console +```shell kubectl port-forward svc/graphdb 7200:7200 --namespace graphdb ``` @@ -155,23 +152,22 @@ provided Helm chart. ### 1. Obtain the chart -We strongly recommend to download the chart and execute the install commands against a local environment. +We strongly recommend downloading the chart and executing the install commands against a local environment. - -``` console +```shell wget https://helm.eccenca.com/keycloak/latest.tgz tar -xzf latest.tgz ``` -``` console +```shell # this requires gitlab.eccenca.com access git clone ssh://git@gitlab.eccenca.com:8101/devops/keycloak-helm.git ``` -You can also use the helm package manger, but then you have to take care about restoring from a backup on your own. -The mechanism for that is included in the chart, but the helm command requires you have the sql dump file on your local machine. +You can also use the Helm package manager, but then you have to handle restoring from a backup on your own. +The mechanism for that is included in the chart, but the helm command requires you have the SQL dump file on your local machine. -``` console +```shell helm repo add --force-update eccenca https://helm.eccenca.com helm repo update eccenca ``` @@ -220,7 +216,7 @@ Use `helm` to deploy the chart into the `keycloak` namespace. With local extracted helm chart: -``` console +```shell helm upgrade -i keycloak ./keycloak-helm \ --namespace keycloak \ -f keycloak-values.yaml @@ -228,7 +224,7 @@ helm upgrade -i keycloak ./keycloak-helm \ Or from helm repository: -``` console +```shell helm upgrade --install keycloak eccenca/keycloak-helm \ --namespace keycloak \ -f keycloak-values.yaml @@ -262,7 +258,7 @@ NOTES: https://kc.docker.localhost/auth ``` -## Installation Corporate Memory +## Corporate Memory Installation This guide provides instructions on how to install the chart using `kubectl` and `helm`. @@ -270,18 +266,18 @@ You need to have a keycloak instance and a supported graph database installed. ### 1. Obtain the chart -``` console +```shell wget https://releases.eccenca.com/cmem-helm/latest.tgz tar -xzf latest.tgz cd cmem ``` -``` console +```shell helm repo add --force-update cmem-helm https://helm.eccenca.com helm repo update cmem-helm ``` -``` console +```shell # this requires gitlab.eccenca.com access git clone https://gitlab.eccenca.com/cmem/cmem-helm.git ``` @@ -294,7 +290,7 @@ a license intended for non-commercial usage. If you have a dedicated license file, create a secret with a `license.asc` data entry: -``` console +```shell kubectl create secret generic cmem-license \ --from-file license.asc --namespace cmem @@ -370,7 +366,7 @@ Setting up Graph Insights in Kubernetes deployment done with helm is described i To pull the Corporate Memory images, you need to provide credentials for the eccenca Docker Registry. -``` console +```shell kubectl create secret docker-registry eccenca-docker-registry-credentials \ --docker-server=https://docker-registry.eccenca.com \ --docker-username= \ @@ -384,8 +380,8 @@ Now use `helm` to deploy the chart. This command will install the chart in the specified namespace using your custom configuration. -``` console -# In case you have the chart or repostiory locally available +```shell +# In case you have the chart or repository locally available helm upgrade --install cmem . \ --namespace cmem \ -f cmem-values.yaml @@ -400,13 +396,13 @@ helm upgrade --install cmem cmem-helm/cmem \ After the installation is complete, you can check the status of the pods: -``` console +```shell kubectl get pods --namespace cmem ``` You can also check the rollout status of the StatefulSets: -``` console +```shell kubectl rollout status statefulset/explore --namespace cmem kubectl rollout status statefulset/dataintegration --namespace cmem ``` diff --git a/docs/deploy-and-configure/installation/scenario-local-installation/index.md b/docs/deploy-and-configure/installation/scenario-local-installation/index.md index c49ecf0d2..bd019b75f 100644 --- a/docs/deploy-and-configure/installation/scenario-local-installation/index.md +++ b/docs/deploy-and-configure/installation/scenario-local-installation/index.md @@ -7,116 +7,194 @@ icon: material/laptop This page describes a `docker compose` based orchestration running on your local machine and accessible via browser. -The code examples in this section assumes that you have POSIX-compliant shell (linux, macOS or WSL for Windows). +The code examples in this section assume that you have a POSIX-compliant shell (Linux, macOS or WSL for Windows). ## Requirements -- Access credentials to eccenca Artifactory and eccenca Docker Registry → [contact us to get yours](https://eccenca.com/en/contact) -- [docker](https://www.docker.com/) and [docker compose](https://docs.docker.com/compose/install/) (v2) installed locally -- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) installed locally -- [jq](https://jqlang.github.io/jq/download/) installed locally -- A GraphDB license (free or commercial) -- (optional) A Graph Insights license -- make - build tools (apt-get install make) installed locally -- At least 4 CPUs and 12GB of RAM (recommended: 16GB) dedicated to docker +- Access credentials to eccenca Artifactory and eccenca Docker Registry → [contact us to get yours](https://eccenca.com/en/contact) +- [docker](https://www.docker.com/) and [docker compose](https://docs.docker.com/compose/install/) (v2) installed locally +- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) installed locally +- [jq](https://jqlang.github.io/jq/download/) installed locally +- A GraphDB license ([free](https://www.ontotext.com/products/graphdb/) or commercial) +- (optional) A Graph Insights license +- make - build tool (apt-get install make) installed locally (don't use version 4.4.1 [→](https://savannah.gnu.org/bugs/?63650); e.g., 4.3 works well) +- At least 4 CPUs and 12GB of RAM (recommended: 16GB) dedicated to docker -## WSL installation and configuration +## Setup & Check Installation Environment -For all you need to start Powershell started as administrator. -Alternatively you can also install a WSL distribution from Microsoft Store. +Install the requirements -Install WSL, then restart your Windows machine. +=== "Linux" -```shell -wsl --install -``` + Install all the needed packages: -List available distributions + ```shell + sudo apt-get install -y curl gnupg2 \ + gnupg lsb-release gettext zip unzip git \ + make=4.3-4.1 vim jq + ``` + To install Corporate Memory, you need to modify your local hosts file (located in /etc/hosts), minimal configuration is as follows: -```shell -wsl --list --online -``` + ```shell + ## + # Host Database + # + # localhost is used to configure the loopback interface + # when the system is booting. Do not change this entry. + ## + 127.0.0.1 localhost + 127.0.0.1 docker.localhost + ``` -Install a distribution. -Chose from the `Name` column. -Here we use a Debian based distribution like Debian or any Ubuntu. -However other Distributions might work as well. +=== "macOS" -```shell -wsl --install Debian -``` + Install homebrew: -Ensure you use WSL version 2 (this is necessary to use `systemd` services). + ```shell + /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" + ``` -```shell -wsl -l -v -``` + Install all needed packages: -Install version 2 components (this requires a windows restart) + ```shell + brew install curl gnupg2 \ + gnupg lsb-release gettext zip unzip git \ + vim jq + ``` + To install Corporate Memory, you need to modify your local hosts file (located in /etc/hosts), minimal configuration is as follows: -```shell -dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart -``` + ```shell + ## + # Host Database + # + # localhost is used to configure the loopback interface + # when the system is booting. Do not change this entry. + ## + 127.0.0.1 localhost + 127.0.0.1 docker.localhost + ``` -Enter WSL machine +=== "WSL" -```shell -wsl -d Debian -``` + First of all, you need to start PowerShell as administrator. + Alternatively you can also install a WSL distribution from Microsoft Store. -Enable `generateHosts = false` in your `/etc/hosts` file to make sure that this file won't be overwritten from the host system on every restart. + Install WSL, then restart your Windows machine. -To be able to use `systemd` services and commands make sure `/etc/wsl.conf` is available with this content (should be the default with WSL v2): + ```shell + wsl --install + ``` -```shell -[boot] -systemd=true -``` + List available distributions -(Optional) If you need to restart your WSL use in Powershell: + ```shell + wsl --list --online + ``` -```shell -wsl --shutdown -``` + Install a distribution: + Choose from the `Name` column. + Here we use a Debian based distribution like Debian or any Ubuntu. + However, other distributions might work as well. -(Optional) you can create a `.wslconfig` file under `C:\users\` to specify some system resources like: + ```shell + wsl --install Debian + ``` -```shell -[wsl2] -memory=16GB # restrict ram WSL can use -processors=4 # restrict cpu-cores -swap=8GB # set swap size -swapFile=C:/Users//wsl/Debianswap.vhdx # location to swap-file -``` + Ensure you use WSL version 2 (this is necessary to use `systemd` services). -Alternatively, (with WSL v2) you may use the graphical configuration application _WSL Settings_. + ```shell + wsl -l -v + ``` -## Setup & Check Installation Environment + Install version 2 components (this requires a windows restart) -For docker we recommend to use the linux docker within WSL. -Follow the instruction in [Server Provisioning in Scenario: Single Node Cloud Installation](../scenario-single-node-cloud-installation/index.md#server-provisioning). -Alternatively, you may use docker for desktop and enable WSL integration in the settings. + ```shell + dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart + ``` -Open a terminal window, create a directory, copy and extract docker orchestration there. + Enter WSL machine -```shell -# Create eccenca-corporate-memory directory in your ${HOME} and set as a -# working dir. -sudo apt install -y curl jq make git unzip gpg - -mkdir ${HOME}/eccenca-corporate-memory && cd ${HOME}/eccenca-corporate-memory - -# download the Corporate Memory orchestration distribution -curl https://releases.eccenca.com/docker-orchestration/latest.zip \ - > cmem-orchestration.zip - -# unzip the orchestration and move the unzipped directory -unzip cmem-orchestration.zip -rm cmem-orchestration.zip -mv cmem-orchestration-v* cmem-orchestration -cd cmem-orchestration -git init && git add . && git commit -m "stub" -``` + ```shell + wsl -d Debian + ``` + + Enable `generateHosts = false` in your `/etc/hosts` file to make sure that this file won't be overwritten from the host system on every restart. + + To be able to use `systemd` services and commands, make sure `/etc/wsl.conf` is available with this content (should be the default with WSL v2): + + ```shell + [boot] + systemd=true + ``` + + (Optional) If you need to restart your WSL use in Powershell: + + ```shell + wsl --shutdown + ``` + + To install Corporate Memory, you need to modify your local hosts file (located in C:\Windows\System32\drivers\etc\hosts), minimal configuration is as follows: + !!! Warning + This requires administration rights. + + ```shell + ## + # Host Database + # + # localhost is used to configure the loopback interface + # when the system is booting. Do not change this entry. + ## + 127.0.0.1 localhost + 127.0.0.1 docker.localhost + ``` + + (Optional) You can create a `.wslconfig` file under `C:\Users\` to specify some system resources like: + + ```shell + [wsl2] + memory=16GB # restrict ram WSL can use + processors=4 # restrict cpu-cores + swap=8GB # set swap size + swapFile=C:/Users//wsl/Debianswap.vhdx # location to swap-file + ``` + + Alternatively, (with WSL v2) you may use the graphical configuration application _WSL Settings_. + + For Docker, we recommend using the Linux Docker within WSL. + Alternatively, you may use Docker for Desktop and enable WSL integration in the settings. + +--- + +=== "Installation via .zip file" + Open a terminal window, create a directory, copy and extract docker orchestration there. + + ```shell + # Create eccenca-corporate-memory directory in your ${HOME} and set as a + # working dir. + + mkdir ${HOME}/eccenca-corporate-memory && cd ${HOME}/eccenca-corporate-memory + + # Download the Corporate Memory orchestration distribution + curl https://releases.eccenca.com/docker-orchestration/latest.zip \ + > cmem-orchestration.zip + + # Unzip the orchestration and move the unzipped directory + unzip cmem-orchestration.zip + rm cmem-orchestration.zip + mv cmem-orchestration-v* cmem-orchestration + cd cmem-orchestration + git init && git add . && git commit -m "stub" + ``` + +=== "Installation via gitlab.eccenca.com" + + If you have access to gitlab.eccenca.com we recommend cloning our repository and follow the README. + + ```shell + git clone ssh://git@gitlab.eccenca.com:8101/elds/cmem-orchestration.git + ``` + +--- Check your local environment: @@ -144,24 +222,13 @@ docker login docker-registry.eccenca.com ## Installation -To install Corporate Memory, you need to modify your local hosts file (located in /etc/hosts), minimal configuration is as follows: - -```shell -## -# Host Database -# -# localhost is used to configure the loopback interface -# when the system is booting. Do not change this entry. -## -127.0.0.1 localhost -127.0.0.1 docker.localhost -``` - -Corporate Memory uses Ontotext GraphDB triple store as default backend. -Graphdb is available as free version and does not requires a license. -If you have a license for Ontotext GraphDB you can copy the file to the `license` folder inside Corporate Memory's root folder. +Corporate Memory uses Ontotext GraphDB triple store as the default backend. +You need to copy your license for Ontotext GraphDB to the `license` folder inside Corporate Memory's root folder. ```shell +# Create the licenses folder within ${HOME}/cmem-orchestration +mkdir -p licenses +# Copy YOUR-LICENSE-FILE cp YOUR_SE_LICENSE_FILE \ ${HOME}/cmem-orchestration-VERSION/licenses/graphdb-se.license # or @@ -185,58 +252,13 @@ Run the command to clean workspace, pull the images, start the Corporate Memory make clean-pull-start-bootstrap ``` -You should see the output as follows: - -```shell -make[1]: Entering directory '/home/ttelleis/cmem-dist/cmem-orchestration' -The target cleans up everything and esp. REMOVES ALL YOUR DATA. Do you want to continue? - -You can avoid this question / interruption by setting CO_I_KNOW_WHAT_I_DO to true. -Type '1' for Yes or type '2' for No. - -1) Yes -2) No -#? 1 -make check-env kill stop down rm-log-dir -make[2]: Entering directory '/home/ttelleis/cmem-dist/cmem-orchestration' -/usr/bin/docker compose kill -no container to kill/usr/bin/docker compose stop -/usr/bin/docker compose down --volumes --remove-orphans || exit 0 -/usr/bin/docker compose up -d -[+] Running 12/12 - ✔ Network dockerlocalhost_default Created 0.1s - ✔ Volume "dockerlocalhost_store_volume" Created 0.0s - ✔ Volume "dockerlocalhost_import_volume" Created 0.0s - ✔ Volume "dockerlocalhost_postgres_volume" Created 0.0s - ✔ Container dockerlocalhost-store-1 Started 1.0s - ✔ Container dockerlocalhost-apache2-1 Started 1.3s - ✔ Container dockerlocalhost-cmemc-1 Started 1.2s - ✔ Container dockerlocalhost-datamanager-1 Started 1.3s - ✔ Container dockerlocalhost-postgres-1 Healthy 6.6s - ✔ Container dockerlocalhost-keycloak-1 Healthy 47.8s - ✔ Container dockerlocalhost-dataplatform-1 Started 48.3s - ✔ Container dockerlocalhost-dataintegration-1 Started 48.3s -/home/ttelleis/cmem-dist/cmem-orchestration//scripts/waitForSuccessfulStart.dist.sh -Waiting for healthy orchestration.................. done -Remove existing bootstrap data from triple store and import shipped data from DP -chmod a+r conf/cmemc/cmemc.ini -docker compose run -i --rm --env "OAUTH_CLIENT_SECRET=c8c12828-000c-467b-9b6d-2d6b5e16df4a" --volume /home/ttelleis/cmem-dist/cmem-orchestration/data:/data --volume /home/ttelleis/cmem-dist/cmem-orchestration/conf/cmemc/cmemc.ini:/config/cmemc.ini cmemc -c cmem admin store bootstrap --import -Update or import bootstrap data ... done -make[1]: Leaving directory '/home/ttelleis/cmem-dist/cmem-orchestration' - -CMEM-Orchestration successfully started with store graphdb. -Please open http://docker.localhost:80 for validation. -Run make logs to see log output -``` - ### (Optional) Enable Graph Insights Extension If you want to have Graph Insights enabled as well, first you need a license. -Then you can simiply run this: - +Then you can simply run: -``` shell -mkdir licenses +```shell +mkdir -p licenses ln -s your-license-file.lic graphinsights.lic make enable-extension EXTENSION=graphinsights ``` @@ -251,14 +273,14 @@ Open your browser and navigate to  | ------- | -------- | ----------- | | `admin` | `admin` | Is member of the global admin group (can see and do anything) | -After successful login, you will see Corporate Memory interface. You can now proceed to the :arrow_right:[Getting Started](../../../getting-started/index.md) section. +After successful login, you will see the Corporate Memory interface. You can now proceed to the :arrow_right:[Getting Started](../../../getting-started/index.md) section. ### Backup -To create a backup you have to prepare the backup folders. Make sure these folders exists and have write permissions. Run this: +To create a backup you have to prepare the backup folders. Make sure these folders exist and have write permissions: ```shell -# assuming you are currently in the the cmem-orchestration folder +# assuming you are currently in the cmem-orchestration folder mkdir -p data/backups/graphs data/backups/workspace chmod 777 data/backups/graphs data/backups/workspace @@ -292,8 +314,8 @@ The full backup is now at `data/backups/latest.zip`. ### Caveats -In case you have problems starting and receive error messages like Port 80 already assigned. -Then check if a apache2 service is running and remove it. +In case you have problems starting and receive error messages like "Port 80 already assigned", +check if an httpd service (like apache2) is running and stop it. ```shell sudo service apache2 status diff --git a/docs/deploy-and-configure/installation/scenario-single-node-cloud-installation/index.md b/docs/deploy-and-configure/installation/scenario-single-node-cloud-installation/index.md index 967025fbe..fae8e80f9 100644 --- a/docs/deploy-and-configure/installation/scenario-single-node-cloud-installation/index.md +++ b/docs/deploy-and-configure/installation/scenario-single-node-cloud-installation/index.md @@ -13,6 +13,10 @@ This page describes a docker-compose based orchestration running on a server ins - A resolvable domain name to this server - Terminal with ssh client installed locally - An eccenca partner account for the docker registry as well as the release artifact area +- A GraphDB license ([free](https://www.ontotext.com/products/graphdb/) or commercial) + +!!! Info + make - do not use version 4.4.1 [→](https://savannah.gnu.org/bugs/?63650) ## Server Provisioning @@ -28,7 +32,7 @@ sudo timedatectl set-timezone Europe/Berlin # install needed packages sudo apt-get install -y apt-transport-https ca-certificates curl gnupg2 \ software-properties-common gnupg lsb-release gettext zip unzip git \ - make vim jq + make=4.4.0 vim jq # install docker and docker-compose curl -fsSL https://download.docker.com/linux/debian/gpg \ @@ -48,6 +52,21 @@ sudo apt-get install docker-ce docker-ce-cli containerd.io \ ## Installation +Corporate Memory uses Ontotext GraphDB triple store as default backend. +Graphdb is available as free version and does not requires a license. +You need to copy your license for Ontotext GraphDB to the `license` folder inside Corporate Memory's root folder. + +``` shell +# create the License folder within /opt/cmem-orchestration +mkdir -p /opt/cmem-orchestration/licenses +#copy YOUR-LICENSE-FILE +cp YOUR_SE_LICENSE_FILE \ + /opt/cmem-orchestration/licenses/graphdb-se.license +# or +cp YOUR_EE_LICENSE_FILE \ + /opt/cmem-orchestration/licenses/graphdb-ee.license +``` + !!! info For username and password in curl command use the credentials to access eccenca Artifactory and docker registry.