sheppy/opendesk
1
0
Fork 0
mirror of https://gitlab.opencode.de/bmi/opendesk/deployment/opendesk.git synced 2025-12-06 07:21:36 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat(ci): Support for MASTER_PASSWORD to be set on Gitlab Settings > CI/CD > Variables

Browse Source
This commit is contained in:
Thorsten Rossner
2023-07-21 09:19:02 +00:00
parent cc5f88cbaf
commit e7d68ea78e
3 changed files with 57 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
.gitlab-ci.yml
View File

@@ -30,9 +30,9 @@ variables:
- "souvap-univention.de" - "souvap-univention.de"
- "at-univention.de" - "at-univention.de"
- "souvap.cloud" - "souvap.cloud"
MASTER_PASSWORD: MASTER_PASSWORD_WEB_VAR:
description: "Optional: Provide a passphrase to be used for password generation." description: "Optional: Provide a passphrase to be used for password generation."
value: "sovereign-workplace" value: ""
ENV_STOP_BEFORE: ENV_STOP_BEFORE:
description: "Stop environment/delete namespace for the deployment" description: "Stop environment/delete namespace for the deployment"
value: "no" value: "no"
@@ -138,8 +138,8 @@ variables:
file: false file: false
script: script:
- cd "${CI_PROJECT_DIR}/helmfile/apps/${COMPONENT}" - cd "${CI_PROJECT_DIR}/helmfile/apps/${COMPONENT}"
# Match Cluster to helmfile environments
- | - |
# Match Cluster to helmfile environments
if [ "${CLUSTER}" = "develop" ]; then if [ "${CLUSTER}" = "develop" ]; then
export HELMFILE_ENVIRONMENT=uv-develop export HELMFILE_ENVIRONMENT=uv-develop
elif [ "${CLUSTER}" = "prototype" ]; then elif [ "${CLUSTER}" = "prototype" ]; then
@@ -152,6 +152,10 @@ variables:
echo "Unsupported cluster chosen: ${CLUSTER}" echo "Unsupported cluster chosen: ${CLUSTER}"
exit 1 exit 1
fi; fi;
# MASTER_PASSWORD_WEB_VAR as precedence for MASTER_PASSWORD
if ! [ -z "${MASTER_PASSWORD_WEB_VAR}" ]; then
export MASTER_PASSWORD="${MASTER_PASSWORD_WEB_VAR}"
fi;
- echo "Installing ${COMPONENT} into ${NAMESPACE} namespace as ${HELMFILE_ENVIRONMENT} environment on ${CLUSTER}" - echo "Installing ${COMPONENT} into ${NAMESPACE} namespace as ${HELMFILE_ENVIRONMENT} environment on ${CLUSTER}"
- helmfile --namespace ${NAMESPACE} apply --suppress-diff - helmfile --namespace ${NAMESPACE} apply --suppress-diff
tags: tags:

14
LICENSE Normal file
View File

@@ -0,0 +1,14 @@
Copyright (C) 2023 Bundesministerium des Innern und für Heimat,
PG ZenDiS "Projektgruppe für Aufbau ZenDiS"
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

60
README.md
View File

@@ -10,11 +10,13 @@ SPDX-License-Identifier: Apache-2.0
The current state of the SWP is missing two components that are not yet generally available to the public also The current state of the SWP is missing two components that are not yet generally available to the public also
outside the SWP (Element Starter Edition and Open-Xchange App Suite 8), and contains components that will be replaced outside the SWP (Element Starter Edition and Open-Xchange App Suite 8), and contains components that will be replaced
(e.g. UCS container monolith to be replaced by multiple Univention Management Stack containers). (e.g. UCS dev container monolith to be replaced by multiple Univention Management Stack containers).
In the next months we not only expect upstream updates of the functional components within their feature scope but we In the next months we not only expect upstream updates of the functional components within their feature scope but we
are going to address operational issues like monitoring and network policies. are going to address operational issues like monitoring and network policies.
Of course we will extend the documentation and would love to get [feedback from you](https://gitlab.opencode.de/bmi/souveraener_arbeitsplatz/info/-/blob/main/OVERVIEW.md#mitwirkung-und-beteiligung) regarding the areas you require more details on. But be sure also without that feedback the documentation will grow. Of course we will also extend the documentation.
In any case we love to get [feedback from you](https://gitlab.opencode.de/bmi/souveraener_arbeitsplatz/info/-/blob/main/OVERVIEW.md#mitwirkung-und-beteiligung) regarding the documentation as well as your experience with the deployment and the SWP itself.
The first release of the SWP is scheduled for December 2023. The first release of the SWP is scheduled for December 2023.
@@ -92,10 +94,19 @@ All of these requirements are optional as long as you do not want to make use of
The project includes a `.gitlab-ci.yml` that allows you to execute the deployment from a Gitlab instance of your choice. The project includes a `.gitlab-ci.yml` that allows you to execute the deployment from a Gitlab instance of your choice.
Please ensure you provide the variables listed in the `Required input variables` section. When starting the CI through Please ensure you provide the variables listed in the `Required input variables` section.
the Gitlab UI you will be queried for some of the variables, but the variable `ISTIO_DOMAIN` will be derived
automatically by prefixing `DOMAIN` with `istio.`. Other variables you are not asked for when triggering the CI you may When starting the CI through the Gitlab UI you will be queried for some of the variables and in addition for
want to set in the projects `Settings` > `CI/CD` > `Variables`.
- `NAMESPACE`: Defines into which namespace of your K8s cluster the SWP will be installed
- `MASTER_PASSWORD_WEB_VAR`: Overwrite value of `MASTER_PASSWORD`
Based on your input the following variables will be set:
- `DOMAIN` = `NAMESPACE`.`DOMAIN`
- `ISTIO_DOMAIN` = istio.`DOMAIN`
- `MASTER_PASSWORD` = `MASTER_PASSWORD_WEB_VAR` if that is not given `MASTER_PASSWORD` will be used, that could be set as masked CI variable in Gitlab or as a fallback the default value of `MASTER_PASSWORD`.
You might want to set password / credential variables in the projects `Settings` > `CI/CD` > `Variables`.
### Local ### Local
@@ -190,25 +201,26 @@ In case you don't got for a develop or evaluation environment you want to point
#### Scaling #### Scaling
Replicas for scalable components can be increased. Replicas for components can be increased, while we still have to look in the actual scalability of the
components (see column `Scales at least to 2`).
| Component | Name | Default | Service | Scaling | | Component | Name | Default | Service | Scaling | Scales at least to 2 |
|-------------|------------------------|---------|--------------------|--------------------| |-------------|------------------------|---------|--------------------|--------------------|----------------------|
| ClamAV | `replicas.clamd` | `1` | :white_check_mark: | :white_check_mark: | | ClamAV | `replicas.clamd` | `1` | :white_check_mark: | :white_check_mark: | not tested |
| | `replicas.freshclam` | `1` | :white_check_mark: | :x: | | | `replicas.freshclam` | `1` | :white_check_mark: | :x: | not tested |
| | `replicas.icap` | `1` | :white_check_mark: | :white_check_mark: | | | `replicas.icap` | `1` | :white_check_mark: | :white_check_mark: | not tested |
| | `replicas.milter` | `1` | :white_check_mark: | :white_check_mark: | | | `replicas.milter` | `1` | :white_check_mark: | :white_check_mark: | not tested |
| Collabora | `replicas.collabora` | `1` | :white_check_mark: | :white_check_mark: | | Collabora | `replicas.collabora` | `1` | :white_check_mark: | :white_check_mark: | not tested |
| Dovecot | `replicas.dovecot` | `1` | :white_check_mark: | :x: | | Dovecot | `replicas.dovecot` | `1` | :white_check_mark: | :x: | not tested |
| Jitsi | `replicas.jibri` | `1` | :white_check_mark: | :white_check_mark: | | Jitsi | `replicas.jibri` | `1` | :white_check_mark: | :white_check_mark: | not tested |
| | `replicas.jicofo` | `1` | :white_check_mark: | :white_check_mark: | | | `replicas.jicofo` | `1` | :white_check_mark: | :white_check_mark: | not tested |
| | `replicas.jitsi ` | `1` | :white_check_mark: | :white_check_mark: | | | `replicas.jitsi ` | `1` | :white_check_mark: | :white_check_mark: | not tested |
| | `replicas.jvb ` | `1` | :white_check_mark: | :white_check_mark: | | | `replicas.jvb ` | `1` | :white_check_mark: | :white_check_mark: | tested |
| Keycloak | `replicas.keycloak` | `1` | :white_check_mark: | :white_check_mark: | | Keycloak | `replicas.keycloak` | `1` | :white_check_mark: | :white_check_mark: | not tested |
| Nextcloud | `replicas.nextcloud` | `1` | :white_check_mark: | :white_check_mark: | | Nextcloud | `replicas.nextcloud` | `1` | :white_check_mark: | :white_check_mark: | not tested |
| OpenProject | `replicas.openproject` | `1` | :white_check_mark: | :white_check_mark: | | OpenProject | `replicas.openproject` | `1` | :white_check_mark: | :white_check_mark: | not tested |
| Postfix | `replicas.postfix` | `1` | :white_check_mark: | :x: | | Postfix | `replicas.postfix` | `1` | :white_check_mark: | :x: | not tested |
| XWiki | `replicas.xwiki` | `1` | :white_check_mark: | :white_check_mark: | | XWiki | `replicas.xwiki` | `1` | :white_check_mark: | :white_check_mark: | not tested |
## Identity data flows ## Identity data flows