Skip to content

SFH App Version Definition🔗

Title: SFH App Version Definition
Type object
Required No
Additional properties [Not allowed]
Property Pattern Type Deprecated Definition Title/Description
- appId No number No - INTERNAL PROPERTY. Do not use. The id of the app in the management platform
- appProviderId No number No - INTERNAL PROPERTY. Do not use. The id of the app provider in the management platform
- changelog No string No - INTERNAL PROPERTY. Do not use. A changelog for this AppDefinition
+ containers No array of object No - The list of containers, this app has.
+ definitionVersion No string No - The version of this definition.
- development No object No - DO NOT USE THIS on the SFH Management Platform. Properties to use the appgenerator for intergation test environments.
- metrics No boolean No - If true, Prometheus will scrape the metrics from all container ports, that have the metricsPath property defined.
- name No string No - INTERNAL PROPERTY. Do not use. The name of the app
- semver No string No - INTERNAL PROPERTY. Do not use. The semantic version for this AppDefinition.
- values No array of object No - Configuration values, that are later stored in the values.yaml of the helm chart. This can be used across the app definition. the value sponsorRef ia prefilled dynamically. Use this with the template syntax which is used in helm: e.g. in the environment '{{ .Values.sponsorRef | quote }}'
- volumes No array of object No - -
- workloadAttestation No object No - -

1. Property SFH App Version Definition > appId🔗
Type number
Required No

Description: INTERNAL PROPERTY. Do not use. The id of the app in the management platform

Example: 

1

2. Property SFH App Version Definition > appProviderId🔗
Type number
Required No

Description: INTERNAL PROPERTY. Do not use. The id of the app provider in the management platform

Example: 

1

3. Property SFH App Version Definition > changelog🔗
Type string
Required No

Description: INTERNAL PROPERTY. Do not use. A changelog for this AppDefinition

4. Property SFH App Version Definition > containers🔗
Type array of object
Required Yes

Description: The list of containers, this app has.

Array restrictions
Min items 1
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
containers items -

4.1. SFH App Version Definition > containers > containers items🔗
Type object
Required No
Additional properties [Not allowed]
Property Pattern Type Deprecated Definition Title/Description
- args No array of string No - The arguments for the container execution. Values can be used here e.g. sponsorRef or sfhId
- command No array of string No - Changes the containers entrypoint / command
- environment No array of object No - Environment variables for the container. Values can be used here e.g. sponsorRef or sfhId
+ image No string No - The image name, how it was pushed to the SFH platforms harbor core.harbor.smartfactory.com/fancy-app-name-1/imagename. Can include a subpath (bitnami/nginx)
- livenessProbe No object No In #/$defs/probe A probe exactly the same, as in a Kubernetes PodSpec
- mountWorkloadAttestationPath No boolean No - If true, and if workloadAttestation is active in the app`s global workloadAttestation setting, the
+ name No string No In #/$defs/DNS_LABEL The name for this container. Must be unique in the app
- ports No array of object No - -
- readinessProbe No object No Same as livenessProbe A probe exactly the same, as in a Kubernetes PodSpec
+ resources No object No - The limits and requests for the container. For hints see https://home.robusta.dev/blog/kubernetes-memory-limit/ and https://home.robusta.dev/blog/stop-using-cpu-limits/
- startupProbe No object No Same as livenessProbe A probe exactly the same, as in a Kubernetes PodSpec
+ tag No string No - The image`s tag, how it was pushed to the SFH platforms harbor core.harbor.smartfactory.com/fancy-app-name-1/imagename:tag. Please use versions and not generic tags like latest - although this works too
- volumeMounts No array of object No - -

4.1.1. Property SFH App Version Definition > containers > containers items > args🔗
Type array of string
Required No

Description: The arguments for the container execution. Values can be used here e.g. sponsorRef or sfhId

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
args items the argument. For values use the helm syntax: {{ .Values.sponsorRef }}
4.1.1.1. SFH App Version Definition > containers > containers items > args > args items🔗
Type string
Required No

Description: the argument. For values use the helm syntax: {{ .Values.sponsorRef }}

Examples: 

"-c"

"while true; do curl -m 8 -sS localhost:3001; sleep 10;done"
Restrictions
Must match regular expression ```^[^

"]*$``` Test |

4.1.2. Property SFH App Version Definition > containers > containers items > command🔗
Type array of string
Required No

Description: Changes the containers entrypoint / command

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
command items -
4.1.2.1. SFH App Version Definition > containers > containers items > command > command items🔗
Type string
Required No

Example: 

"/bin/sh"
Restrictions
Must match regular expression ```^[^

"]*$``` Test |

4.1.3. Property SFH App Version Definition > containers > containers items > environment🔗
Type array of object
Required No

Description: Environment variables for the container. Values can be used here e.g. sponsorRef or sfhId

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
environment items -
4.1.3.1. SFH App Version Definition > containers > containers items > environment > environment items🔗
Type object
Required No
Additional properties [Not allowed]
Property Pattern Type Deprecated Definition Title/Description
+ name No string No - the environment variables name
+ value No string No - the environment variables value. For values use the helm syntax: {{ .Values.sponsorRef }}
4.1.3.1.1. Property SFH App Version Definition > containers > containers items > environment > environment items > name🔗
Type string
Required Yes

Description: the environment variables name

Example: 

"EQUI_NO"
Restrictions
Must match regular expression ^([a-zA-Z]\|_[a-zA-Z]){1}[a-zA-Z0-9_]* Test
4.1.3.1.2. Property SFH App Version Definition > containers > containers items > environment > environment items > value🔗
Type string
Required Yes

Description: the environment variables value. For values use the helm syntax: {{ .Values.sponsorRef }}

Example: 

"EQUI_NO"
Restrictions
Must match regular expression ```^[^

"]*$``` Test |

4.1.4. Property SFH App Version Definition > containers > containers items > image🔗
Type string
Required Yes

Description: The image name, how it was pushed to the SFH platforms harbor core.harbor.smartfactory.com/fancy-app-name-1/imagename. Can include a subpath (bitnami/nginx)

Example: 

"nginx"
Restrictions
Must match regular expression ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_./]*[a-zA-Z0-9]{1}$ Test

4.1.5. Property SFH App Version Definition > containers > containers items > livenessProbe🔗
Type object
Required No
Additional properties [Any type: allowed]
Defined in #/$defs/probe

Description: A probe exactly the same, as in a Kubernetes PodSpec

Property Pattern Type Deprecated Definition Title/Description
- exec No object No - -
- failureThreshold No integer No - -
- httpGet No object No - -
- initialDelaySeconds No integer No - -
- periodSeconds No integer No - -
- successThreshold No integer No - -
- tcpSocket No object No - -
- timeoutSeconds No integer No - -
One of(Option)
item 0
item 1
item 2
4.1.5.1. Property SFH App Version Definition > containers > containers items > livenessProbe > oneOf > item 0🔗
Type object
Required No
Additional properties [Any type: allowed]
4.1.5.1.1. The following properties are required🔗
  • exec
4.1.5.2. Property SFH App Version Definition > containers > containers items > livenessProbe > oneOf > item 1🔗
Type object
Required No
Additional properties [Any type: allowed]
4.1.5.2.1. The following properties are required🔗
  • httpGet
4.1.5.3. Property SFH App Version Definition > containers > containers items > livenessProbe > oneOf > item 2🔗
Type object
Required No
Additional properties [Any type: allowed]
4.1.5.3.1. The following properties are required🔗
  • tcpSocket
4.1.5.4. Property SFH App Version Definition > containers > containers items > livenessProbe > exec🔗
Type object
Required No
Additional properties [Any type: allowed]
Property Pattern Type Deprecated Definition Title/Description
- command No array of string No - -
- required No object No - -
4.1.5.4.1. Property SFH App Version Definition > containers > containers items > livenessProbe > exec > command🔗
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
command items -
4.1.5.4.1.1. SFH App Version Definition > containers > containers items > livenessProbe > exec > command > command items🔗
Type string
Required No
4.1.5.4.2. Property SFH App Version Definition > containers > containers items > livenessProbe > exec > required🔗
Type object
Required No
Additional properties [Any type: allowed]
4.1.5.5. Property SFH App Version Definition > containers > containers items > livenessProbe > failureThreshold🔗
Type integer
Required No
Restrictions
Minimum ≥ 1
4.1.5.6. Property SFH App Version Definition > containers > containers items > livenessProbe > httpGet🔗
Type object
Required No
Additional properties [Any type: allowed]
Property Pattern Type Deprecated Definition Title/Description
- host No string No - -
- httpHeaders No array of object No - -
- path No string No - -
- port No Combination No - -
- scheme No string No - -
4.1.5.6.1. Property SFH App Version Definition > containers > containers items > livenessProbe > httpGet > host🔗
Type string
Required No
4.1.5.6.2. Property SFH App Version Definition > containers > containers items > livenessProbe > httpGet > httpHeaders🔗
Type array of object
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
httpHeaders items -
4.1.5.6.2.1. SFH App Version Definition > containers > containers items > livenessProbe > httpGet > httpHeaders > httpHeaders items🔗
Type object
Required No
Additional properties [Any type: allowed]
Property Pattern Type Deprecated Definition Title/Description
- name No string No - -
- value No string No - -
4.1.5.6.2.1.1. Property SFH App Version Definition > containers > containers items > livenessProbe > httpGet > httpHeaders > httpHeaders items > name🔗
Type string
Required No
4.1.5.6.2.1.2. Property SFH App Version Definition > containers > containers items > livenessProbe > httpGet > httpHeaders > httpHeaders items > value🔗
Type string
Required No
4.1.5.6.3. Property SFH App Version Definition > containers > containers items > livenessProbe > httpGet > path🔗
Type string
Required No
4.1.5.6.4. Property SFH App Version Definition > containers > containers items > livenessProbe > httpGet > port🔗
Type combining
Required No
Additional properties [Any type: allowed]
One of(Option)
item 0
item 1
4.1.5.6.4.1. Property SFH App Version Definition > containers > containers items > livenessProbe > httpGet > port > oneOf > item 0🔗
Type integer
Required No
Restrictions
Minimum ≥ 1
4.1.5.6.4.2. Property SFH App Version Definition > containers > containers items > livenessProbe > httpGet > port > oneOf > item 1🔗
Type string
Required No
4.1.5.6.5. Property SFH App Version Definition > containers > containers items > livenessProbe > httpGet > scheme🔗
Type string
Required No
4.1.5.7. Property SFH App Version Definition > containers > containers items > livenessProbe > initialDelaySeconds🔗
Type integer
Required No
Restrictions
Minimum ≥ 1
4.1.5.8. Property SFH App Version Definition > containers > containers items > livenessProbe > periodSeconds🔗
Type integer
Required No
Restrictions
Minimum ≥ 1
4.1.5.9. Property SFH App Version Definition > containers > containers items > livenessProbe > successThreshold🔗
Type integer
Required No
Restrictions
Minimum ≥ 1
4.1.5.10. Property SFH App Version Definition > containers > containers items > livenessProbe > tcpSocket🔗
Type object
Required No
Additional properties [Any type: allowed]
4.1.5.11. Property SFH App Version Definition > containers > containers items > livenessProbe > timeoutSeconds🔗
Type integer
Required No
Restrictions
Minimum ≥ 1

4.1.6. Property SFH App Version Definition > containers > containers items > mountWorkloadAttestationPath🔗
Type boolean
Required No

Description: If true, and if workloadAttestation is active in the app`s global workloadAttestation setting, the

4.1.7. Property SFH App Version Definition > containers > containers items > name🔗
Type string
Required Yes
Defined in #/$defs/DNS_LABEL

Description: The name for this container. Must be unique in the app

Restrictions
Max length 63
Must match regular expression ^[a-z0-9]+(-*[a-z0-9])*$ Test

4.1.8. Property SFH App Version Definition > containers > containers items > ports🔗
Type array of object
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
ports items -
4.1.8.1. SFH App Version Definition > containers > containers items > ports > ports items🔗
Type object
Required No
Additional properties [Not allowed]
Property Pattern Type Deprecated Definition Title/Description
+ containerPort No integer No - The port in the container
- hostPort No integer No - If set, the port is available globally at the SFHs network interface. Be sure, this app uses the host port exclusively
- metricsPath No string No - The path, where to scrape metrics. Can be an empty string or a path starting with a '/'
+ name No string No - The name of the port. Must be unique for the container.
- service No object No - -
4.1.8.1.1. Property SFH App Version Definition > containers > containers items > ports > ports items > containerPort🔗
Type integer
Required Yes

Description: The port in the container

Example: 

80
Restrictions
Minimum ≥ 1
Maximum ≤ 49151
4.1.8.1.2. Property SFH App Version Definition > containers > containers items > ports > ports items > hostPort🔗
Type integer
Required No

Description: If set, the port is available globally at the SFHs network interface. Be sure, this app uses the host port exclusively

Example: 

8080
Restrictions
Minimum ≥ 1
Maximum ≤ 49151
4.1.8.1.3. Property SFH App Version Definition > containers > containers items > ports > ports items > metricsPath🔗
Type string
Required No

Description: The path, where to scrape metrics. Can be an empty string or a path starting with a '/'

Examples: 

"/metrics/path"

""
Restrictions
Must match regular expression (/([A-z0-9\-\%]+/)*[A-z0-9\-\%]+$)? Test
4.1.8.1.4. Property SFH App Version Definition > containers > containers items > ports > ports items > name🔗
Type string
Required Yes

Description: The name of the port. Must be unique for the container.

Examples: 

"api"

"http"
Restrictions
Must match regular expression [a-z0-9]([a-z0-9-]*[a-z0-9])* Test
4.1.8.1.5. Property SFH App Version Definition > containers > containers items > ports > ports items > service🔗
Type object
Required No
Additional properties [Not allowed]
Property Pattern Type Deprecated Definition Title/Description
+ app2appPort No integer No - If set, this port is available to other applications on the SFH. Must be unique for this app. App2App is mandatory for all functions in the service object
- reverseProxy No object No - -
4.1.8.1.5.1. Property SFH App Version Definition > containers > containers items > ports > ports items > service > app2appPort🔗
Type integer
Required Yes

Description: If set, this port is available to other applications on the SFH. Must be unique for this app. App2App is mandatory for all functions in the service object

Example: 

80
Restrictions
Minimum ≥ 1
Maximum ≤ 49151
4.1.8.1.5.2. Property SFH App Version Definition > containers > containers items > ports > ports items > service > reverseProxy🔗
Type object
Required No
Additional properties [Not allowed]
Property Pattern Type Deprecated Definition Title/Description
- authentication No object No - Configures the authentication methods of the reverse proxy
- httpProxy No boolean No - If true, this port is available via HTTP on the SFH`s reverseProxy
- httpsProxy No boolean No - If true, this port is available via HTTPS on the SFH`s reverseProxy
- routerPath No string No - defines the path prefix, which routes to this port on the SFH`s reverseProxy. Is usable with the SFHs DNS name or IP Address
- stripPrefix No boolean No - If true, the routerPath will be stripped from requests by the reverse proxy
- subDomain No string No - defines the subdomain, which routes to this port on the SFH`s reverseProxy. Is usable exclusively with the SFHs DNS name
4.1.8.1.5.2.1. Property SFH App Version Definition > containers > containers items > ports > ports items > service > reverseProxy > authentication🔗
Type object
Required No
Additional properties [Not allowed]

Description: Configures the authentication methods of the reverse proxy

Property Pattern Type Deprecated Definition Title/Description
- verifyClientCertificate No object No - Configures the client certificate based authentication method of the reverse proxy
4.1.8.1.5.2.1.1. Property SFH App Version Definition > containers > containers items > ports > ports items > service > reverseProxy > authentication > verifyClientCertificate🔗
Type object
Required No
Additional properties [Any type: allowed]

Description: Configures the client certificate based authentication method of the reverse proxy

Property Pattern Type Deprecated Definition Title/Description
+ caCertificates No string No - A string with the CA Certificates, the client certificates have to be signed with. Format: Take the CA certificates ("-----BEGIN CERTIFICATE-----..."), concat them, encode everything base64.
+ rejectInvalid No boolean No - A setting for the reverse proxy client authentication. If true, only requests from clients, which can present a valid client certificate signed by a CA mentioned in caCertificates, are passed. If false, every request is passed to the target and only the headers in the request (X-ssl-...) give a hint, if the client was authenticated.
4.1.8.1.5.2.1.1.1. Property SFH App Version Definition > containers > containers items > ports > ports items > service > reverseProxy > authentication > verifyClientCertificate > caCertificates🔗
Type string
Required Yes

Description: A string with the CA Certificates, the client certificates have to be signed with. Format: Take the CA certificates ("-----BEGIN CERTIFICATE-----..."), concat them, encode everything base64.

Example: 

"LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUV0RENDQXB3Q0NRQ0lG..."
Restrictions
Must match regular expression ^[A-Za-z0-9+/=]*$ Test
4.1.8.1.5.2.1.1.2. Property SFH App Version Definition > containers > containers items > ports > ports items > service > reverseProxy > authentication > verifyClientCertificate > rejectInvalid🔗
Type boolean
Required Yes

Description: A setting for the reverse proxy client authentication. If true, only requests from clients, which can present a valid client certificate signed by a CA mentioned in caCertificates, are passed. If false, every request is passed to the target and only the headers in the request (X-ssl-...) give a hint, if the client was authenticated.

4.1.8.1.5.2.2. Property SFH App Version Definition > containers > containers items > ports > ports items > service > reverseProxy > httpProxy🔗
Type boolean
Required No

Description: If true, this port is available via HTTP on the SFH`s reverseProxy

Examples: 

true

false
4.1.8.1.5.2.3. Property SFH App Version Definition > containers > containers items > ports > ports items > service > reverseProxy > httpsProxy🔗
Type boolean
Required No

Description: If true, this port is available via HTTPS on the SFH`s reverseProxy

Examples: 

true

false
4.1.8.1.5.2.4. Property SFH App Version Definition > containers > containers items > ports > ports items > service > reverseProxy > routerPath🔗
Type string
Required No

Description: defines the path prefix, which routes to this port on the SFH`s reverseProxy. Is usable with the SFHs DNS name or IP Address

Example: 

"punchpersistence"
Restrictions
Must match regular expression ^[a-zA-Z0-9][a-zA-Z0-9-_]*(/[a-zA-Z0-9-_]+)*$ Test
4.1.8.1.5.2.5. Property SFH App Version Definition > containers > containers items > ports > ports items > service > reverseProxy > stripPrefix🔗
Type boolean
Required No

Description: If true, the routerPath will be stripped from requests by the reverse proxy

Examples: 

true

false
4.1.8.1.5.2.6. Property SFH App Version Definition > containers > containers items > ports > ports items > service > reverseProxy > subDomain🔗
Type string
Required No

Description: defines the subdomain, which routes to this port on the SFH`s reverseProxy. Is usable exclusively with the SFHs DNS name

Example: 

"punchpersistence"
Restrictions
Max length 63
Must match regular expression ^[a-z](?:[a-z0-9-]*[a-z0-9]+)*$ Test

4.1.9. Property SFH App Version Definition > containers > containers items > readinessProbe🔗
Type object
Required No
Additional properties [Any type: allowed]
Same definition as livenessProbe

Description: A probe exactly the same, as in a Kubernetes PodSpec

4.1.10. Property SFH App Version Definition > containers > containers items > resources🔗
Type object
Required Yes
Additional properties [Any type: allowed]

Description: The limits and requests for the container. For hints see https://home.robusta.dev/blog/kubernetes-memory-limit/ and https://home.robusta.dev/blog/stop-using-cpu-limits/

Property Pattern Type Deprecated Definition Title/Description
+ limits No object No In #/$defs/resourceLimits -
+ requests No object No In #/$defs/resourceRequests -
4.1.10.1. Property SFH App Version Definition > containers > containers items > resources > limits🔗
Type object
Required Yes
Additional properties [Any type: allowed]
Defined in #/$defs/resourceLimits
Property Pattern Type Deprecated Definition Title/Description
- cpu No string No - The max cpu time share your container can get. Can be left empty, if no reason for limiting exists. https://home.robusta.dev/blog/stop-using-cpu-limits/
+ memory No string No - Limited memory as string including its unit.May be equal to requested memory. https://home.robusta.dev/blog/kubernetes-memory-limit/
4.1.10.1.1. Property SFH App Version Definition > containers > containers items > resources > limits > cpu🔗
Type string
Required No

Description: The max cpu time share your container can get. Can be left empty, if no reason for limiting exists. https://home.robusta.dev/blog/stop-using-cpu-limits/

Examples: 

"1000m"

"100m"
Restrictions
Must match regular expression ^([0-9].[0-9]+\|[0-9]+m)$ Test
4.1.10.1.2. Property SFH App Version Definition > containers > containers items > resources > limits > memory🔗
Type string
Required Yes

Description: Limited memory as string including its unit.May be equal to requested memory. https://home.robusta.dev/blog/kubernetes-memory-limit/

Example: 

"128M, 1G"
Restrictions
Must match regular expression ^[0-9]+(E\|P\|T\|G\|M\|k\|Ei\|Pi\|Ti\|Gi\|Mi\|Ki)$ Test
4.1.10.2. Property SFH App Version Definition > containers > containers items > resources > requests🔗
Type object
Required Yes
Additional properties [Any type: allowed]
Defined in #/$defs/resourceRequests
Property Pattern Type Deprecated Definition Title/Description
+ cpu No string No - Requested share of CPU time. The container can get more CPU time, but minimal this time slices requested here are guaranteed. https://home.robusta.dev/blog/stop-using-cpu-limits/
+ memory No string No - Requested memory as string including its unit. May be equal to memory limit. https://home.robusta.dev/blog/kubernetes-memory-limit/
4.1.10.2.1. Property SFH App Version Definition > containers > containers items > resources > requests > cpu🔗
Type string
Required Yes

Description: Requested share of CPU time. The container can get more CPU time, but minimal this time slices requested here are guaranteed. https://home.robusta.dev/blog/stop-using-cpu-limits/

Examples: 

"1000m"

"100m"
Restrictions
Must match regular expression ^([0-9].[0-9]+\|[0-9]+m)$ Test
4.1.10.2.2. Property SFH App Version Definition > containers > containers items > resources > requests > memory🔗
Type string
Required Yes

Description: Requested memory as string including its unit. May be equal to memory limit. https://home.robusta.dev/blog/kubernetes-memory-limit/

Example: 

"128M, 1G"
Restrictions
Must match regular expression ^[0-9]+(E\|P\|T\|G\|M\|k\|Ei\|Pi\|Ti\|Gi\|Mi\|Ki)$ Test

4.1.11. Property SFH App Version Definition > containers > containers items > startupProbe🔗
Type object
Required No
Additional properties [Any type: allowed]
Same definition as livenessProbe

Description: A probe exactly the same, as in a Kubernetes PodSpec

4.1.12. Property SFH App Version Definition > containers > containers items > tag🔗
Type string
Required Yes

Description: The image`s tag, how it was pushed to the SFH platforms harbor core.harbor.smartfactory.com/fancy-app-name-1/imagename:tag. Please use versions and not generic tags like latest - although this works too

Example: 

"1.0.0"
Restrictions
Max length 128
Must match regular expression ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_./]*[a-zA-Z0-9]{1}$ Test

4.1.13. Property SFH App Version Definition > containers > containers items > volumeMounts🔗
Type array of object
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
volumeMounts items -
4.1.13.1. SFH App Version Definition > containers > containers items > volumeMounts > volumeMounts items🔗
Type object
Required No
Additional properties [Not allowed]
Property Pattern Type Deprecated Definition Title/Description
+ mountPath No string No In #/$defs/unix_path -
+ name No string No Same as name The volume's name, as specified in the volumes section of the AppDefinition
- readOnly No boolean No - If true, the volume is mounted read only
- subPath No boolean No Same as mountPath An optional subPath in the volume, which should be mounted
4.1.13.1.1. Property SFH App Version Definition > containers > containers items > volumeMounts > volumeMounts items > mountPath🔗
Type string
Required Yes
Defined in #/$defs/unix_path
Restrictions
Must match regular expression ^[0-9a-zA-Z]*([0-9a-zA-Z-_]*)*(/[0-9a-zA-Z]*([0-9a-zA-Z-_]*)*)*[0-9a-zA-Z]$ Test
4.1.13.1.2. Property SFH App Version Definition > containers > containers items > volumeMounts > volumeMounts items > name🔗
Type string
Required Yes
Same definition as name

Description: The volume's name, as specified in the volumes section of the AppDefinition

4.1.13.1.3. Property SFH App Version Definition > containers > containers items > volumeMounts > volumeMounts items > readOnly🔗
Type boolean
Required No

Description: If true, the volume is mounted read only

4.1.13.1.4. Property SFH App Version Definition > containers > containers items > volumeMounts > volumeMounts items > subPath🔗
Type boolean
Required No
Same definition as mountPath

Description: An optional subPath in the volume, which should be mounted

5. Property SFH App Version Definition > definitionVersion🔗
Type string
Required Yes

Description: The version of this definition.

Example: 

"1.1.0"

6. Property SFH App Version Definition > development🔗
Type object
Required No
Additional properties [Not allowed]

Description: DO NOT USE THIS on the SFH Management Platform. Properties to use the appgenerator for intergation test environments.

Property Pattern Type Deprecated Definition Title/Description
- enabled No boolean No - -
- nodeSelectorDisabled No boolean No - -
- overrideVolumesInValues No boolean No - -

6.1. Property SFH App Version Definition > development > enabled🔗
Type boolean
Required No

6.2. Property SFH App Version Definition > development > nodeSelectorDisabled🔗
Type boolean
Required No

6.3. Property SFH App Version Definition > development > overrideVolumesInValues🔗
Type boolean
Required No

7. Property SFH App Version Definition > metrics🔗
Type boolean
Required No

Description: If true, Prometheus will scrape the metrics from all container ports, that have the metricsPath property defined.

8. Property SFH App Version Definition > name🔗
Type string
Required No

Description: INTERNAL PROPERTY. Do not use. The name of the app

Example: 

"SpecialApp"

9. Property SFH App Version Definition > semver🔗
Type string
Required No

Description: INTERNAL PROPERTY. Do not use. The semantic version for this AppDefinition.

Example: 

"1.0.0"
Restrictions
Min length 5
Max length 64
Must match regular expression ^(0\|[1-9]\d*).(0\|[1-9]\d*).(0\|[1-9]\d*)(?:-((?:0\|[1-9]\d*\|\d*[a-z-][0-9a-z-]*)(?:.(?:0\|[1-9]\d*\|\d*[a-z-][0-9a-z-]*))*))?(?:\+([0-9a-z-]+(?:.[0-9a-z-]+)*))?$ Test

10. Property SFH App Version Definition > values🔗
Type array of object
Required No

Description: Configuration values, that are later stored in the values.yaml of the helm chart. This can be used across the app definition. the value sponsorRef ia prefilled dynamically. Use this with the template syntax which is used in helm: e.g. in the environment '{{ .Values.sponsorRef | quote }}'

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
values items -

10.1. SFH App Version Definition > values > values items🔗
Type object
Required No
Additional properties [Not allowed]
Property Pattern Type Deprecated Definition Title/Description
+ name No string No - -
+ value No string No - -

10.1.1. Property SFH App Version Definition > values > values items > name🔗
Type string
Required Yes
Restrictions
Must match regular expression ^[a-zA-Z]+[a-zA-Z0-9]*$ Test

10.1.2. Property SFH App Version Definition > values > values items > value🔗
Type string
Required Yes
Restrictions
Must match regular expression ```^[^

"]*$``` Test |

11. Property SFH App Version Definition > volumes🔗
Type array of object
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
volumes items A volume, that can be used between the app's containers.

11.1. SFH App Version Definition > volumes > volumes items🔗
Type object
Required No
Additional properties [Not allowed]

Description: A volume, that can be used between the app`s containers.

Property Pattern Type Deprecated Definition Title/Description
- capacity No string No - The maximal capacity of this volume
- configMapData No object No - -
+ name No string No Same as name The name of the volume, as it can be used in container`s volumeMounts
+ type No enum (of string) No - The volume type. Persistent for persistent storage. emptyDir for an oblivious storage, that can be used to share data between containers of the app, but that does not persist

11.1.1. Property SFH App Version Definition > volumes > volumes items > capacity🔗
Type string
Required No

Description: The maximal capacity of this volume

Restrictions
Must match regular expression ^[0-9]+(E\|P\|T\|G\|M\|k\|Ei\|Pi\|Ti\|Gi\|Mi\|Ki)$ Test

11.1.2. Property SFH App Version Definition > volumes > volumes items > configMapData🔗
Type object
Required No
Additional properties [Not allowed]
Property Pattern Type Deprecated Definition Title/Description
- ^[a-zA-Z0-9._-]+$ Yes string No - Einzeilige oder mehrzeilige Werte (mit \n für Zeilenumbruch), wie in Kubernetes ConfigMaps.
11.1.2.1. Pattern Property SFH App Version Definition > volumes > volumes items > configMapData > ^[a-zA-Z0-9._-]+$🔗

All properties whose name matches the regular expression ^[a-zA-Z0-9._-]+$ (Test) must respect the following conditions
Type string
Required No

Description: Einzeilige oder mehrzeilige Werte (mit \n für Zeilenumbruch), wie in Kubernetes ConfigMaps.

11.1.3. Property SFH App Version Definition > volumes > volumes items > name🔗
Type string
Required Yes
Same definition as name

Description: The name of the volume, as it can be used in container`s volumeMounts

11.1.4. Property SFH App Version Definition > volumes > volumes items > type🔗
Type enum (of string)
Required Yes

Description: The volume type. Persistent for persistent storage. emptyDir for an oblivious storage, that can be used to share data between containers of the app, but that does not persist

Must be one of: * "persistent" * "emptyDir" * "configMap"

12. Property SFH App Version Definition > workloadAttestation🔗
Type object
Required No
Additional properties [Not allowed]
Property Pattern Type Deprecated Definition Title/Description
+ enabled No boolean No - Must be true, to use any SPIFFE related features in the app
- incomingProxies No array of object No - -
- outgoingProxies No array of object No - -

12.1. Property SFH App Version Definition > workloadAttestation > enabled🔗
Type boolean
Required Yes

Description: Must be true, to use any SPIFFE related features in the app

12.2. Property SFH App Version Definition > workloadAttestation > incomingProxies🔗
Type array of object
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
incomingProxies items Creates a sidecar which terminates secure app-2-app communication

12.2.1. SFH App Version Definition > workloadAttestation > incomingProxies > incomingProxies items🔗
Type object
Required No
Additional properties [Not allowed]

Description: Creates a sidecar which terminates secure app-2-app communication

Property Pattern Type Deprecated Definition Title/Description
- allowedAppIds No array of number No - If defined, restricts the usage of the proxied service to apps with the listed appIds
+ sidecarApp2AppPort No integer No - The port, under which the sidecar is available for other apps
+ sidecarPort No integer No - The port, the sidecar container listens to
+ targetContainerPort No integer No - The port of the server in the app, the incoming Proxy should upstream to
- tcp No boolean No - -
12.2.1.1. Property SFH App Version Definition > workloadAttestation > incomingProxies > incomingProxies items > allowedAppIds🔗
Type array of number
Required No

Description: If defined, restricts the usage of the proxied service to apps with the listed appIds

Array restrictions
Min items 1
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
allowedAppIds items -
12.2.1.1.1. SFH App Version Definition > workloadAttestation > incomingProxies > incomingProxies items > allowedAppIds > allowedAppIds items🔗
Type number
Required No
12.2.1.2. Property SFH App Version Definition > workloadAttestation > incomingProxies > incomingProxies items > sidecarApp2AppPort🔗
Type integer
Required Yes

Description: The port, under which the sidecar is available for other apps

12.2.1.3. Property SFH App Version Definition > workloadAttestation > incomingProxies > incomingProxies items > sidecarPort🔗
Type integer
Required Yes

Description: The port, the sidecar container listens to

12.2.1.4. Property SFH App Version Definition > workloadAttestation > incomingProxies > incomingProxies items > targetContainerPort🔗
Type integer
Required Yes

Description: The port of the server in the app, the incoming Proxy should upstream to

12.2.1.5. Property SFH App Version Definition > workloadAttestation > incomingProxies > incomingProxies items > tcp🔗
Type boolean
Required No

12.3. Property SFH App Version Definition > workloadAttestation > outgoingProxies🔗
Type array of object
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
outgoingProxies items Creates a sidecar which initiates/ proxies secure app-2-app communication

12.3.1. SFH App Version Definition > workloadAttestation > outgoingProxies > outgoingProxies items🔗
Type object
Required No
Additional properties [Not allowed]

Description: Creates a sidecar which initiates/ proxies secure app-2-app communication

Property Pattern Type Deprecated Definition Title/Description
+ sidecarContainerPort No integer No - The port, the sidecar container listens to. The client in your application container addresses 127.0.0.1:SIDECARCONTAINERPORT
+ targetAddress No string No - The target address of the app, that offers app2pp communication via workloadAttestation proxy
+ targetPort No integer No - The target port of the app, that offers app2pp communication via workloadAttestation proxy
+ targetWorkloadId No string No - The workload id of the app, that offers app2pp communication via workloadAttestation proxy, is normally exactly the same as the targetAddress
- tcp No boolean No - Defaults to false. If true, not http is proxied, but raw tcp sockets are mTLS encapsulated
12.3.1.1. Property SFH App Version Definition > workloadAttestation > outgoingProxies > outgoingProxies items > sidecarContainerPort🔗
Type integer
Required Yes

Description: The port, the sidecar container listens to. The client in your application container addresses 127.0.0.1:SIDECARCONTAINERPORT

12.3.1.2. Property SFH App Version Definition > workloadAttestation > outgoingProxies > outgoingProxies items > targetAddress🔗
Type string
Required Yes

Description: The target address of the app, that offers app2pp communication via workloadAttestation proxy

Example: 

"inquisitive-gray-hyena-21"
Restrictions
Must match regular expression ```^[^

"]*$``` Test |

12.3.1.3. Property SFH App Version Definition > workloadAttestation > outgoingProxies > outgoingProxies items > targetPort🔗
Type integer
Required Yes

Description: The target port of the app, that offers app2pp communication via workloadAttestation proxy

12.3.1.4. Property SFH App Version Definition > workloadAttestation > outgoingProxies > outgoingProxies items > targetWorkloadId🔗
Type string
Required Yes

Description: The workload id of the app, that offers app2pp communication via workloadAttestation proxy, is normally exactly the same as the targetAddress

Restrictions
Must match regular expression ```^[^

"]*$``` Test |

12.3.1.5. Property SFH App Version Definition > workloadAttestation > outgoingProxies > outgoingProxies items > tcp🔗
Type boolean
Required No

Description: Defaults to false. If true, not http is proxied, but raw tcp sockets are mTLS encapsulated

Generated using json-schema-for-humans on 2026-03-04 at 09:53:35 +0100