Skip to content

Latest commit

 

History

History
57 lines (35 loc) · 4.51 KB

objects_ingress.md

File metadata and controls

57 lines (35 loc) · 4.51 KB
Raw

Creating Ingresses

The HULL Ingress object offers some comfort features for specifying ingress objects.

JSON Schema Elements

The hull.Ingress.v1 properties

Properties can be set as they are defined in the Kubernetes API's ingressspec spec.

However the properties listed below are overwritten or added by HULL:

Parameter Description Default Example
rules Dictionary with hull.Ingress.Rule.v1 values to add to the ingresses rules section.

Key:
Unique related to parent element.

Value:
The hull.Ingress.Rule.v1 properties of the ingress. See below for reference.		 {}
tls Dictionary with hull.IngressTls.v1 values to add to the ingresses tls section.

Key:
Unique related to parent element.

Value:
The hull.IngressTls.v1 properties of the ingress. See below for reference.		 {}

The hull.Ingress.Rule.v1 properties

The key-value pairs of value type hull.Ingress.Rule.v1 are converted to an array on rendering

Properties can be set as they are defined in the Kubernetes API's ingressrule spec.

However the properties listed below are overwritten or added by HULL:

Parameter Description Default Example
enabled Needs to resolve to a boolean switch, it can be a boolean input directly or a transformation that resolves to a boolean value. If resolved to true or missing, the key-value-pair will be rendered for deployment. If resolved to false, it will be omitted from rendering. This way you can predefine objects which are only enabled and created in the cluster in certain environments when needed. true true
false

"_HULL_TRANSFORMATION_<<<NAME=hull.util.transformation.tpl>>><<<CONTENT=
  {{ (index . \"PARENT\").Values.hull.config.specific.enable_addon }}>>>"
http.paths Dictionary with hull.Ingress.Rule.Path.v1 values to add to the http.paths section.

Key:
Unique related to parent element.

Value:
The hull.Ingress.Rule.Path.v1 properties of the container. See below for reference.		 {}

The hull.Ingress.Rule.Path.v1 properties

The key-value pairs of value type hull.Ingress.Rule.v1 are converted to an array on rendering

Properties can be set as they are defined in the Kubernetes API's httpingresspath spec.

However the properties listed below are overwritten or added by HULL:

Parameter Description Default Example
enabled Needs to resolve to a boolean switch, it can be a boolean input directly or a transformation that resolves to a boolean value. If resolved to true or missing, the key-value-pair will be rendered for deployment. If resolved to false, it will be omitted from rendering. This way you can predefine objects which are only enabled and created in the cluster in certain environments when needed. true

The hull.Ingress.Tls.v1 properties

The key-value pairs of value type hull.Ingress.Tls.v1 are converted to an array on rendering

Properties can be set as they are defined in the Kubernetes API's ingresstls spec.

However the properties listed below are overwritten or added by HULL:

Parameter Description Default Example
enabled Needs to resolve to a boolean switch, it can be a boolean input directly or a transformation that resolves to a boolean value. If resolved to true or missing, the key-value-pair will be rendered for deployment. If resolved to false, it will be omitted from rendering. This way you can predefine objects which are only enabled and created in the cluster in certain environments when needed. true
staticName Specifies whether the secretName key of this tls refers to a fixed name of a Secret in the cluster or not.
If the field does not exist or is set to false, the name field of this secretName references a key defined in this helm chart.		 false true

Back to README.md