Guides on nplus

Versioning

Mon, 01 Jan 0001 00:00:00 +0000

Versioning#

Since 26.4, the nplus version is independent of the nscale version. All nplus charts — the instance, the environment, the cluster and every component — carry the same nplus version. Which nscale version runs is decided by the values, not by the chart version.

nplus versions#

Channel	Form	Example	Helm
Release	`X.Y.<rev>`	`26.4.1000`, `26.4.1001`	`helm install` / `helm upgrade`
Development	`X.Y.1000-<n>`	`26.4.1000-1`, `26.4.1000-2`	`helm install --devel`

X.Y is the release line. It follows the calendar: 26.4 is the line of 2026. A new line starts when the chart code changes in a way that needs attention on upgrade.
rev counts the releases of a line, starting at 1000. Every published version passed the full test suite.
Development versions are pre-releases of the next release in SemVer terms (26.4.1000-2 < 26.4.1000), so helm install without --devel never picks one up.

Versions before 26.3 followed the nscale Application Layer version (for example 10.2.1002-200). They remain available, but receive no updates. 26.3.200 is exactly the code of beta 200 under the new number: switch to it first, without any change to your deployment, and move on to 26.4 from there.

Quickstart

Mon, 01 Jan 0001 00:00:00 +0000

nplus Quickstart Guide#

The charts are built in a way that they provide minimal functionality without any configuration, using default values.

If you want ingress, you have to configure the domain. Without the domain set, your charts will not have any default way to access them. However, you can still forward traffic to them or configure a NodePort or LoadBalancer manually.
If you want proper TLS, you need a certificate. Without the certificate provided, a self-signed certificate will secure your connection.
If you want specific storage, configure the storage class to use. Without it, you will get the default class for RWO and RWX.

This Quick Start example has nothing configured, so you will get:

Quickstart with Argo CD

Mon, 01 Jan 0001 00:00:00 +0000

This guide extends the Quickstart Guide, so make sure you have completed that before starting with ArgoCD.

Adding ArgoCD#

In order to be able to deploy nplus instances using ArgoCD, you need to add the Chart Repository to Argo:

cat << EOF | kubectl apply -f -
apiVersion: v1
kind: Secret
metadata:
 name: nplus-repo
 namespace: argocd
 labels:
 argocd.argoproj.io/secret-type: repository
stringData:
 type: helm
 url: https://git.42i.org/api/packages/nplus/helm
 password: $NPLUS_TOKEN
 username: $NPLUS_ACCOUNT
EOF

This requires the Environment Variables for the NPLUS_ACCOUNT and NPLUS_TOKEN to be set. Check the Quickstart Guide if you are uncertain

FAQ

Mon, 01 Jan 0001 00:00:00 +0000

Frequently Asked Questions (FAQ)#

How do I add my custom Generic Base App (GBA) to the deployment?#

You can use the application chart to add your GBAs to a deployment. Please follow the instructions in the chart README.

I do not find any of my custom objects (roles, classes, …) from my GBA in the system. Is there an install log file that I can check?#

Yes. You can either check the log of the application job with

Operations

Mon, 01 Jan 0001 00:00:00 +0000

Day 1 Ops: Install, Update, Uninstall#

Install instance sample

To demonstrate, we use the sample-tenant chart we find in the samples directory. The main difference to the default instance chart is, that a domain is set to *.sample.nplus.cloud, so we will be able to log into the web client right away if we redirected this domain correctly.

You can easily adopt the examples to your environment.
```
helm install sample nplus/sample-tenant --version 9.0.1400
```
Rolling update of instance sample to a later monthly release