Skip to content

Commit 108266a

Browse files
author
Sebastian Plott
committed
first adjustmens and cleanups for the deployments
1 parent c5cc670 commit 108266a

File tree

3 files changed

+158
-132
lines changed
  • docs/deploy-and-configure/installation

3 files changed

+158
-132
lines changed

‎docs/deploy-and-configure/installation/scenario-k8s-deployment/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ provisioned cluster.
1717
## Requirements
1818

1919
- Access credentials for the eccenca infrastructre (e.g. Docker Registry) → [contact us to get yours](https://eccenca.com/en/contact)
20-
- A license for [GraphDB](https://www.ontotext.com/products/graphdb/)
20+
- A GraphDB license ([free](https://www.ontotext.com/products/graphdb/) or commercial)
2121
- [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/)
2222
- [Helm](https://helm.sh/docs/intro/install/)
2323
- If deploying on K3D, download a [static binary](https://github.com/k3d-io/k3d/releases)

‎docs/deploy-and-configure/installation/scenario-local-installation/index.md‎

Lines changed: 156 additions & 131 deletions
Original file line numberDiff line numberDiff line change
@@ -15,108 +15,189 @@ The code examples in this section assumes that you have POSIX-compliant shell (l
1515
- [docker](https://www.docker.com/) and [docker compose](https://docs.docker.com/compose/install/) (v2) installed locally
1616
- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) installed locally
1717
- [jq](https://jqlang.github.io/jq/download/) installed locally
18-
- A GraphDB license (free or commercial)
18+
- A GraphDB license ([free](https://www.ontotext.com/products/graphdb/) or commercial)
1919
- (optional) A Graph Insights license
20-
- make - build tools (apt-get install make) installed locally
20+
- make - build tools (apt-get install make) installed locally (don't use version 4.4.1)
2121
- At least 4 CPUs and 12GB of RAM (recommended: 16GB) dedicated to docker
2222

23-
## WSL installation and configuration
23+
## Setup & Check Installation Environment
2424

25-
For all you need to start Powershell started as administrator.
26-
Alternatively you can also install a WSL distribution from Microsoft Store.
25+
Install the requirements
2726

28-
Install WSL, then restart your Windows machine.
27+
=== "Linux"
28+
29+
Install all the needed packages:
2930

30-
```shell
31-
wsl --install
32-
```
31+
```shell
32+
sudo apt-get install -y curl gnupg2 \
33+
gnupg lsb-release gettext zip unzip git \
34+
make=4.3-4.1 vim jq
35+
```
36+
To install Corporate Memory, you need to modify your local hosts file (located in /etc/hosts), minimal configuration is as follows:
3337

34-
List available distributions
38+
```shell
39+
##
40+
# Host Database
41+
#
42+
# localhost is used to configure the loopback interface
43+
# when the system is booting. Do not change this entry.
44+
##
45+
127.0.0.1 localhost
46+
127.0.0.1 docker.localhost
47+
```
3548

36-
```shell
37-
wsl --list --online
38-
```
49+
=== "macOS"
3950

40-
Install a distribution.
41-
Chose from the `Name` column.
42-
Here we use a Debian based distribution like Debian or any Ubuntu.
43-
However other Distributions might work as well.
51+
Install homebrew:
4452

45-
```shell
46-
wsl --install Debian
47-
```
53+
```shell
54+
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
55+
```
4856

49-
Ensure you use WSL version 2 (this is necessary to use `systemd` services).
57+
Install all needed packages:
5058

51-
```shell
52-
wsl -l -v
53-
```
59+
```shell
60+
brew install curl gnupg2 \
61+
gnupg lsb-release gettext zip unzip git \
62+
vim jq
63+
```
64+
To install Corporate Memory, you need to modify your local hosts file (located in /etc/hosts), minimal configuration is as follows:
5465

55-
Install version 2 components (this requires a windows restart)
66+
```shell
67+
##
68+
# Host Database
69+
#
70+
# localhost is used to configure the loopback interface
71+
# when the system is booting. Do not change this entry.
72+
##
73+
127.0.0.1 localhost
74+
127.0.0.1 docker.localhost
75+
```
5676

57-
```shell
58-
dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart
59-
```
77+
=== "WSL"
6078

61-
Enter WSL machine
79+
For all you need to start Powershell started as administrator.
80+
Alternatively you can also install a WSL distribution from Microsoft Store.
6281

63-
```shell
64-
wsl -d Debian
65-
```
82+
Install WSL, then restart your Windows machine.
6683

67-
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.
84+
```shell
85+
wsl --install
86+
```
6887

69-
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):
88+
List available distributions
7089

71-
```shell
72-
[boot]
73-
systemd=true
74-
```
90+
```shell
91+
wsl --list --online
92+
```
7593

76-
(Optional) If you need to restart your WSL use in Powershell:
94+
Install a distribution.
95+
Chose from the `Name` column.
96+
Here we use a Debian based distribution like Debian or any Ubuntu.
97+
However other Distributions might work as well.
7798

78-
```shell
79-
wsl --shutdown
80-
```
99+
```shell
100+
wsl --install Debian
101+
```
81102

82-
(Optional) you can create a `.wslconfig` file under `C:\users\<your username>` to specify some system resources like:
103+
Ensure you use WSL version 2 (this is necessary to use `systemd` services).
83104

84-
```shell
85-
[wsl2]
86-
memory=16GB # restrict ram WSL can use
87-
processors=4 # restrict cpu-cores
88-
swap=8GB # set swap size
89-
swapFile=C:/Users/<your username>/wsl/Debianswap.vhdx # location to swap-file
90-
```
105+
```shell
106+
wsl -l -v
107+
```
91108

92-
Alternatively, (with WSL v2) you may use the graphical configuration application _WSL Settings_.
109+
Install version 2 components (this requires a windows restart)
93110

94-
## Setup & Check Installation Environment
111+
```shell
112+
dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart
113+
```
95114

96-
For docker we recommend to use the linux docker within WSL.
97-
Follow the instruction in [Server Provisioning in Scenario: Single Node Cloud Installation](../scenario-single-node-cloud-installation/index.md#server-provisioning).
98-
Alternatively, you may use docker for desktop and enable WSL integration in the settings.
115+
Enter WSL machine
99116

100-
Open a terminal window, create a directory, copy and extract docker orchestration there.
117+
```shell
118+
wsl -d Debian
119+
```
101120

102-
```shell
103-
# Create eccenca-corporate-memory directory in your ${HOME} and set as a
104-
# working dir.
105-
sudo apt install -y curl jq make git unzip gpg
106-
107-
mkdir ${HOME}/eccenca-corporate-memory && cd ${HOME}/eccenca-corporate-memory
108-
109-
# download the Corporate Memory orchestration distribution
110-
curl https://releases.eccenca.com/docker-orchestration/latest.zip \
111-
> cmem-orchestration.zip
112-
113-
# unzip the orchestration and move the unzipped directory
114-
unzip cmem-orchestration.zip
115-
rm cmem-orchestration.zip
116-
mv cmem-orchestration-v* cmem-orchestration
117-
cd cmem-orchestration
118-
git init && git add . && git commit -m "stub"
119-
```
121+
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.
122+
123+
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):
124+
125+
```shell
126+
[boot]
127+
systemd=true
128+
```
129+
130+
(Optional) If you need to restart your WSL use in Powershell:
131+
132+
```shell
133+
wsl --shutdown
134+
```
135+
136+
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:
137+
!!! Warning
138+
This requires administration rights.
139+
140+
```shell
141+
##
142+
# Host Database
143+
#
144+
# localhost is used to configure the loopback interface
145+
# when the system is booting. Do not change this entry.
146+
##
147+
127.0.0.1 localhost
148+
127.0.0.1 docker.localhost
149+
```
150+
151+
(Optional) you can create a `.wslconfig` file under `C:\users\<your username>` to specify some system resources like:
152+
153+
```shell
154+
[wsl2]
155+
memory=16GB # restrict ram WSL can use
156+
processors=4 # restrict cpu-cores
157+
swap=8GB # set swap size
158+
swapFile=C:/Users/<your username>/wsl/Debianswap.vhdx # location to swap-file
159+
```
160+
161+
Alternatively, (with WSL v2) you may use the graphical configuration application _WSL Settings_.
162+
163+
For docker we recommend to use the linux docker within WSL.
164+
Alternatively, you may use docker for desktop and enable WSL integration in the settings.
165+
166+
---
167+
168+
169+
170+
=== "install via .zip file"
171+
Open a terminal window, create a directory, copy and extract docker orchestration there.
172+
173+
```shell
174+
# Create eccenca-corporate-memory directory in your ${HOME} and set as a
175+
# working dir.
176+
177+
mkdir ${HOME}/eccenca-corporate-memory && cd ${HOME}/eccenca-corporate-memory
178+
179+
# download the Corporate Memory orchestration distribution
180+
curl https://releases.eccenca.com/docker-orchestration/latest.zip \
181+
> cmem-orchestration.zip
182+
183+
# unzip the orchestration and move the unzipped directory
184+
unzip cmem-orchestration.zip
185+
rm cmem-orchestration.zip
186+
mv cmem-orchestration-v* cmem-orchestration
187+
cd cmem-orchestration
188+
git init && git add . && git commit -m "stub"
189+
```
190+
191+
=== "install via gitlab.eccenca.com"
192+
193+
If you have access to gitlab.eccenca.com we recommend to clone our repository
194+
and follow the README.
195+
196+
```shell
197+
git clone ssh://[email protected]:8101/elds/cmem-orchestration.git
198+
```
199+
200+
---
120201

121202
Check your local environment:
122203

@@ -144,22 +225,9 @@ docker login docker-registry.eccenca.com
144225

145226
## Installation
146227

147-
To install Corporate Memory, you need to modify your local hosts file (located in /etc/hosts), minimal configuration is as follows:
148-
149-
```shell
150-
##
151-
# Host Database
152-
#
153-
# localhost is used to configure the loopback interface
154-
# when the system is booting. Do not change this entry.
155-
##
156-
127.0.0.1 localhost
157-
127.0.0.1 docker.localhost
158-
```
159-
160228
Corporate Memory uses Ontotext GraphDB triple store as default backend.
161229
Graphdb is available as free version and does not requires a license.
162-
If you have a license for Ontotext GraphDB you can copy the file to the `license` folder inside Corporate Memory's root folder.
230+
You need to copy your license for Ontotext GraphDB to the `license` folder inside Corporate Memory's root folder.
163231

164232
```shell
165233
cp YOUR_SE_LICENSE_FILE \
@@ -185,49 +253,6 @@ Run the command to clean workspace, pull the images, start the Corporate Memory
185253
make clean-pull-start-bootstrap
186254
```
187255

188-
You should see the output as follows:
189-
190-
```shell
191-
make[1]: Entering directory '/home/ttelleis/cmem-dist/cmem-orchestration'
192-
The target cleans up everything and esp. REMOVES ALL YOUR DATA. Do you want to continue?
193-
194-
You can avoid this question / interruption by setting CO_I_KNOW_WHAT_I_DO to true.
195-
Type '1' for Yes or type '2' for No.
196-
197-
1) Yes
198-
2) No
199-
#? 1
200-
make check-env kill stop down rm-log-dir
201-
make[2]: Entering directory '/home/ttelleis/cmem-dist/cmem-orchestration'
202-
/usr/bin/docker compose kill
203-
no container to kill/usr/bin/docker compose stop
204-
/usr/bin/docker compose down --volumes --remove-orphans || exit 0
205-
/usr/bin/docker compose up -d
206-
[+] Running 12/12
207-
✔ Network dockerlocalhost_default Created 0.1s
208-
✔ Volume "dockerlocalhost_store_volume" Created 0.0s
209-
✔ Volume "dockerlocalhost_import_volume" Created 0.0s
210-
✔ Volume "dockerlocalhost_postgres_volume" Created 0.0s
211-
✔ Container dockerlocalhost-store-1 Started 1.0s
212-
✔ Container dockerlocalhost-apache2-1 Started 1.3s
213-
✔ Container dockerlocalhost-cmemc-1 Started 1.2s
214-
✔ Container dockerlocalhost-datamanager-1 Started 1.3s
215-
✔ Container dockerlocalhost-postgres-1 Healthy 6.6s
216-
✔ Container dockerlocalhost-keycloak-1 Healthy 47.8s
217-
✔ Container dockerlocalhost-dataplatform-1 Started 48.3s
218-
✔ Container dockerlocalhost-dataintegration-1 Started 48.3s
219-
/home/ttelleis/cmem-dist/cmem-orchestration//scripts/waitForSuccessfulStart.dist.sh
220-
Waiting for healthy orchestration.................. done
221-
Remove existing bootstrap data from triple store and import shipped data from DP
222-
chmod a+r conf/cmemc/cmemc.ini
223-
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
224-
Update or import bootstrap data ... done
225-
make[1]: Leaving directory '/home/ttelleis/cmem-dist/cmem-orchestration'
226-
227-
CMEM-Orchestration successfully started with store graphdb.
228-
Please open http://docker.localhost:80 for validation.
229-
Run make logs to see log output
230-
```
231256

232257
### (Optional) Enable Graph Insights Extension
233258

‎docs/deploy-and-configure/installation/scenario-single-node-cloud-installation/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ This page describes a docker-compose based orchestration running on a server ins
1313
- A resolvable domain name to this server
1414
- Terminal with ssh client installed locally
1515
- An eccenca partner account for the docker registry as well as the release artifact area
16+
- A GraphDB license ([free](https://www.ontotext.com/products/graphdb/) or commercial)
1617

1718
## Server Provisioning
1819

0 commit comments

Comments
 (0)