...

Check the requirements and recommendations of third-party software in order to set up a productive yuuvis® Momentum system.
>> yuuvis® Momentum Requirements

Installation

Clone the yuuvis-api-helm-charts repository as working directory (see Version Tags Services).

Add your credentials for the docker.yuuvis.org registry in the values.yaml files of the Helm Charts. Replace all changeme default passwords in the values.yaml of the charts you plan to use.

...

• Add the required Helm repositories:

  Code Block
  language bash
  helm repo add minio https://helm.min.io/ helm repo add bitnami https://charts.bitnami.com/bitnami helm repo add gitea-charts https://dl.gitea.io/charts/

  
  

• Update the Infrastructure dependencies:

  Code Block
  language bash
  cd infrastructure helm dep up helm repo add stable https://charts.helm.sh/stable cd ..

  
  

• Adjust the values.yaml file:

  • Adjust docker registry credentials.
  • Specify the address of your yuuvis® Momentum cluster by setting your CLUSTER_IP or your AUTHENTICATION service's LOAD_BALANCER_IP for the parameter yuuvis.authentication.ip.
  • Optionally change passwords.
  • Optionally change the used storage classes.

• Install the infrastructure services. Naming the chart during installation is necessary as each service would otherwise receive a default prefix from Kubernetes, making it difficult for the yuuvis® Momentum services to interact with them later. This also enables us to rollback our installation.

  Code Block
  language bash
  kubectl create namespace infrastructure helm install infrastructure ./infrastructure --namespace infrastructure

  
  

• Wait until the jobs are done.

  Code Block
  language bash
  kubectl get jobs -n infrastructure

  There are two jobs preparing the git server and the Keycloak environment that need to be completed.

  Code Block
  language bash
  NAME COMPLETIONS DURATION AGE gogsrepo-init 1/1 83s 8m4s keycloak-create-selfsigned-cert 1/1 8m4s 8m4s

  
  

• Run the following command to see if the infrastructure chart was deployed (STATUS DEPLOYED).

  Code Block
  language bash
  helm list --namespace infrastructure

  
  

...

• Adjust the values.yaml file:

  • Adjust docker registry credentials.
  • If you are using Keycloak as identity provider, specify its address by setting your CLUSTER_IP or your Keycloak's LOAD_BALANCER_IP for the parameter yuuvis.keycloak.ip.
• Navigate to the root Helm Chart directory within the cloned repository.

• Install the Helm Chart. Again, naming our chart prevents randomization of service identifiers and gives us the ability to rollback all associated services.

  Code Block
  language bash
  kubectl create namespace yuuvis helm install yuuvis ./yuuvis --namespace yuuvis

  
  

• Wait for the pods to be ready:

  Code Block
  language bash
  kubectl get po -n yuuvis

  
  

...

Postman is a free API development tool with a multitude of useful functions for automated testing, documentation, and more. Our yuuvis® Postman Collections kick-start you right into the yuuvis® API world.
>> yuuvis® Postman Collections

Anchor
update update

Version Updates

• Update resource files in Git according to the Update Instructions 2022 SummerWinter LTS or Update Instructions 2021 - 2022 Winter LTS.

• All Helm Charts except the infrastructure chart can be updated to a new version via:

  Code Block
  language bash
  helm upgrade -n <namespace> <chart name> <chart location>

  For the concrete individual charts this means:

  Code Block
  language bash
  helm upgrade -n yuuvis yuuvis yuuvis helm upgrade -n yuuvis bpm bpm helm upgrade -n yuuvis client client helm upgrade -n yuuvis management management helm upgrade -n yuuvis rendition rendition

  
  

• The third-party infrastructure components have to be updated via individual docker images:
  • Use our current Docker image for Elasticsearch as it includes the required plug-ins.
  • Optionally, use our Keycloak Docker image.
  • Updates for all further third-party components are within the customer's responsibility.

...