From b4e6126df762d8c64966cf95b4b1101bfb429805 Mon Sep 17 00:00:00 2001
From: Kostis Trantzas <ktrantzas@ece.upatras.gr>
Date: Tue, 30 Jul 2024 14:51:31 +0300
Subject: [PATCH] fixed notations in CRIDGE documentation #9
---
doc/deploymentCompose.md | 99 ++++++++++++++++++++--------------------
doc/deploymentK8s.md | 1 +
2 files changed, 51 insertions(+), 49 deletions(-)
diff --git a/doc/deploymentCompose.md b/doc/deploymentCompose.md
index 01d1fcfe..a9d6b06b 100644
--- a/doc/deploymentCompose.md
+++ b/doc/deploymentCompose.md
@@ -162,54 +162,7 @@ Bugzilla should have the following components under the specified product:
Also in the 'Main Site Operations' product, a version named 'unspecified' must be created.
-### 5. Configure osportalapi container (NFV services) *(conditional)*
-
-Change the respective fields:
-
-- If you made changes to mysql and keycloak credentials.
-- If you want to change logging level (TRACE / DEBUG / INFO / WARN / ERROR).
-
-> ***If you are using a non-local domain, replace everywhere the http://keycloak:8080 with the respective {{protocol://domain.name}}, as well as "spring.portal.main.domain" property.***
-
-In folder `org.etsi.osl.main/compose/` edit the file `docker-compose.yaml`
-
-```
-SPRING_APPLICATION_JSON: '{
- "spring.datasource.username":"root",
- "spring.datasource.password":"letmein",
- "spring-addons.issuers[0].uri": "http://keycloak:8080/auth/realms/openslice",
- "spring.security.oauth2.resourceserver.jwt.issuer-uri": "http://keycloak:8080/auth/realms/openslice",
- "springdoc.oAuthFlow.authorizationUrl": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/auth",
- "springdoc.oAuthFlow.tokenUrl": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/token",
- "spring.portal.main.domain": "http://localhost",
- "logging.level.org.springframework" : "INFO"
-}'
-```
-
-### 6. Configure osscapi container (TMF API service) *(conditional)*
-
-Change the respective fields:
-
-- If you made changes to mysql and keycloak credentials.
-- If you want to change logging level (TRACE / DEBUG / INFO / WARN / ERROR).
-
-> **If you are using a non-local domain, replace everywhere the http://keycloak:8080 with the respective {{protocol://domain.name}}.**
-
-In folder `org.etsi.osl.main/compose/` edit the file `docker-compose.yaml`
-
-```
-SPRING_APPLICATION_JSON: '{
- "spring.datasource.username":"root",
- "spring.datasource.password":"letmein",
- "spring-addons.issuers[0].uri": "http://keycloak:8080/auth/realms/openslice",
- "spring.security.oauth2.resourceserver.jwt.issuer-uri": "http://keycloak:8080/auth/realms/openslice",
- "springdoc.oAuthFlow.authorizationUrl": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/auth",
- "springdoc.oAuthFlow.tokenUrl": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/token",
- "logging.level.org.springframework" : "INFO"
-}'
-```
-
-### 7. Configure CRIDGE container
+### 5. Configure CRIDGE container *(optional)*
If you want to create and manage Kubernetes Custom Resources (CRs), you will have to provide:
@@ -226,7 +179,7 @@ volumes:
> **The above configuration works for the default kubeconf file names. It explicitly expects a file named `config` within the `/root/.kube` directory of the created container.**
-Optionally, if you want to use custom kubeconf file names you will have to sync volumes by files and not entire directories, e.g.
+Optionally, if you want to use custom kubeconf file names, you will have to sync volumes by files and not entire directories, e.g.
```yaml
volumes:
@@ -234,6 +187,7 @@ volumes:
```
OpenSlice also offers management support of *multiple Kubernetes Clusters* simultaneously. For this, you will have to:
+
- add all the respective kubeconf files into the `org.etsi.osl.main/compose/kubedir` directory.
- create a copy of CRIDGE service in the deployment file and map the appropriate volumes. *Mind the need for a different service and container name*.
@@ -255,6 +209,53 @@ cridge-cluster2:
> Note the same `/root/.kube/config` container's path for the proper functionality. See the above note for explanation.
+### 6. Configure osportalapi container (NFV services) *(conditional)*
+
+Change the respective fields:
+
+- If you made changes to mysql and keycloak credentials.
+- If you want to change logging level (TRACE / DEBUG / INFO / WARN / ERROR).
+
+> ***If you are using a non-local domain, replace everywhere the http://keycloak:8080 with the respective {{protocol://domain.name}}, as well as "spring.portal.main.domain" property.***
+
+In folder `org.etsi.osl.main/compose/` edit the file `docker-compose.yaml`
+
+```
+SPRING_APPLICATION_JSON: '{
+ "spring.datasource.username":"root",
+ "spring.datasource.password":"letmein",
+ "spring-addons.issuers[0].uri": "http://keycloak:8080/auth/realms/openslice",
+ "spring.security.oauth2.resourceserver.jwt.issuer-uri": "http://keycloak:8080/auth/realms/openslice",
+ "springdoc.oAuthFlow.authorizationUrl": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/auth",
+ "springdoc.oAuthFlow.tokenUrl": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/token",
+ "spring.portal.main.domain": "http://localhost",
+ "logging.level.org.springframework" : "INFO"
+}'
+```
+
+### 7. Configure osscapi container (TMF API service) *(conditional)*
+
+Change the respective fields:
+
+- If you made changes to mysql and keycloak credentials.
+- If you want to change logging level (TRACE / DEBUG / INFO / WARN / ERROR).
+
+> ***If you are using a non-local domain, replace everywhere the http://keycloak:8080 with the respective {{protocol://domain.name}}.***
+
+In folder `org.etsi.osl.main/compose/` edit the file `docker-compose.yaml`
+
+```
+SPRING_APPLICATION_JSON: '{
+ "spring.datasource.username":"root",
+ "spring.datasource.password":"letmein",
+ "spring-addons.issuers[0].uri": "http://keycloak:8080/auth/realms/openslice",
+ "spring.security.oauth2.resourceserver.jwt.issuer-uri": "http://keycloak:8080/auth/realms/openslice",
+ "springdoc.oAuthFlow.authorizationUrl": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/auth",
+ "springdoc.oAuthFlow.tokenUrl": "http://keycloak:8080/auth/realms/openslice/protocol/openid-connect/token",
+ "logging.level.org.springframework" : "INFO"
+}'
+```
+
## Configure nginx
diff --git a/doc/deploymentK8s.md b/doc/deploymentK8s.md
index 905956f1..071f8bf9 100644
--- a/doc/deploymentK8s.md
+++ b/doc/deploymentK8s.md
@@ -119,6 +119,7 @@ By default, the deployment process copies the `org.etsi.osl.main/kubernetes/helm
> **The above configuration works for the default kubeconf file names. It explicitly expects a file named `config` within the `org.etsi.osl.main/kubernetes/helm/openslice/files/org.etsi.osl.cridge` directory. If you are working with custom kubeconf file names, you will have to rename them.**
OpenSlice also offers management support of *multiple Kubernetes Clusters* simultaneously. For this, you will have to:
+
- add all the respective kubeconf files into the `org.etsi.osl.main/compose/kubedir` directory.
- create a copy of the `cridge.yaml` and `cridge-config.yaml` in `\org.etsi.osl.main\kubernetes\helm\openslice\templates` directory for every Cluster. *Mind the need for different naming*.
- update every `cridge-config.yaml` file to get the appropriate kubeconf file for every Cluster.
--
GitLab