public/nplus
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
0bd2038c86a6dee3270856c2c1e2dc6a9c6cdee9
nplus/charts/rms/README.md
Andreas Ahmann 0bd2038c86 Public Information
2025-01-24 16:18:47 +01:00

23 KiB
Raw Blame History

nplus-component-rms

nplus Remote Management Server incl. RMS and Access Proxy

Generelle Informationen

Das RMS Chart simuliert einen Server, auf dem alle nscale Komponenten installiert sind. Dieser kann dann per nscale Administrator zugegriffen werden. Der Ingress dafür ist admin..

Das funktioniert nur mit RMS 2 und einem neuen Admin ab Version 9.2

Bash into

kubectl exec --stdin --tty rms-rms-0 -- bash

Logs

kubectl logs rms-rms-0 -c proxy
kubectl logs rms-rms-0 -c rms

nplus-component-rms Chart Configuration

You can customize / configure nplus-component-rms by setting configuration values on the command line or in values files, that you can pass to helm. Please see the samples directory for details.

In case there is no value set, the key will not be used in the manifest, resulting in values taken from the config files of the component.

Template Functions

You can use template functions in the values files. If you do so, make sure you quote correctly (single quotes, if you have double quotes in the template, or escaped quotes).

Global Values

All values can be set per component, per instance or globally per environment.

Example: global.ingress.domain sets the domain on instance level. You can still set a different domain on a component, such as administrator. In that case, simply set ingress.domain for the administrator chart and that setting will have priority:

  • Prio 1 - Component Level: ingress.domain
  • Prio 2 - Instance Level: global.ingress.domain
  • Prio 3 - Environment Level: global.environment.ingress.domain

Using Values in Templates

As it would be a lot of typing to write .Values.ingress.domain | default .Values.global.ingress.domain | default .Values.global.environment.ingress.domainin your template code, this is automatically done by nplus. You can simply type .this.ingress.domain and you will get a condensed and defaulted version of your Values.

So an example in your values.yaml would be:

administrator:
  waitFor:
    - '-service {{ .component.prefix }}nappljobs.{{ .Release.Namespace }}.svc.cluster.local:\{{ .this.nappl.port }} -timeout 600'

This example shows .this.nappl.port which might come from a component, instance or global setting. You do not need to care. The .Release.Namespace is set by helm. You have access to all Release and Chart Metadata, just like in your chart code.

The .component.prefix is calculated by nplus and gives you some handy shortcuts to internal variables:

  • .component.chartName The name of the chart as in .Chart.Name, but with override by .Values.nameOverride

  • .component.shortChartName A shorter Version of the name - nappl instead of nplus-component-nappl

  • .component.prefix The instance Prefix used to name the resources including -. This prefix is dropped, if the .Release.Name equals .Release.Namespace for those of you that only run one nplus Instance per namespace

  • .component.name The name of the component, including .Values.nameOverride and some logic

  • .component.fullName The fullName inlcuding .Values.fullnameOverride and some logic

  • .component.chart Mainly the Chart.Name and Chart.Version

  • .component.storagePath The path where the component config is stored in the conf PVC

  • .component.handler The handler (either helm, argoCD or manual)

  • .instance.name The name of the instance, but with override by .Values.instanceOverride

  • .instance.group The group, this instance belongs to. Override by .Values.groupOverride

  • .instance.version The nscale version (mostly taken from Application Layer), this instance is deploying.

  • .environment.name The name of the environment, but with override by .Values.environmentNameOverride

Keys

You can set any of the following values for this component:

Key Description Default
comps​.cmis​.displayName The displayName name of the component as it appears in the RMS Server Properties
do not change		 info only, do not change
"CMIS Connector"
comps​.cmis​.enabled Toggles if this component should be available through RMS false
comps​.cmis​.host The host, where this component runs "{{ .component.prefix }}cmis.{{ .Release.Namespace }}.svc.cluster.local"
comps​.cmis​.name The internal name of the component
do not change		 info only, do not change
"cmis"
comps​.cmis​.ports​.http proxied port
do not change		 info only, do not change
8096
comps​.cmis​.ports​.https proxied port
do not change		 info only, do not change
8196
comps​.cmis​.replicaSetType The type of the replicaSet - important for the kubectl command
do not change		 info only, do not change
"Deployment"
comps​.cmis​.restartReplicas The amount of replicas to set when starting through the nscale Administrator client 1
comps​.ilm​.displayName The displayName name of the component as it appears in the RMS Server Properties
do not change		 info only, do not change
"SAP ILM Connector"
comps​.ilm​.enabled Toggles if this component should be available through RMS false
comps​.ilm​.host The host, where this component runs "{{ .component.prefix }}ilm.{{ .Release.Namespace }}.svc.cluster.local"
comps​.ilm​.name The internal name of the component
do not change		 info only, do not change
"ilm"
comps​.ilm​.ports​.http proxied port
do not change		 info only, do not change
8297
comps​.ilm​.ports​.https proxied port
do not change		 info only, do not change
8397
comps​.ilm​.replicaSetType The type of the replicaSet - important for the kubectl command
do not change		 info only, do not change
"Deployment"
comps​.ilm​.restartReplicas The amount of replicas to set when starting through the nscale Administrator client 1
comps​.mon​.displayName The displayName name of the component as it appears in the RMS Server Properties
do not change		 info only, do not change
"Monitoring Console"
comps​.mon​.enabled Toggles if this component should be available through RMS false
comps​.mon​.host The host, where this component runs "{{ .component.prefix }}mon.{{ .Release.Namespace }}.svc.cluster.local"
comps​.mon​.name The internal name of the component
do not change		 info only, do not change
"mon"
comps​.mon​.ports​.http proxied port
do not change		 info only, do not change
8387
comps​.mon​.ports​.https proxied port
do not change		 info only, do not change
8388
comps​.mon​.ports​.tcp proxied port
do not change		 info only, do not change
8389
comps​.mon​.replicaSetType The type of the replicaSet - important for the kubectl command
do not change		 info only, do not change
"StatefulSet"
comps​.mon​.restartReplicas The amount of replicas to set when starting through the nscale Administrator client 1
comps​.nappl​.displayName The displayName name of the component as it appears in the RMS Server Properties
do not change		 info only, do not change
"Application Layer"
comps​.nappl​.enabled Toggles if this component should be available through RMS false
comps​.nappl​.host The host, where this component runs "{{ .component.prefix }}nappl.{{ .Release.Namespace }}.svc.cluster.local"
comps​.nappl​.name The internal name of the component
do not change		 info only, do not change
"nappl"
comps​.nappl​.ports​.http proxied port
do not change		 info only, do not change
8080
comps​.nappl​.ports​.https proxied port
do not change		 info only, do not change
8443
comps​.nappl​.replicaSetType The type of the replicaSet - important for the kubectl command
do not change		 info only, do not change
"StatefulSet"
comps​.nappl​.restartReplicas The amount of replicas to set when starting through the nscale Administrator client 1
comps​.nstl​.displayName The displayName name of the component as it appears in the RMS Server Properties
do not change		 info only, do not change
"Storage Layer"
comps​.nstl​.enabled Toggles if this component should be available through RMS false
comps​.nstl​.host The host, where this component runs "{{ .component.prefix }}nstl.{{ .Release.Namespace }}.svc.cluster.local"
comps​.nstl​.name The internal name of the component
do not change		 info only, do not change
"nstl"
comps​.nstl​.ports​.tcp proxied port
do not change		 info only, do not change
3005
comps​.nstl​.ports​.tcps proxied port
do not change		 info only, do not change
3006
comps​.nstl​.replicaSetType The type of the replicaSet - important for the kubectl command
do not change		 info only, do not change
"StatefulSet"
comps​.nstl​.restartReplicas The amount of replicas to set when starting through the nscale Administrator client 1
comps​.pipeliner​.displayName The displayName name of the component as it appears in the RMS Server Properties
do not change		 info only, do not change
"Pipeliner"
comps​.pipeliner​.enabled Toggles if this component should be available through RMS false
comps​.pipeliner​.host The host, where this component runs "{{ .component.prefix }}pipeliner.{{ .Release.Namespace }}.svc.cluster.local"
comps​.pipeliner​.name The internal name of the component
do not change		 info only, do not change
"pipeliner"
comps​.pipeliner​.ports​.tcp proxied port
do not change		 info only, do not change
4173
comps​.pipeliner​.replicaSetType The type of the replicaSet - important for the kubectl command
do not change		 info only, do not change
"StatefulSet"
comps​.pipeliner​.restartReplicas The amount of replicas to set when starting through the nscale Administrator client 1
comps​.rs​.displayName The displayName name of the component as it appears in the RMS Server Properties
do not change		 info only, do not change
"Rendition Server"
comps​.rs​.enabled Toggles if this component should be available through RMS false
comps​.rs​.host The host, where this component runs "{{ .component.prefix }}rs.{{ .Release.Namespace }}.svc.cluster.local"
comps​.rs​.name The internal name of the component
do not change		 info only, do not change
"rs"
comps​.rs​.ports​.http proxied port
do not change		 info only, do not change
8192
comps​.rs​.ports​.https proxied port
do not change		 info only, do not change
8193
comps​.rs​.replicaSetType The type of the replicaSet - important for the kubectl command
do not change		 info only, do not change
"Deployment"
comps​.rs​.restartReplicas The amount of replicas to set when starting through the nscale Administrator client 1
comps​.web​.displayName The displayName name of the component as it appears in the RMS Server Properties
do not change		 info only, do not change
"Application Layer Web"
comps​.web​.enabled Toggles if this component should be available through RMS false
comps​.web​.host The host, where this component runs "{{ .component.prefix }}web.{{ .Release.Namespace }}.svc.cluster.local"
comps​.web​.name The internal name of the component
do not change		 info only, do not change
"web"
comps​.web​.ports​.http proxied port
do not change		 info only, do not change
8090
comps​.web​.ports​.https proxied port
do not change		 info only, do not change
8453
comps​.web​.replicaSetType The type of the replicaSet - important for the kubectl command
do not change		 info only, do not change
"Deployment"
comps​.web​.restartReplicas The amount of replicas to set when starting through the nscale Administrator client 1
env Sets additional environment variables for the configuration.
envMap Sets the name of a configMap, which holds additional environment variables for the configuration. It is added as envFrom configMap to the container.
envSecret Sets the name of a secret, which holds additional environment variables for the configuration. It is added as envFrom secretRef to the container.
fullnameOverride This overrides the output of the internal fullname function
image​.name the name of the image to use "admin-server"
image​.pullSecrets you can provide your own pullSecrets, in case you use a private repo. ["nscale-cr", "nplus-cr"]
image​.repo if you use a private repo, feel free to set it here "git.nplus.cloud/subscription"
image​.tag the tag of the image to use "latest"
meta​.language Sets the language of the main service (in the service container). This is used for instance if you turn OpenTelemetry on, to know which Agent to inject into the container.
meta​.provider sets provider (partner, reseller) information to be able to invoice per use in a cloud environment
meta​.serviceContainer The container name of the main service for this component. This is used to define where to inject the telemetry agents, if any
meta​.stage A optional parameter to indicate the stage (DEV, QA, PROD, ...) this component, instance or environment runs in. This can be used in template functions to add the stage to for instance the service name of telemetry services like open telemetry. (see telemetry example)
meta​.tenant sets tenant information to be able to invoice per use in a cloud environment
meta​.type the type of the component. You should not change this value, except if you use a pipeliner in core mode. In core mode, it should be core, else pipeliner This type is used to create cluster communication for nappl and nstl and potentially group multiple replicaSets into one service. "rms"
meta​.wave Sets the wave in which this component should be deployed within an ArgoCD deployment if unset, it uses the default wave thus all components are installed in one wave, then relying on correct wait settings just like in a helm installation
minReplicaCountType if you set minReplicaCountType, a podDesruptionBudget will be created with this value as minAvailable, using the component type as selector. This is useful for components, that are spread across multiple replicaSets, like sharepoint or storage layer
mounts​.caCerts​.configMap Alternative 2: the name of the configMap to use. The Key has to be the File Name used in the path setting
mounts​.caCerts​.secret Alternative 1: the name of the secret to use. The Key has to be the File Name used in the path setting
mounts​.componentCerts​.configMap Alternative 2: the name of the configMap to use. The Key has to be the File Name used in the path setting
mounts​.componentCerts​.secret Alternative 1: the name of the secret to use. The Key has to be the File Name used in the path setting
mounts​.data​.class Sets the class of the data disk
mounts​.data​.size Sets the size of the data disk
mounts​.data​.volumeName If you do not want to have a Volume created by the provisioner, you can set the name of your volume here to attach to this pre-existing one
mounts​.disk​.class Sets the class of the disk
mounts​.disk​.enabled enables the use of the second data disk. If enabled, all paths defined will end up on this disk. In case of the (default) disabled, the paths will be added to the primaty data disk. false
mounts​.disk​.migration Enables the migration init container. This will copy the data in paths from the primary data disk to the newly enabled secondary disk. This is done only once and only if there is legacy data at all. No files are overwritten! false
mounts​.disk​.size Sets the size of the disk
mounts​.disk​.volumeName If you do not want to have a Volume created by the provisioner, you can set the name of your volume here to attach to this pre-existing one
mounts​.file​.class Sets the class of the shared disk
mounts​.file​.size Sets the size of the shared disk
mounts​.file​.volumeName If you do not want to have a Volume created by the provisioner, you can set the name of your volume here to attach to this pre-existing one
mounts​.generic Allows to define generic mounts of pre-provisioned PVs into any container. This can be used e.g. to mount migration nfs, cifs / samba shares into a pipeliner container.
mounts​.logs​.medium the medium for the emptyDisk volume if you unset it, it drops it from the manifest
mounts​.logs​.path Sets the path to the log files
do not change this value		 info only, do not change
"/opt/ceyoniq/nscale-rms/log"
mounts​.logs​.size Sets the size of the log disk (all paths) "1Gi"
mounts​.temp​.paths Sets a list of paths to the temporary files
do not change this value		 info only, do not change
["/opt/ceyoniq/nscale-rms/tmp"]
mounts​.temp​.size Sets the size of the temporary disk (all paths) "100Mi"
nameOverride This overrides the output of the internal name function
nodeSelector select specific nodes for this component
security​.cni​.adminIpRange defines the IP Range of out-of-cluster Administrator Workplaces that are allowed to access the RMS Server.
security​.containerSecurityContext​.allowPrivilegeEscalation Some functionality may need the possibility to allow privilege escalation. This should be very restrictive
you should not change this		 info only, do not change
false
security​.containerSecurityContext​.readOnlyRootFilesystem sets the container root file system to read only. This should be the case in production environment
you should not change this		 info only, do not change
true
security​.podSecurityContext​.fsGroup The file system group as which new files are created
there is normally no need to change this		 info only, do not change
1001
security​.podSecurityContext​.fsGroupChangePolicy Under which condition should the fsGroup be changed
there is normally no need to change this		 info only, do not change
"OnRootMismatch"
security​.podSecurityContext​.runAsUser The user under which the container ist run. Avoid 0 / root. The container should run in a non-root context for security
there is normally no need to change this		 info only, do not change
1001
security​.zeroTrust turns on Zero Trust Mode, disabling all http communication, even the internal http probes false
service​.annotations adds extra Annotations to the service
service​.enabled enables the service to be consumed by group components and a potential ingress Disabling the service also disables the ingress. true
service​.selector The selector can be component or type component selects only pods that are in the replicaset. type selects any pod that has the given type "component"
telemetry​.openTelemetry turns Open Telemetry on
telemetry​.serviceName Sets the service name for the telemetry service to more convenient identify the displayed component Example: "{{ .this.meta.type }}-{{ .instance.name }}"
terminationGracePeriodSeconds Sets the terminationGracePeriodSeconds for the component If not set, it uses the Kubernetes defaults
timezone set the time zone for this component to make sure log output has a specific timestamp, internal dates and times are correct (like the creationDate in nappl) etc. Europe/Berlin
tolerations Set tolerations for this component
utils​.debug Turn debugging on will give you stack trace etc. Please check out the Chart Developer Guide false
utils​.disableWait in case you use the argoCD Wave feature, you might think about switching off the waitFor mechanism, that makes sure PODs are only started after pre-requisites are fulfilled. You can disable the starndard wait mechanism, but at your own risk, as this might start components even if they are not intended to run yet. false
utils​.disableWave If you use argoCD, you most likely want to use the argo Wave Feature as well, making sure the components of an instance are deployed ordered. However, in DEV you might want to disable this to allow live changing components while previous waves are not finished yet. false
utils​.includeNamespace By default, the namespace is rendered into the manifest. However, if you want to use helm template and store manifests for later applying them to multiple namespaces, you might want to turn this false to be able to use kubectl apply -n <namespace> -f template.yaml later true
utils​.maintenance in Maintenance Mode, all waitFor actions will be skipped, the Health Checks are ignored and the pods will start in idle, not starting the service at all. This will allow you to gain access to the container to perform recovery and maintenance tasks while having the real container up. false
utils​.renderComments You can turn Comment rendering on to get descriptive information inside the manifests. It will also fail on depricated functions and keys, so it is recommended to only switch it off in PROD true