From 709e0618ad7e7e9ea542cb05f70213c719d2849a Mon Sep 17 00:00:00 2001 From: Thorsten Hans Date: Mon, 18 Mar 2024 12:30:53 +0100 Subject: [PATCH] feat: Add CRD reference docs This commit adds reference docs for CRDs provided by Spin Operator. Reference documentation is generated based on CRDs published as part of the spin-operator release. Signed-off-by: Thorsten Hans --- .github/workflows/deploy.yaml | 8 + .../en/docs/spin-operator/reference/_index.md | 7 + .../reference/spin-app-executor.md | 122 + .../docs/spin-operator/reference/spin-app.md | 5168 +++++++++++++++++ crd-reference/.gitignore | 2 + crd-reference/generate.sh | 33 + crd-reference/spin-app-executor-toc.yaml | 10 + crd-reference/spin-app-toc.yaml | 9 + crd-reference/spin-operator.tmpl | 97 + package.json | 3 +- 10 files changed, 5458 insertions(+), 1 deletion(-) create mode 100644 content/en/docs/spin-operator/reference/_index.md create mode 100644 content/en/docs/spin-operator/reference/spin-app-executor.md create mode 100644 content/en/docs/spin-operator/reference/spin-app.md create mode 100644 crd-reference/.gitignore create mode 100755 crd-reference/generate.sh create mode 100644 crd-reference/spin-app-executor-toc.yaml create mode 100644 crd-reference/spin-app-toc.yaml create mode 100644 crd-reference/spin-operator.tmpl diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml index 43e41ff..d06d048 100644 --- a/.github/workflows/deploy.yaml +++ b/.github/workflows/deploy.yaml @@ -19,6 +19,7 @@ concurrency: env: CANONICAL_DOMAIN: www.spinkube.dev + SPIN_OPERATOR_RELEASE: v0.1.0 jobs: # TODO: place into separate build.yaml (and add PR support?) and then call here? @@ -42,6 +43,13 @@ jobs: - name: Install Node.js dependencies run: npm install + - name: Generate CRD reference docs + run: ./generate.sh + with: + path: ./crd-reference + env: + SPIN_OPERATOR_RELEASE: ${{ env.SPIN_OPERATOR_RELEASE }} + - name: Build run: | hugo \ diff --git a/content/en/docs/spin-operator/reference/_index.md b/content/en/docs/spin-operator/reference/_index.md new file mode 100644 index 0000000..be5ce5f --- /dev/null +++ b/content/en/docs/spin-operator/reference/_index.md @@ -0,0 +1,7 @@ +--- +title: Reference +description: Reference documentation for Custom Resource Definitions (CRDs) +weight: 3 +categories: [Spin Operator] +tags: [reference] +--- \ No newline at end of file diff --git a/content/en/docs/spin-operator/reference/spin-app-executor.md b/content/en/docs/spin-operator/reference/spin-app-executor.md new file mode 100644 index 0000000..2255536 --- /dev/null +++ b/content/en/docs/spin-operator/reference/spin-app-executor.md @@ -0,0 +1,122 @@ +--- +title: SpinAppExecutor CRD Reference +weight: 1 +description: Custom Resource Definition (CRD) reference for `SpinAppExecutor` +categories: [Spin Operator] +tags: [reference] +--- +Resource Types: + +- [SpinAppExecutor](#spinappexecutor) + +## SpinAppExecutor + +SpinAppExecutor is the Schema for the spinappexecutors API + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
apiVersionstringcore.spinoperator.dev/v1alpha1true
kindstringSpinAppExecutortrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobject + SpinAppExecutorSpec defines the desired state of SpinAppExecutor
+ 		false
statusobject + SpinAppExecutorStatus defines the observed state of SpinAppExecutor
+ 		false
+ + +### `SpinAppExecutor.spec` +[back to parent](#spinappexecutor) + + +SpinAppExecutorSpec defines the desired state of SpinAppExecutor + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
createDeploymentboolean + CreateDeployment specifies whether the Executor wants the SpinKube operator +to create a deployment for the application or if it will be realized externally.
+ 		true
deploymentConfigobject + DeploymentConfig specifies how the deployment should be configured when +createDeployment is true.
+ 		false
+ + +### `SpinAppExecutor.spec.deploymentConfig` +[back to parent](#spinappexecutorspec) + + +DeploymentConfig specifies how the deployment should be configured when +createDeployment is true. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
runtimeClassNamestring + RuntimeClassName is the runtime class name that should be used by pods created +as part of a deployment.
+ 		true
+ + diff --git a/content/en/docs/spin-operator/reference/spin-app.md b/content/en/docs/spin-operator/reference/spin-app.md new file mode 100644 index 0000000..e3510b5 --- /dev/null +++ b/content/en/docs/spin-operator/reference/spin-app.md @@ -0,0 +1,5168 @@ +--- +title: SpinApp CRD Reference +weight: 1 +description: Custom Resource Definition (CRD) reference for `SpinApp` +categories: [Spin Operator] +tags: [reference] +--- +Resource Types: + +- [SpinApp](#spinapp) + +## SpinApp + +SpinApp is the Schema for the spinapps API + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
apiVersionstringcore.spinoperator.dev/v1alpha1true
kindstringSpinApptrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobject + SpinAppSpec defines the desired state of SpinApp
+ 		false
statusobject + SpinAppStatus defines the observed state of SpinApp
+ 		false
+ + +### `SpinApp.spec` +[back to parent](#spinapp) + + +SpinAppSpec defines the desired state of SpinApp + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
executorstring + Executor controls how this app is executed in the cluster. + + +Defaults to whatever executor is available on the cluster. If multiple +executors are available then the first executor in alphabetical order +will be chosen. If no executors are available then no default will be set.
+ 		true
imagestring + Image is the source for this app.
+ 		true
checksobject + Checks defines health checks that should be used by Kubernetes to monitor the application.
+ 		false
deploymentAnnotationsmap[string]string + DeploymentAnnotations defines annotations to be applied to the underlying deployment.
+ 		false
enableAutoscalingboolean + EnableAutoscaling indicates whether the app is allowed to autoscale. If +true then the operator leaves the replica count of the underlying +deployment to be managed by an external autoscaler (HPA/KEDA). Replicas +cannot be defined if this is enabled. By default EnableAutoscaling is false.
+
+ Default: false
+ 		false
imagePullSecrets[]object + ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling the image.
+ 		false
podAnnotationsmap[string]string + PodAnnotations defines annotations to be applied to the underlying pods.
+ 		false
replicasinteger + Number of replicas to run.
+
+ Format: int32
+ 		false
resourcesobject + Resources defines the resource requirements for this app.
+ 		false
runtimeConfigobject + RuntimeConfig defines configuration to be applied at runtime for this app.
+ 		false
serviceAnnotationsmap[string]string + ServiceAnnotations defines annotations to be applied to the underlying service.
+ 		false
variables[]object + Variables provide Kubernetes Bindings to Spin App Variables.
+ 		false
volumeMounts[]object + VolumeMounts defines how volumes are mounted in the underlying containers.
+ 		false
volumes[]object + Volumes defines the volumes to be mounted in the underlying pods.
+ 		false
+ + +### `SpinApp.spec.checks` +[back to parent](#spinappspec) + + +Checks defines health checks that should be used by Kubernetes to monitor the application. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
livenessobject + Liveness defines the liveness probe for the application.
+ 		false
readinessobject + Readiness defines the readiness probe for the application.
+ 		false
+ + +### `SpinApp.spec.checks.liveness` +[back to parent](#spinappspecchecks) + + +Liveness defines the liveness probe for the application. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
failureThresholdinteger + Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1.
+
+ Format: int32
+ Default: 3
+ 		false
httpGetobject + HTTPGet describes a health check that should be performed using a GET request.
+ 		false
initialDelaySecondsinteger + Number of seconds after the app has started before liveness probes are initiated. +Default 10s.
+
+ Format: int32
+ Default: 10
+ 		false
periodSecondsinteger + How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1.
+
+ Format: int32
+ Default: 10
+ 		false
successThresholdinteger + Minimum consecutive successes for the probe to be considered successful after having failed. +Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+
+ Format: int32
+ Default: 1
+ 		false
timeoutSecondsinteger + Number of seconds after which the probe times out. +Defaults to 1 second. Minimum value is 1.
+
+ Format: int32
+ Default: 1
+ 		false
+ + +### `SpinApp.spec.checks.liveness.httpGet` +[back to parent](#spinappspecchecksliveness) + + +HTTPGet describes a health check that should be performed using a GET request. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + Path is the path that should be used when calling the application for a +health check, e.g /healthz.
+ 		true
httpHeaders[]object + HTTPHeaders are headers that should be included in the health check request.
+ 		false
+ + +### `SpinApp.spec.checks.liveness.httpGet.httpHeaders[index]` +[back to parent](#spinappspeccheckslivenesshttpget) + + +HTTPHealthProbeHeader is an abstraction around a http header key/value pair. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring +
+ 		true
valuestring +
+ 		true
+ + +### `SpinApp.spec.checks.readiness` +[back to parent](#spinappspecchecks) + + +Readiness defines the readiness probe for the application. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
failureThresholdinteger + Minimum consecutive failures for the probe to be considered failed after having succeeded. +Defaults to 3. Minimum value is 1.
+
+ Format: int32
+ Default: 3
+ 		false
httpGetobject + HTTPGet describes a health check that should be performed using a GET request.
+ 		false
initialDelaySecondsinteger + Number of seconds after the app has started before liveness probes are initiated. +Default 10s.
+
+ Format: int32
+ Default: 10
+ 		false
periodSecondsinteger + How often (in seconds) to perform the probe. +Default to 10 seconds. Minimum value is 1.
+
+ Format: int32
+ Default: 10
+ 		false
successThresholdinteger + Minimum consecutive successes for the probe to be considered successful after having failed. +Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
+
+ Format: int32
+ Default: 1
+ 		false
timeoutSecondsinteger + Number of seconds after which the probe times out. +Defaults to 1 second. Minimum value is 1.
+
+ Format: int32
+ Default: 1
+ 		false
+ + +### `SpinApp.spec.checks.readiness.httpGet` +[back to parent](#spinappspecchecksreadiness) + + +HTTPGet describes a health check that should be performed using a GET request. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + Path is the path that should be used when calling the application for a +health check, e.g /healthz.
+ 		true
httpHeaders[]object + HTTPHeaders are headers that should be included in the health check request.
+ 		false
+ + +### `SpinApp.spec.checks.readiness.httpGet.httpHeaders[index]` +[back to parent](#spinappspecchecksreadinesshttpget) + + +HTTPHealthProbeHeader is an abstraction around a http header key/value pair. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring +
+ 		true
valuestring +
+ 		true
+ + +### `SpinApp.spec.imagePullSecrets[index]` +[back to parent](#spinappspec) + + +LocalObjectReference contains enough information to let you locate the +referenced object inside the same namespace. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid?
+ 		false
+ + +### `SpinApp.spec.resources` +[back to parent](#spinappspec) + + +Resources defines the resource requirements for this app. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
limitsmap[string]int or string + Limits describes the maximum amount of compute resources allowed.
+ 		false
requestsmap[string]int or string + Requests describes the minimum amount of compute resources required. +If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, +otherwise to an implementation-defined value. Requests cannot exceed Limits.
+ 		false
+ + +### `SpinApp.spec.runtimeConfig` +[back to parent](#spinappspec) + + +RuntimeConfig defines configuration to be applied at runtime for this app. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keyValueStores[]object +
+ 		false
llmComputeobject +
+ 		false
loadFromSecretstring + LoadFromSecret is the name of the secret to load runtime config from. The +secret should have a single key named "runtime-config.toml" that contains +the base64 encoded runtime config. If this is provided all other runtime +config is ignored.
+ 		false
sqliteDatabases[]object + SqliteDatabases provides spin bindings to different SQLite database providers. +e.g on-disk or turso.
+ 		false
+ + +### `SpinApp.spec.runtimeConfig.keyValueStores[index]` +[back to parent](#spinappspecruntimeconfig) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring +
+ 		true
typestring +
+ 		true
options[]object +
+ 		false
+ + +### `SpinApp.spec.runtimeConfig.keyValueStores[index].options[index]` +[back to parent](#spinappspecruntimeconfigkeyvaluestoresindex) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the config option.
+ 		true
valuestring + Value is the static value to bind to the variable.
+ 		false
valueFromobject + ValueFrom is a reference to dynamically bind the variable to.
+ 		false
+ + +### `SpinApp.spec.runtimeConfig.keyValueStores[index].options[index].valueFrom` +[back to parent](#spinappspecruntimeconfigkeyvaluestoresindexoptionsindex) + + +ValueFrom is a reference to dynamically bind the variable to. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
secretKeyRefobject + Selects a key of a secret in the apps namespace
+ 		false
+ + +### `SpinApp.spec.runtimeConfig.keyValueStores[index].options[index].valueFrom.configMapKeyRef` +[back to parent](#spinappspecruntimeconfigkeyvaluestoresindexoptionsindexvaluefrom) + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid?
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### `SpinApp.spec.runtimeConfig.keyValueStores[index].options[index].valueFrom.secretKeyRef` +[back to parent](#spinappspecruntimeconfigkeyvaluestoresindexoptionsindexvaluefrom) + + +Selects a key of a secret in the apps namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid?
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### `SpinApp.spec.runtimeConfig.llmCompute` +[back to parent](#spinappspecruntimeconfig) + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
typestring +
+ 		true
options[]object +
+ 		false
+ + +### `SpinApp.spec.runtimeConfig.llmCompute.options[index]` +[back to parent](#spinappspecruntimeconfigllmcompute) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the config option.
+ 		true
valuestring + Value is the static value to bind to the variable.
+ 		false
valueFromobject + ValueFrom is a reference to dynamically bind the variable to.
+ 		false
+ + +### `SpinApp.spec.runtimeConfig.llmCompute.options[index].valueFrom` +[back to parent](#spinappspecruntimeconfigllmcomputeoptionsindex) + + +ValueFrom is a reference to dynamically bind the variable to. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
secretKeyRefobject + Selects a key of a secret in the apps namespace
+ 		false
+ + +### `SpinApp.spec.runtimeConfig.llmCompute.options[index].valueFrom.configMapKeyRef` +[back to parent](#spinappspecruntimeconfigllmcomputeoptionsindexvaluefrom) + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid?
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### `SpinApp.spec.runtimeConfig.llmCompute.options[index].valueFrom.secretKeyRef` +[back to parent](#spinappspecruntimeconfigllmcomputeoptionsindexvaluefrom) + + +Selects a key of a secret in the apps namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid?
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### `SpinApp.spec.runtimeConfig.sqliteDatabases[index]` +[back to parent](#spinappspecruntimeconfig) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring +
+ 		true
typestring +
+ 		true
options[]object +
+ 		false
+ + +### `SpinApp.spec.runtimeConfig.sqliteDatabases[index].options[index]` +[back to parent](#spinappspecruntimeconfigsqlitedatabasesindex) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the config option.
+ 		true
valuestring + Value is the static value to bind to the variable.
+ 		false
valueFromobject + ValueFrom is a reference to dynamically bind the variable to.
+ 		false
+ + +### `SpinApp.spec.runtimeConfig.sqliteDatabases[index].options[index].valueFrom` +[back to parent](#spinappspecruntimeconfigsqlitedatabasesindexoptionsindex) + + +ValueFrom is a reference to dynamically bind the variable to. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
secretKeyRefobject + Selects a key of a secret in the apps namespace
+ 		false
+ + +### `SpinApp.spec.runtimeConfig.sqliteDatabases[index].options[index].valueFrom.configMapKeyRef` +[back to parent](#spinappspecruntimeconfigsqlitedatabasesindexoptionsindexvaluefrom) + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid?
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### `SpinApp.spec.runtimeConfig.sqliteDatabases[index].options[index].valueFrom.secretKeyRef` +[back to parent](#spinappspecruntimeconfigsqlitedatabasesindexoptionsindexvaluefrom) + + +Selects a key of a secret in the apps namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid?
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### `SpinApp.spec.variables[index]` +[back to parent](#spinappspec) + + +SpinVar defines a binding between a spin variable and a static or dynamic value. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the variable to bind.
+ 		true
valuestring + Value is the static value to bind to the variable.
+ 		false
valueFromobject + ValueFrom is a reference to dynamically bind the variable to.
+ 		false
+ + +### `SpinApp.spec.variables[index].valueFrom` +[back to parent](#spinappspecvariablesindex) + + +ValueFrom is a reference to dynamically bind the variable to. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
configMapKeyRefobject + Selects a key of a ConfigMap.
+ 		false
fieldRefobject + Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
+ 		false
resourceFieldRefobject + Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
+ 		false
secretKeyRefobject + Selects a key of a secret in the pod's namespace
+ 		false
+ + +### `SpinApp.spec.variables[index].valueFrom.configMapKeyRef` +[back to parent](#spinappspecvariablesindexvaluefrom) + + +Selects a key of a ConfigMap. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key to select.
+ 		true
namestring + Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid?
+ 		false
optionalboolean + Specify whether the ConfigMap or its key must be defined
+ 		false
+ + +### `SpinApp.spec.variables[index].valueFrom.fieldRef` +[back to parent](#spinappspecvariablesindexvaluefrom) + + +Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, +spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### `SpinApp.spec.variables[index].valueFrom.resourceFieldRef` +[back to parent](#spinappspecvariablesindexvaluefrom) + + +Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### `SpinApp.spec.variables[index].valueFrom.secretKeyRef` +[back to parent](#spinappspecvariablesindexvaluefrom) + + +Selects a key of a secret in the pod's namespace + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + The key of the secret to select from. Must be a valid secret key.
+ 		true
namestring + Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid?
+ 		false
optionalboolean + Specify whether the Secret or its key must be defined
+ 		false
+ + +### `SpinApp.spec.volumeMounts[index]` +[back to parent](#spinappspec) + + +VolumeMount describes a mounting of a Volume within a container. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
mountPathstring + Path within the container at which the volume should be mounted. Must +not contain ':'.
+ 		true
namestring + This must match the Name of a Volume.
+ 		true
mountPropagationstring + mountPropagation determines how mounts are propagated from the host +to container and the other way around. +When not set, MountPropagationNone is used. +This field is beta in 1.10.
+ 		false
readOnlyboolean + Mounted read-only if true, read-write otherwise (false or unspecified). +Defaults to false.
+ 		false
subPathstring + Path within the volume from which the container's volume should be mounted. +Defaults to "" (volume's root).
+ 		false
subPathExprstring + Expanded path within the volume from which the container's volume should be mounted. +Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. +Defaults to "" (volume's root). +SubPathExpr and SubPath are mutually exclusive.
+ 		false
+ + +### `SpinApp.spec.volumes[index]` +[back to parent](#spinappspec) + + +Volume represents a named volume in a pod that may be accessed by any container in the pod. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + name of the volume. +Must be a DNS_LABEL and unique within the pod. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ 		true
awsElasticBlockStoreobject + awsElasticBlockStore represents an AWS Disk resource that is attached to a +kubelet's host machine and then exposed to the pod. +More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ 		false
azureDiskobject + azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
+ 		false
azureFileobject + azureFile represents an Azure File Service mount on the host and bind mount to the pod.
+ 		false
cephfsobject + cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
+ 		false
cinderobject + cinder represents a cinder volume attached and mounted on kubelets host machine. +More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ 		false
configMapobject + configMap represents a configMap that should populate this volume
+ 		false
csiobject + csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
+ 		false
downwardAPIobject + downwardAPI represents downward API about the pod that should populate this volume
+ 		false
emptyDirobject + emptyDir represents a temporary directory that shares a pod's lifetime. +More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ 		false
ephemeralobject + ephemeral represents a volume that is handled by a cluster storage driver. +The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, +and deleted when the pod is removed. + + +Use this if: +a) the volume is only needed while the pod runs, +b) features of normal volumes like restoring from snapshot or capacity + tracking are needed, +c) the storage driver is specified through a storage class, and +d) the storage driver supports dynamic volume provisioning through + a PersistentVolumeClaim (see EphemeralVolumeSource for more + information on the connection between this volume type + and PersistentVolumeClaim). + + +Use PersistentVolumeClaim or one of the vendor-specific +APIs for volumes that persist for longer than the lifecycle +of an individual pod. + + +Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to +be used that way - see the documentation of the driver for +more information. + + +A pod can use both types of ephemeral volumes and +persistent volumes at the same time.
+ 		false
fcobject + fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
+ 		false
flexVolumeobject + flexVolume represents a generic volume resource that is +provisioned/attached using an exec based plugin.
+ 		false
flockerobject + flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
+ 		false
gcePersistentDiskobject + gcePersistentDisk represents a GCE Disk resource that is attached to a +kubelet's host machine and then exposed to the pod. +More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ 		false
gitRepoobject + gitRepo represents a git repository at a particular revision. +DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an +EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir +into the Pod's container.
+ 		false
glusterfsobject + glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. +More info: https://examples.k8s.io/volumes/glusterfs/README.md
+ 		false
hostPathobject + hostPath represents a pre-existing file or directory on the host +machine that is directly exposed to the container. This is generally +used for system agents or other privileged things that are allowed +to see the host machine. Most containers will NOT need this. +More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath +--- +TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not +mount host directories as read/write.
+ 		false
iscsiobject + iscsi represents an ISCSI Disk resource that is attached to a +kubelet's host machine and then exposed to the pod. +More info: https://examples.k8s.io/volumes/iscsi/README.md
+ 		false
nfsobject + nfs represents an NFS mount on the host that shares a pod's lifetime +More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ 		false
persistentVolumeClaimobject + persistentVolumeClaimVolumeSource represents a reference to a +PersistentVolumeClaim in the same namespace. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ 		false
photonPersistentDiskobject + photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
+ 		false
portworxVolumeobject + portworxVolume represents a portworx volume attached and mounted on kubelets host machine
+ 		false
projectedobject + projected items for all in one resources secrets, configmaps, and downward API
+ 		false
quobyteobject + quobyte represents a Quobyte mount on the host that shares a pod's lifetime
+ 		false
rbdobject + rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. +More info: https://examples.k8s.io/volumes/rbd/README.md
+ 		false
scaleIOobject + scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
+ 		false
secretobject + secret represents a secret that should populate this volume. +More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+ 		false
storageosobject + storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
+ 		false
vsphereVolumeobject + vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
+ 		false
+ + +### `SpinApp.spec.volumes[index].awsElasticBlockStore` +[back to parent](#spinappspecvolumesindex) + + +awsElasticBlockStore represents an AWS Disk resource that is attached to a +kubelet's host machine and then exposed to the pod. +More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumeIDstring + volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). +More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ 		true
fsTypestring + fsType is the filesystem type of the volume that you want to mount. +Tip: Ensure that the filesystem type is supported by the host operating system. +Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. +More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore +TODO: how do we prevent errors in the filesystem from compromising the machine
+ 		false
partitioninteger + partition is the partition in the volume that you want to mount. +If omitted, the default is to mount by volume name. +Examples: For volume /dev/sda1, you specify the partition as "1". +Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
+
+ Format: int32
+ 		false
readOnlyboolean + readOnly value true will force the readOnly setting in VolumeMounts. +More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
+ 		false
+ + +### `SpinApp.spec.volumes[index].azureDisk` +[back to parent](#spinappspecvolumesindex) + + +azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
diskNamestring + diskName is the Name of the data disk in the blob storage
+ 		true
diskURIstring + diskURI is the URI of data disk in the blob storage
+ 		true
cachingModestring + cachingMode is the Host Caching mode: None, Read Only, Read Write.
+ 		false
fsTypestring + fsType is Filesystem type to mount. +Must be a filesystem type supported by the host operating system. +Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ 		false
kindstring + kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared
+ 		false
readOnlyboolean + readOnly Defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
+ + +### `SpinApp.spec.volumes[index].azureFile` +[back to parent](#spinappspecvolumesindex) + + +azureFile represents an Azure File Service mount on the host and bind mount to the pod. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
secretNamestring + secretName is the name of secret that contains Azure Storage Account Name and Key
+ 		true
shareNamestring + shareName is the azure share Name
+ 		true
readOnlyboolean + readOnly defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
+ + +### `SpinApp.spec.volumes[index].cephfs` +[back to parent](#spinappspecvolumesindex) + + +cephFS represents a Ceph FS mount on the host that shares a pod's lifetime + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
monitors[]string + monitors is Required: Monitors is a collection of Ceph monitors +More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ 		true
pathstring + path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
+ 		false
readOnlyboolean + readOnly is Optional: Defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts. +More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ 		false
secretFilestring + secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret +More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ 		false
secretRefobject + secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. +More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ 		false
userstring + user is optional: User is the rados user name, default is admin +More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
+ 		false
+ + +### `SpinApp.spec.volumes[index].cephfs.secretRef` +[back to parent](#spinappspecvolumesindexcephfs) + + +secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. +More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid?
+ 		false
+ + +### `SpinApp.spec.volumes[index].cinder` +[back to parent](#spinappspecvolumesindex) + + +cinder represents a cinder volume attached and mounted on kubelets host machine. +More info: https://examples.k8s.io/mysql-cinder-pd/README.md + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumeIDstring + volumeID used to identify the volume in cinder. +More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ 		true
fsTypestring + fsType is the filesystem type to mount. +Must be a filesystem type supported by the host operating system. +Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. +More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ 		false
readOnlyboolean + readOnly defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts. +More info: https://examples.k8s.io/mysql-cinder-pd/README.md
+ 		false
secretRefobject + secretRef is optional: points to a secret object containing parameters used to connect +to OpenStack.
+ 		false
+ + +### `SpinApp.spec.volumes[index].cinder.secretRef` +[back to parent](#spinappspecvolumesindexcinder) + + +secretRef is optional: points to a secret object containing parameters used to connect +to OpenStack. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid?
+ 		false
+ + +### `SpinApp.spec.volumes[index].configMap` +[back to parent](#spinappspecvolumesindex) + + +configMap represents a configMap that should populate this volume + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
defaultModeinteger + defaultMode is optional: mode bits used to set permissions on created files by default. +Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. +YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. +Defaults to 0644. +Directories within the path are not affected by this setting. +This might be in conflict with other options that affect the file +mode, like fsGroup, and the result can be other mode bits set.
+
+ Format: int32
+ 		false
items[]object + items if unspecified, each key-value pair in the Data field of the referenced +ConfigMap will be projected into the volume as a file whose name is the +key and content is the value. If specified, the listed keys will be +projected into the specified paths, and unlisted keys will not be +present. If a key is specified which is not present in the ConfigMap, +the volume setup will error unless it is marked optional. Paths must be +relative and may not contain the '..' path or start with '..'.
+ 		false
namestring + Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid?
+ 		false
optionalboolean + optional specify whether the ConfigMap or its keys must be defined
+ 		false
+ + +### `SpinApp.spec.volumes[index].configMap.items[index]` +[back to parent](#spinappspecvolumesindexconfigmap) + + +Maps a string key to a path within a volume. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the key to project.
+ 		true
pathstring + path is the relative path of the file to map the key to. +May not be an absolute path. +May not contain the path element '..'. +May not start with the string '..'.
+ 		true
modeinteger + mode is Optional: mode bits used to set permissions on this file. +Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. +YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. +If not specified, the volume defaultMode will be used. +This might be in conflict with other options that affect the file +mode, like fsGroup, and the result can be other mode bits set.
+
+ Format: int32
+ 		false
+ + +### `SpinApp.spec.volumes[index].csi` +[back to parent](#spinappspecvolumesindex) + + +csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
driverstring + driver is the name of the CSI driver that handles this volume. +Consult with your admin for the correct name as registered in the cluster.
+ 		true
fsTypestring + fsType to mount. Ex. "ext4", "xfs", "ntfs". +If not provided, the empty value is passed to the associated CSI driver +which will determine the default filesystem to apply.
+ 		false
nodePublishSecretRefobject + nodePublishSecretRef is a reference to the secret object containing +sensitive information to pass to the CSI driver to complete the CSI +NodePublishVolume and NodeUnpublishVolume calls. +This field is optional, and may be empty if no secret is required. If the +secret object contains more than one secret, all secret references are passed.
+ 		false
readOnlyboolean + readOnly specifies a read-only configuration for the volume. +Defaults to false (read/write).
+ 		false
volumeAttributesmap[string]string + volumeAttributes stores driver-specific properties that are passed to the CSI +driver. Consult your driver's documentation for supported values.
+ 		false
+ + +### `SpinApp.spec.volumes[index].csi.nodePublishSecretRef` +[back to parent](#spinappspecvolumesindexcsi) + + +nodePublishSecretRef is a reference to the secret object containing +sensitive information to pass to the CSI driver to complete the CSI +NodePublishVolume and NodeUnpublishVolume calls. +This field is optional, and may be empty if no secret is required. If the +secret object contains more than one secret, all secret references are passed. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid?
+ 		false
+ + +### `SpinApp.spec.volumes[index].downwardAPI` +[back to parent](#spinappspecvolumesindex) + + +downwardAPI represents downward API about the pod that should populate this volume + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
defaultModeinteger + Optional: mode bits to use on created files by default. Must be a +Optional: mode bits used to set permissions on created files by default. +Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. +YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. +Defaults to 0644. +Directories within the path are not affected by this setting. +This might be in conflict with other options that affect the file +mode, like fsGroup, and the result can be other mode bits set.
+
+ Format: int32
+ 		false
items[]object + Items is a list of downward API volume file
+ 		false
+ + +### `SpinApp.spec.volumes[index].downwardAPI.items[index]` +[back to parent](#spinappspecvolumesindexdownwardapi) + + +DownwardAPIVolumeFile represents information to create the file containing the pod field + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
+ 		true
fieldRefobject + Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
+ 		false
modeinteger + Optional: mode bits used to set permissions on this file, must be an octal value +between 0000 and 0777 or a decimal value between 0 and 511. +YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. +If not specified, the volume defaultMode will be used. +This might be in conflict with other options that affect the file +mode, like fsGroup, and the result can be other mode bits set.
+
+ Format: int32
+ 		false
resourceFieldRefobject + Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
+ 		false
+ + +### `SpinApp.spec.volumes[index].downwardAPI.items[index].fieldRef` +[back to parent](#spinappspecvolumesindexdownwardapiitemsindex) + + +Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### `SpinApp.spec.volumes[index].downwardAPI.items[index].resourceFieldRef` +[back to parent](#spinappspecvolumesindexdownwardapiitemsindex) + + +Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### `SpinApp.spec.volumes[index].emptyDir` +[back to parent](#spinappspecvolumesindex) + + +emptyDir represents a temporary directory that shares a pod's lifetime. +More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
mediumstring + medium represents what type of storage medium should back this directory. +The default is "" which means to use the node's default medium. +Must be an empty string (default) or Memory. +More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ 		false
sizeLimitint or string + sizeLimit is the total amount of local storage required for this EmptyDir volume. +The size limit is also applicable for memory medium. +The maximum usage on memory medium EmptyDir would be the minimum value between +the SizeLimit specified here and the sum of memory limits of all containers in a pod. +The default is nil which means that the limit is undefined. +More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+ 		false
+ + +### `SpinApp.spec.volumes[index].ephemeral` +[back to parent](#spinappspecvolumesindex) + + +ephemeral represents a volume that is handled by a cluster storage driver. +The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, +and deleted when the pod is removed. + + +Use this if: +a) the volume is only needed while the pod runs, +b) features of normal volumes like restoring from snapshot or capacity + tracking are needed, +c) the storage driver is specified through a storage class, and +d) the storage driver supports dynamic volume provisioning through + a PersistentVolumeClaim (see EphemeralVolumeSource for more + information on the connection between this volume type + and PersistentVolumeClaim). + + +Use PersistentVolumeClaim or one of the vendor-specific +APIs for volumes that persist for longer than the lifecycle +of an individual pod. + + +Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to +be used that way - see the documentation of the driver for +more information. + + +A pod can use both types of ephemeral volumes and +persistent volumes at the same time. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumeClaimTemplateobject + Will be used to create a stand-alone PVC to provision the volume. +The pod in which this EphemeralVolumeSource is embedded will be the +owner of the PVC, i.e. the PVC will be deleted together with the +pod. The name of the PVC will be `-` where +`` is the name from the `PodSpec.Volumes` array +entry. Pod validation will reject the pod if the concatenated name +is not valid for a PVC (for example, too long). + + +An existing PVC with that name that is not owned by the pod +will *not* be used for the pod to avoid using an unrelated +volume by mistake. Starting the pod is then blocked until +the unrelated PVC is removed. If such a pre-created PVC is +meant to be used by the pod, the PVC has to updated with an +owner reference to the pod once the pod exists. Normally +this should not be necessary, but it may be useful when +manually reconstructing a broken cluster. + + +This field is read-only and no changes will be made by Kubernetes +to the PVC after it has been created. + + +Required, must not be nil.
+ 		false
+ + +### `SpinApp.spec.volumes[index].ephemeral.volumeClaimTemplate` +[back to parent](#spinappspecvolumesindexephemeral) + + +Will be used to create a stand-alone PVC to provision the volume. +The pod in which this EphemeralVolumeSource is embedded will be the +owner of the PVC, i.e. the PVC will be deleted together with the +pod. The name of the PVC will be `-` where +`` is the name from the `PodSpec.Volumes` array +entry. Pod validation will reject the pod if the concatenated name +is not valid for a PVC (for example, too long). + + +An existing PVC with that name that is not owned by the pod +will *not* be used for the pod to avoid using an unrelated +volume by mistake. Starting the pod is then blocked until +the unrelated PVC is removed. If such a pre-created PVC is +meant to be used by the pod, the PVC has to updated with an +owner reference to the pod once the pod exists. Normally +this should not be necessary, but it may be useful when +manually reconstructing a broken cluster. + + +This field is read-only and no changes will be made by Kubernetes +to the PVC after it has been created. + + +Required, must not be nil. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
specobject + The specification for the PersistentVolumeClaim. The entire content is +copied unchanged into the PVC that gets created from this +template. The same fields as in a PersistentVolumeClaim +are also valid here.
+ 		true
metadataobject + May contain labels and annotations that will be copied into the PVC +when creating it. No other fields are allowed and will be rejected during +validation.
+ 		false
+ + +### `SpinApp.spec.volumes[index].ephemeral.volumeClaimTemplate.spec` +[back to parent](#spinappspecvolumesindexephemeralvolumeclaimtemplate) + + +The specification for the PersistentVolumeClaim. The entire content is +copied unchanged into the PVC that gets created from this +template. The same fields as in a PersistentVolumeClaim +are also valid here. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
accessModes[]string + accessModes contains the desired access modes the volume should have. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
+ 		false
dataSourceobject + dataSource field can be used to specify either: +* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) +* An existing PVC (PersistentVolumeClaim) +If the provisioner or an external controller can support the specified data source, +it will create a new volume based on the contents of the specified data source. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource.
+ 		false
dataSourceRefobject + dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any object from a non-empty API group (non +core object) or a PersistentVolumeClaim object. +When this field is specified, volume binding will only succeed if the type of +the specified object matches some installed volume populator or dynamic +provisioner. +This field will replace the functionality of the dataSource field and as such +if both fields are non-empty, they must have the same value. For backwards +compatibility, when namespace isn't specified in dataSourceRef, +both fields (dataSource and dataSourceRef) will be set to the same +value automatically if one of them is empty and the other is non-empty. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three important differences between dataSource and dataSourceRef: +* While dataSource only allows two specific types of objects, dataSourceRef + allows any non-core object, as well as PersistentVolumeClaim objects. +* While dataSource ignores disallowed values (dropping them), dataSourceRef + preserves all values, and generates an error if a disallowed value is + specified. +* While dataSource only allows local objects, dataSourceRef allows objects + in any namespaces. +(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. +(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ 		false
resourcesobject + resources represents the minimum resources the volume should have. +If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements +that are lower than previous value but must still be higher than capacity recorded in the +status field of the claim. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
+ 		false
selectorobject + selector is a label query over volumes to consider for binding.
+ 		false
storageClassNamestring + storageClassName is the name of the StorageClass required by the claim. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
+ 		false
volumeAttributesClassNamestring + volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. +If specified, the CSI driver will create or update the volume with the attributes defined +in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, +it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass +will be applied to the claim but it's not allowed to reset this field to empty string once it is set. +If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass +will be set by the persistentvolume controller if it exists. +If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be +set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource +exists. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#volumeattributesclass +(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.
+ 		false
volumeModestring + volumeMode defines what type of volume is required by the claim. +Value of Filesystem is implied when not included in claim spec.
+ 		false
volumeNamestring + volumeName is the binding reference to the PersistentVolume backing this claim.
+ 		false
+ + +### `SpinApp.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSource` +[back to parent](#spinappspecvolumesindexephemeralvolumeclaimtemplatespec) + + +dataSource field can be used to specify either: +* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) +* An existing PVC (PersistentVolumeClaim) +If the provisioner or an external controller can support the specified data source, +it will create a new volume based on the contents of the specified data source. +When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, +and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. +If the namespace is specified, then dataSourceRef will not be copied to dataSource. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + APIGroup is the group for the resource being referenced. +If APIGroup is not specified, the specified Kind must be in the core API group. +For any other third-party types, APIGroup is required.
+ 		false
+ + +### `SpinApp.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.dataSourceRef` +[back to parent](#spinappspecvolumesindexephemeralvolumeclaimtemplatespec) + + +dataSourceRef specifies the object from which to populate the volume with data, if a non-empty +volume is desired. This may be any object from a non-empty API group (non +core object) or a PersistentVolumeClaim object. +When this field is specified, volume binding will only succeed if the type of +the specified object matches some installed volume populator or dynamic +provisioner. +This field will replace the functionality of the dataSource field and as such +if both fields are non-empty, they must have the same value. For backwards +compatibility, when namespace isn't specified in dataSourceRef, +both fields (dataSource and dataSourceRef) will be set to the same +value automatically if one of them is empty and the other is non-empty. +When namespace is specified in dataSourceRef, +dataSource isn't set to the same value and must be empty. +There are three important differences between dataSource and dataSourceRef: +* While dataSource only allows two specific types of objects, dataSourceRef + allows any non-core object, as well as PersistentVolumeClaim objects. +* While dataSource ignores disallowed values (dropping them), dataSourceRef + preserves all values, and generates an error if a disallowed value is + specified. +* While dataSource only allows local objects, dataSourceRef allows objects + in any namespaces. +(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. +(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
kindstring + Kind is the type of resource being referenced
+ 		true
namestring + Name is the name of resource being referenced
+ 		true
apiGroupstring + APIGroup is the group for the resource being referenced. +If APIGroup is not specified, the specified Kind must be in the core API group. +For any other third-party types, APIGroup is required.
+ 		false
namespacestring + Namespace is the namespace of resource being referenced +Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. +(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
+ 		false
+ + +### `SpinApp.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.resources` +[back to parent](#spinappspecvolumesindexephemeralvolumeclaimtemplatespec) + + +resources represents the minimum resources the volume should have. +If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements +that are lower than previous value but must still be higher than capacity recorded in the +status field of the claim. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
limitsmap[string]int or string + Limits describes the maximum amount of compute resources allowed. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
requestsmap[string]int or string + Requests describes the minimum amount of compute resources required. +If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, +otherwise to an implementation-defined value. Requests cannot exceed Limits. +More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+ 		false
+ + +### `SpinApp.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector` +[back to parent](#spinappspecvolumesindexephemeralvolumeclaimtemplatespec) + + +selector is a label query over volumes to consider for binding. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[string]string + matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels +map is equivalent to an element of matchExpressions, whose key field is "key", the +operator is "In", and the values array contains only "value". The requirements are ANDed.
+ 		false
+ + +### `SpinApp.spec.volumes[index].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[index]` +[back to parent](#spinappspecvolumesindexephemeralvolumeclaimtemplatespecselector) + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist.
+ 		true
values[]string + values is an array of string values. If the operator is In or NotIn, +the values array must be non-empty. If the operator is Exists or DoesNotExist, +the values array must be empty. This array is replaced during a strategic +merge patch.
+ 		false
+ + +### `SpinApp.spec.volumes[index].fc` +[back to parent](#spinappspecvolumesindex) + + +fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fsTypestring + fsType is the filesystem type to mount. +Must be a filesystem type supported by the host operating system. +Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. +TODO: how do we prevent errors in the filesystem from compromising the machine
+ 		false
luninteger + lun is Optional: FC target lun number
+
+ Format: int32
+ 		false
readOnlyboolean + readOnly is Optional: Defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
targetWWNs[]string + targetWWNs is Optional: FC target worldwide names (WWNs)
+ 		false
wwids[]string + wwids Optional: FC volume world wide identifiers (wwids) +Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
+ 		false
+ + +### `SpinApp.spec.volumes[index].flexVolume` +[back to parent](#spinappspecvolumesindex) + + +flexVolume represents a generic volume resource that is +provisioned/attached using an exec based plugin. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
driverstring + driver is the name of the driver to use for this volume.
+ 		true
fsTypestring + fsType is the filesystem type to mount. +Must be a filesystem type supported by the host operating system. +Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
+ 		false
optionsmap[string]string + options is Optional: this field holds extra command options if any.
+ 		false
readOnlyboolean + readOnly is Optional: defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
secretRefobject + secretRef is Optional: secretRef is reference to the secret object containing +sensitive information to pass to the plugin scripts. This may be +empty if no secret object is specified. If the secret object +contains more than one secret, all secrets are passed to the plugin +scripts.
+ 		false
+ + +### `SpinApp.spec.volumes[index].flexVolume.secretRef` +[back to parent](#spinappspecvolumesindexflexvolume) + + +secretRef is Optional: secretRef is reference to the secret object containing +sensitive information to pass to the plugin scripts. This may be +empty if no secret object is specified. If the secret object +contains more than one secret, all secrets are passed to the plugin +scripts. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid?
+ 		false
+ + +### `SpinApp.spec.volumes[index].flocker` +[back to parent](#spinappspecvolumesindex) + + +flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
datasetNamestring + datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker +should be considered as deprecated
+ 		false
datasetUUIDstring + datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset
+ 		false
+ + +### `SpinApp.spec.volumes[index].gcePersistentDisk` +[back to parent](#spinappspecvolumesindex) + + +gcePersistentDisk represents a GCE Disk resource that is attached to a +kubelet's host machine and then exposed to the pod. +More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pdNamestring + pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. +More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ 		true
fsTypestring + fsType is filesystem type of the volume that you want to mount. +Tip: Ensure that the filesystem type is supported by the host operating system. +Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. +More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk +TODO: how do we prevent errors in the filesystem from compromising the machine
+ 		false
partitioninteger + partition is the partition in the volume that you want to mount. +If omitted, the default is to mount by volume name. +Examples: For volume /dev/sda1, you specify the partition as "1". +Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). +More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+
+ Format: int32
+ 		false
readOnlyboolean + readOnly here will force the ReadOnly setting in VolumeMounts. +Defaults to false. +More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
+ 		false
+ + +### `SpinApp.spec.volumes[index].gitRepo` +[back to parent](#spinappspecvolumesindex) + + +gitRepo represents a git repository at a particular revision. +DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an +EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir +into the Pod's container. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
repositorystring + repository is the URL
+ 		true
directorystring + directory is the target directory name. +Must not contain or start with '..'. If '.' is supplied, the volume directory will be the +git repository. Otherwise, if specified, the volume will contain the git repository in +the subdirectory with the given name.
+ 		false
revisionstring + revision is the commit hash for the specified revision.
+ 		false
+ + +### `SpinApp.spec.volumes[index].glusterfs` +[back to parent](#spinappspecvolumesindex) + + +glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. +More info: https://examples.k8s.io/volumes/glusterfs/README.md + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
endpointsstring + endpoints is the endpoint name that details Glusterfs topology. +More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ 		true
pathstring + path is the Glusterfs volume path. +More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ 		true
readOnlyboolean + readOnly here will force the Glusterfs volume to be mounted with read-only permissions. +Defaults to false. +More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
+ 		false
+ + +### `SpinApp.spec.volumes[index].hostPath` +[back to parent](#spinappspecvolumesindex) + + +hostPath represents a pre-existing file or directory on the host +machine that is directly exposed to the container. This is generally +used for system agents or other privileged things that are allowed +to see the host machine. Most containers will NOT need this. +More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath +--- +TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not +mount host directories as read/write. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + path of the directory on the host. +If the path is a symlink, it will follow the link to the real path. +More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ 		true
typestring + type for HostPath Volume +Defaults to "" +More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
+ 		false
+ + +### `SpinApp.spec.volumes[index].iscsi` +[back to parent](#spinappspecvolumesindex) + + +iscsi represents an ISCSI Disk resource that is attached to a +kubelet's host machine and then exposed to the pod. +More info: https://examples.k8s.io/volumes/iscsi/README.md + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
iqnstring + iqn is the target iSCSI Qualified Name.
+ 		true
luninteger + lun represents iSCSI Target Lun number.
+
+ Format: int32
+ 		true
targetPortalstring + targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port +is other than default (typically TCP ports 860 and 3260).
+ 		true
chapAuthDiscoveryboolean + chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
+ 		false
chapAuthSessionboolean + chapAuthSession defines whether support iSCSI Session CHAP authentication
+ 		false
fsTypestring + fsType is the filesystem type of the volume that you want to mount. +Tip: Ensure that the filesystem type is supported by the host operating system. +Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. +More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi +TODO: how do we prevent errors in the filesystem from compromising the machine
+ 		false
initiatorNamestring + initiatorName is the custom iSCSI Initiator Name. +If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface +: will be created for the connection.
+ 		false
iscsiInterfacestring + iscsiInterface is the interface Name that uses an iSCSI transport. +Defaults to 'default' (tcp).
+ 		false
portals[]string + portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port +is other than default (typically TCP ports 860 and 3260).
+ 		false
readOnlyboolean + readOnly here will force the ReadOnly setting in VolumeMounts. +Defaults to false.
+ 		false
secretRefobject + secretRef is the CHAP Secret for iSCSI target and initiator authentication
+ 		false
+ + +### `SpinApp.spec.volumes[index].iscsi.secretRef` +[back to parent](#spinappspecvolumesindexiscsi) + + +secretRef is the CHAP Secret for iSCSI target and initiator authentication + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid?
+ 		false
+ + +### `SpinApp.spec.volumes[index].nfs` +[back to parent](#spinappspecvolumesindex) + + +nfs represents an NFS mount on the host that shares a pod's lifetime +More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + path that is exported by the NFS server. +More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ 		true
serverstring + server is the hostname or IP address of the NFS server. +More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ 		true
readOnlyboolean + readOnly here will force the NFS export to be mounted with read-only permissions. +Defaults to false. +More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
+ 		false
+ + +### `SpinApp.spec.volumes[index].persistentVolumeClaim` +[back to parent](#spinappspecvolumesindex) + + +persistentVolumeClaimVolumeSource represents a reference to a +PersistentVolumeClaim in the same namespace. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
claimNamestring + claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. +More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
+ 		true
readOnlyboolean + readOnly Will force the ReadOnly setting in VolumeMounts. +Default false.
+ 		false
+ + +### `SpinApp.spec.volumes[index].photonPersistentDisk` +[back to parent](#spinappspecvolumesindex) + + +photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pdIDstring + pdID is the ID that identifies Photon Controller persistent disk
+ 		true
fsTypestring + fsType is the filesystem type to mount. +Must be a filesystem type supported by the host operating system. +Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ 		false
+ + +### `SpinApp.spec.volumes[index].portworxVolume` +[back to parent](#spinappspecvolumesindex) + + +portworxVolume represents a portworx volume attached and mounted on kubelets host machine + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumeIDstring + volumeID uniquely identifies a Portworx volume
+ 		true
fsTypestring + fSType represents the filesystem type to mount +Must be a filesystem type supported by the host operating system. +Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
+ 		false
readOnlyboolean + readOnly defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
+ + +### `SpinApp.spec.volumes[index].projected` +[back to parent](#spinappspecvolumesindex) + + +projected items for all in one resources secrets, configmaps, and downward API + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
defaultModeinteger + defaultMode are the mode bits used to set permissions on created files by default. +Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. +YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. +Directories within the path are not affected by this setting. +This might be in conflict with other options that affect the file +mode, like fsGroup, and the result can be other mode bits set.
+
+ Format: int32
+ 		false
sources[]object + sources is the list of volume projections
+ 		false
+ + +### `SpinApp.spec.volumes[index].projected.sources[index]` +[back to parent](#spinappspecvolumesindexprojected) + + +Projection that may be projected along with other supported volume types + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
clusterTrustBundleobject + ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field +of ClusterTrustBundle objects in an auto-updating file. + + +Alpha, gated by the ClusterTrustBundleProjection feature gate. + + +ClusterTrustBundle objects can either be selected by name, or by the +combination of signer name and a label selector. + + +Kubelet performs aggressive normalization of the PEM contents written +into the pod filesystem. Esoteric PEM features such as inter-block +comments and block headers are stripped. Certificates are deduplicated. +The ordering of certificates within the file is arbitrary, and Kubelet +may change the order over time.
+ 		false
configMapobject + configMap information about the configMap data to project
+ 		false
downwardAPIobject + downwardAPI information about the downwardAPI data to project
+ 		false
secretobject + secret information about the secret data to project
+ 		false
serviceAccountTokenobject + serviceAccountToken is information about the serviceAccountToken data to project
+ 		false
+ + +### `SpinApp.spec.volumes[index].projected.sources[index].clusterTrustBundle` +[back to parent](#spinappspecvolumesindexprojectedsourcesindex) + + +ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field +of ClusterTrustBundle objects in an auto-updating file. + + +Alpha, gated by the ClusterTrustBundleProjection feature gate. + + +ClusterTrustBundle objects can either be selected by name, or by the +combination of signer name and a label selector. + + +Kubelet performs aggressive normalization of the PEM contents written +into the pod filesystem. Esoteric PEM features such as inter-block +comments and block headers are stripped. Certificates are deduplicated. +The ordering of certificates within the file is arbitrary, and Kubelet +may change the order over time. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + Relative path from the volume root to write the bundle.
+ 		true
labelSelectorobject + Select all ClusterTrustBundles that match this label selector. Only has +effect if signerName is set. Mutually-exclusive with name. If unset, +interpreted as "match nothing". If set but empty, interpreted as "match +everything".
+ 		false
namestring + Select a single ClusterTrustBundle by object name. Mutually-exclusive +with signerName and labelSelector.
+ 		false
optionalboolean + If true, don't block pod startup if the referenced ClusterTrustBundle(s) +aren't available. If using name, then the named ClusterTrustBundle is +allowed not to exist. If using signerName, then the combination of +signerName and labelSelector is allowed to match zero +ClusterTrustBundles.
+ 		false
signerNamestring + Select all ClusterTrustBundles that match this signer name. +Mutually-exclusive with name. The contents of all selected +ClusterTrustBundles will be unified and deduplicated.
+ 		false
+ + +### `SpinApp.spec.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector` +[back to parent](#spinappspecvolumesindexprojectedsourcesindexclustertrustbundle) + + +Select all ClusterTrustBundles that match this label selector. Only has +effect if signerName is set. Mutually-exclusive with name. If unset, +interpreted as "match nothing". If set but empty, interpreted as "match +everything". + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
+ 		false
matchLabelsmap[string]string + matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels +map is equivalent to an element of matchExpressions, whose key field is "key", the +operator is "In", and the values array contains only "value". The requirements are ANDed.
+ 		false
+ + +### `SpinApp.spec.volumes[index].projected.sources[index].clusterTrustBundle.labelSelector.matchExpressions[index]` +[back to parent](#spinappspecvolumesindexprojectedsourcesindexclustertrustbundlelabelselector) + + +A label selector requirement is a selector that contains values, a key, and an operator that +relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the label key that the selector applies to.
+ 		true
operatorstring + operator represents a key's relationship to a set of values. +Valid operators are In, NotIn, Exists and DoesNotExist.
+ 		true
values[]string + values is an array of string values. If the operator is In or NotIn, +the values array must be non-empty. If the operator is Exists or DoesNotExist, +the values array must be empty. This array is replaced during a strategic +merge patch.
+ 		false
+ + +### `SpinApp.spec.volumes[index].projected.sources[index].configMap` +[back to parent](#spinappspecvolumesindexprojectedsourcesindex) + + +configMap information about the configMap data to project + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
items[]object + items if unspecified, each key-value pair in the Data field of the referenced +ConfigMap will be projected into the volume as a file whose name is the +key and content is the value. If specified, the listed keys will be +projected into the specified paths, and unlisted keys will not be +present. If a key is specified which is not present in the ConfigMap, +the volume setup will error unless it is marked optional. Paths must be +relative and may not contain the '..' path or start with '..'.
+ 		false
namestring + Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid?
+ 		false
optionalboolean + optional specify whether the ConfigMap or its keys must be defined
+ 		false
+ + +### `SpinApp.spec.volumes[index].projected.sources[index].configMap.items[index]` +[back to parent](#spinappspecvolumesindexprojectedsourcesindexconfigmap) + + +Maps a string key to a path within a volume. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the key to project.
+ 		true
pathstring + path is the relative path of the file to map the key to. +May not be an absolute path. +May not contain the path element '..'. +May not start with the string '..'.
+ 		true
modeinteger + mode is Optional: mode bits used to set permissions on this file. +Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. +YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. +If not specified, the volume defaultMode will be used. +This might be in conflict with other options that affect the file +mode, like fsGroup, and the result can be other mode bits set.
+
+ Format: int32
+ 		false
+ + +### `SpinApp.spec.volumes[index].projected.sources[index].downwardAPI` +[back to parent](#spinappspecvolumesindexprojectedsourcesindex) + + +downwardAPI information about the downwardAPI data to project + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
items[]object + Items is a list of DownwardAPIVolume file
+ 		false
+ + +### `SpinApp.spec.volumes[index].projected.sources[index].downwardAPI.items[index]` +[back to parent](#spinappspecvolumesindexprojectedsourcesindexdownwardapi) + + +DownwardAPIVolumeFile represents information to create the file containing the pod field + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'
+ 		true
fieldRefobject + Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.
+ 		false
modeinteger + Optional: mode bits used to set permissions on this file, must be an octal value +between 0000 and 0777 or a decimal value between 0 and 511. +YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. +If not specified, the volume defaultMode will be used. +This might be in conflict with other options that affect the file +mode, like fsGroup, and the result can be other mode bits set.
+
+ Format: int32
+ 		false
resourceFieldRefobject + Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
+ 		false
+ + +### `SpinApp.spec.volumes[index].projected.sources[index].downwardAPI.items[index].fieldRef` +[back to parent](#spinappspecvolumesindexprojectedsourcesindexdownwardapiitemsindex) + + +Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fieldPathstring + Path of the field to select in the specified API version.
+ 		true
apiVersionstring + Version of the schema the FieldPath is written in terms of, defaults to "v1".
+ 		false
+ + +### `SpinApp.spec.volumes[index].projected.sources[index].downwardAPI.items[index].resourceFieldRef` +[back to parent](#spinappspecvolumesindexprojectedsourcesindexdownwardapiitemsindex) + + +Selects a resource of the container: only resources limits and requests +(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
resourcestring + Required: resource to select
+ 		true
containerNamestring + Container name: required for volumes, optional for env vars
+ 		false
divisorint or string + Specifies the output format of the exposed resources, defaults to "1"
+ 		false
+ + +### `SpinApp.spec.volumes[index].projected.sources[index].secret` +[back to parent](#spinappspecvolumesindexprojectedsourcesindex) + + +secret information about the secret data to project + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
items[]object + items if unspecified, each key-value pair in the Data field of the referenced +Secret will be projected into the volume as a file whose name is the +key and content is the value. If specified, the listed keys will be +projected into the specified paths, and unlisted keys will not be +present. If a key is specified which is not present in the Secret, +the volume setup will error unless it is marked optional. Paths must be +relative and may not contain the '..' path or start with '..'.
+ 		false
namestring + Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid?
+ 		false
optionalboolean + optional field specify whether the Secret or its key must be defined
+ 		false
+ + +### `SpinApp.spec.volumes[index].projected.sources[index].secret.items[index]` +[back to parent](#spinappspecvolumesindexprojectedsourcesindexsecret) + + +Maps a string key to a path within a volume. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the key to project.
+ 		true
pathstring + path is the relative path of the file to map the key to. +May not be an absolute path. +May not contain the path element '..'. +May not start with the string '..'.
+ 		true
modeinteger + mode is Optional: mode bits used to set permissions on this file. +Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. +YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. +If not specified, the volume defaultMode will be used. +This might be in conflict with other options that affect the file +mode, like fsGroup, and the result can be other mode bits set.
+
+ Format: int32
+ 		false
+ + +### `SpinApp.spec.volumes[index].projected.sources[index].serviceAccountToken` +[back to parent](#spinappspecvolumesindexprojectedsourcesindex) + + +serviceAccountToken is information about the serviceAccountToken data to project + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pathstring + path is the path relative to the mount point of the file to project the +token into.
+ 		true
audiencestring + audience is the intended audience of the token. A recipient of a token +must identify itself with an identifier specified in the audience of the +token, and otherwise should reject the token. The audience defaults to the +identifier of the apiserver.
+ 		false
expirationSecondsinteger + expirationSeconds is the requested duration of validity of the service +account token. As the token approaches expiration, the kubelet volume +plugin will proactively rotate the service account token. The kubelet will +start trying to rotate the token if the token is older than 80 percent of +its time to live or if the token is older than 24 hours.Defaults to 1 hour +and must be at least 10 minutes.
+
+ Format: int64
+ 		false
+ + +### `SpinApp.spec.volumes[index].quobyte` +[back to parent](#spinappspecvolumesindex) + + +quobyte represents a Quobyte mount on the host that shares a pod's lifetime + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
registrystring + registry represents a single or multiple Quobyte Registry services +specified as a string as host:port pair (multiple entries are separated with commas) +which acts as the central registry for volumes
+ 		true
volumestring + volume is a string that references an already created Quobyte volume by name.
+ 		true
groupstring + group to map volume access to +Default is no group
+ 		false
readOnlyboolean + readOnly here will force the Quobyte volume to be mounted with read-only permissions. +Defaults to false.
+ 		false
tenantstring + tenant owning the given Quobyte volume in the Backend +Used with dynamically provisioned Quobyte volumes, value is set by the plugin
+ 		false
userstring + user to map volume access to +Defaults to serivceaccount user
+ 		false
+ + +### `SpinApp.spec.volumes[index].rbd` +[back to parent](#spinappspecvolumesindex) + + +rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. +More info: https://examples.k8s.io/volumes/rbd/README.md + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
imagestring + image is the rados image name. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ 		true
monitors[]string + monitors is a collection of Ceph monitors. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ 		true
fsTypestring + fsType is the filesystem type of the volume that you want to mount. +Tip: Ensure that the filesystem type is supported by the host operating system. +Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. +More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd +TODO: how do we prevent errors in the filesystem from compromising the machine
+ 		false
keyringstring + keyring is the path to key ring for RBDUser. +Default is /etc/ceph/keyring. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ 		false
poolstring + pool is the rados pool name. +Default is rbd. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ 		false
readOnlyboolean + readOnly here will force the ReadOnly setting in VolumeMounts. +Defaults to false. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ 		false
secretRefobject + secretRef is name of the authentication secret for RBDUser. If provided +overrides keyring. +Default is nil. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ 		false
userstring + user is the rados user name. +Default is admin. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
+ 		false
+ + +### `SpinApp.spec.volumes[index].rbd.secretRef` +[back to parent](#spinappspecvolumesindexrbd) + + +secretRef is name of the authentication secret for RBDUser. If provided +overrides keyring. +Default is nil. +More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid?
+ 		false
+ + +### `SpinApp.spec.volumes[index].scaleIO` +[back to parent](#spinappspecvolumesindex) + + +scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
gatewaystring + gateway is the host address of the ScaleIO API Gateway.
+ 		true
secretRefobject + secretRef references to the secret for ScaleIO user and other +sensitive information. If this is not provided, Login operation will fail.
+ 		true
systemstring + system is the name of the storage system as configured in ScaleIO.
+ 		true
fsTypestring + fsType is the filesystem type to mount. +Must be a filesystem type supported by the host operating system. +Ex. "ext4", "xfs", "ntfs". +Default is "xfs".
+ 		false
protectionDomainstring + protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
+ 		false
readOnlyboolean + readOnly Defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
sslEnabledboolean + sslEnabled Flag enable/disable SSL communication with Gateway, default false
+ 		false
storageModestring + storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. +Default is ThinProvisioned.
+ 		false
storagePoolstring + storagePool is the ScaleIO Storage Pool associated with the protection domain.
+ 		false
volumeNamestring + volumeName is the name of a volume already created in the ScaleIO system +that is associated with this volume source.
+ 		false
+ + +### `SpinApp.spec.volumes[index].scaleIO.secretRef` +[back to parent](#spinappspecvolumesindexscaleio) + + +secretRef references to the secret for ScaleIO user and other +sensitive information. If this is not provided, Login operation will fail. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid?
+ 		false
+ + +### `SpinApp.spec.volumes[index].secret` +[back to parent](#spinappspecvolumesindex) + + +secret represents a secret that should populate this volume. +More info: https://kubernetes.io/docs/concepts/storage/volumes#secret + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
defaultModeinteger + defaultMode is Optional: mode bits used to set permissions on created files by default. +Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. +YAML accepts both octal and decimal values, JSON requires decimal values +for mode bits. Defaults to 0644. +Directories within the path are not affected by this setting. +This might be in conflict with other options that affect the file +mode, like fsGroup, and the result can be other mode bits set.
+
+ Format: int32
+ 		false
items[]object + items If unspecified, each key-value pair in the Data field of the referenced +Secret will be projected into the volume as a file whose name is the +key and content is the value. If specified, the listed keys will be +projected into the specified paths, and unlisted keys will not be +present. If a key is specified which is not present in the Secret, +the volume setup will error unless it is marked optional. Paths must be +relative and may not contain the '..' path or start with '..'.
+ 		false
optionalboolean + optional field specify whether the Secret or its keys must be defined
+ 		false
secretNamestring + secretName is the name of the secret in the pod's namespace to use. +More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
+ 		false
+ + +### `SpinApp.spec.volumes[index].secret.items[index]` +[back to parent](#spinappspecvolumesindexsecret) + + +Maps a string key to a path within a volume. + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring + key is the key to project.
+ 		true
pathstring + path is the relative path of the file to map the key to. +May not be an absolute path. +May not contain the path element '..'. +May not start with the string '..'.
+ 		true
modeinteger + mode is Optional: mode bits used to set permissions on this file. +Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. +YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. +If not specified, the volume defaultMode will be used. +This might be in conflict with other options that affect the file +mode, like fsGroup, and the result can be other mode bits set.
+
+ Format: int32
+ 		false
+ + +### `SpinApp.spec.volumes[index].storageos` +[back to parent](#spinappspecvolumesindex) + + +storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
fsTypestring + fsType is the filesystem type to mount. +Must be a filesystem type supported by the host operating system. +Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ 		false
readOnlyboolean + readOnly defaults to false (read/write). ReadOnly here will force +the ReadOnly setting in VolumeMounts.
+ 		false
secretRefobject + secretRef specifies the secret to use for obtaining the StorageOS API +credentials. If not specified, default values will be attempted.
+ 		false
volumeNamestring + volumeName is the human-readable name of the StorageOS volume. Volume +names are only unique within a namespace.
+ 		false
volumeNamespacestring + volumeNamespace specifies the scope of the volume within StorageOS. If no +namespace is specified then the Pod's namespace will be used. This allows the +Kubernetes name scoping to be mirrored within StorageOS for tighter integration. +Set VolumeName to any name to override the default behaviour. +Set to "default" if you are not using namespaces within StorageOS. +Namespaces that do not pre-exist within StorageOS will be created.
+ 		false
+ + +### `SpinApp.spec.volumes[index].storageos.secretRef` +[back to parent](#spinappspecvolumesindexstorageos) + + +secretRef specifies the secret to use for obtaining the StorageOS API +credentials. If not specified, default values will be attempted. + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
namestring + Name of the referent. +More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names +TODO: Add other useful fields. apiVersion, kind, uid?
+ 		false
+ + +### `SpinApp.spec.volumes[index].vsphereVolume` +[back to parent](#spinappspecvolumesindex) + + +vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
volumePathstring + volumePath is the path that identifies vSphere volume vmdk
+ 		true
fsTypestring + fsType is filesystem type to mount. +Must be a filesystem type supported by the host operating system. +Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
+ 		false
storagePolicyIDstring + storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
+ 		false
storagePolicyNamestring + storagePolicyName is the storage Policy Based Management (SPBM) profile name.
+ 		false
+ + +### `SpinApp.status` +[back to parent](#spinapp) + + +SpinAppStatus defines the observed state of SpinApp + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
readyReplicasinteger + Represents the current number of active replicas on the application deployment.
+
+ Format: int32
+ 		true
activeSchedulerstring + ActiveScheduler is the name of the scheduler that is currently scheduling this SpinApp.
+ 		false
conditions[]object + Represents the observations of a SpinApps's current state. +SpinApp.status.conditions.type are: "Available" and "Progressing" +SpinApp.status.conditions.status are one of True, False, Unknown. +SpinApp.status.conditions.reason the value should be a CamelCase string and producers of specific +condition types may define expected values and meanings for this field, and whether the values +are considered a guaranteed API. +SpinApp.status.conditions.Message is a human readable message indicating details about the transition. +For further information see: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties
+ 		false
+ + +### `SpinApp.status.conditions[index]` +[back to parent](#spinappstatus) + + +Condition contains details for one aspect of the current state of this API Resource. +--- +This struct is intended for direct use as an array at the field path .status.conditions. For example, + + + type FooStatus struct{ + // Represents the observations of a foo's current state. + // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" + // +patchMergeKey=type + // +patchStrategy=merge + // +listType=map + // +listMapKey=type + Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` + + + // other fields + } + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
lastTransitionTimestring + lastTransitionTime is the last time the condition transitioned from one status to another. +This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
+
+ Format: date-time
+ 		true
messagestring + message is a human readable message indicating details about the transition. +This may be an empty string.
+ 		true
reasonstring + reason contains a programmatic identifier indicating the reason for the condition's last transition. +Producers of specific condition types may define expected values and meanings for this field, +and whether the values are considered a guaranteed API. +The value should be a CamelCase string. +This field may not be empty.
+ 		true
statusenum + status of the condition, one of True, False, Unknown.
+
+ Enum: True, False, Unknown
+ 		true
typestring + type of condition in CamelCase or in foo.example.com/CamelCase. +--- +Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be +useful (see .node.status.conditions), the ability to deconflict is important. +The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
+ 		true
observedGenerationinteger + observedGeneration represents the .metadata.generation that the condition was set based upon. +For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date +with respect to the current state of the instance.
+
+ Format: int64
+ Minimum: 0
+ 		false
+ + diff --git a/crd-reference/.gitignore b/crd-reference/.gitignore new file mode 100644 index 0000000..4fe7a3c --- /dev/null +++ b/crd-reference/.gitignore @@ -0,0 +1,2 @@ +spin-operator.crds.yaml +spin-operator.crds.yaml.* \ No newline at end of file diff --git a/crd-reference/generate.sh b/crd-reference/generate.sh new file mode 100755 index 0000000..3fe9c1f --- /dev/null +++ b/crd-reference/generate.sh @@ -0,0 +1,33 @@ +#! /bin/bash + +set -e + +if [[ -z "$SPIN_OPERATOR_RELEASE" ]]; then + echo "Must provide SPIN_OPERATOR_RELEASE in environment" 1>&2 + exit 1 +fi + +echo "Installing crdoc" +go install fybrik.io/crdoc@latest + +echo "Downloading Spin Operator CRDs ($SPIN_OPERATOR_RELEASE) " +wget https://github.com/spinkube/spin-operator/releases/download/$SPIN_OPERATOR_RELEASE/spin-operator.crds.yaml + +# Generate SpinAppExecutor Reference Docs +echo "Generating CRD reference docs for SpinAppExecutor" +crdoc -r spin-operator.crds.yaml \ + -o ../content/en/docs/spin-operator/reference/spin-app-executor.md \ + --toc ./spin-app-executor-toc.yaml \ + --template ./spin-operator.tmpl + +echo "Generating CRD reference docs for SpinApp" +# Generate SpinApp Reference Docs +crdoc -r spin-operator.crds.yaml \ + -o ../content/en/docs/spin-operator/reference/spin-app.md \ + --toc ./spin-app-toc.yaml \ + --template ./spin-operator.tmpl + +# Remove spin-operator.crds.yaml +rm spin-operator.crds.yaml + +echo "Done." \ No newline at end of file diff --git a/crd-reference/spin-app-executor-toc.yaml b/crd-reference/spin-app-executor-toc.yaml new file mode 100644 index 0000000..bb0b2f5 --- /dev/null +++ b/crd-reference/spin-app-executor-toc.yaml @@ -0,0 +1,10 @@ +metadata: + title: "SpinAppExecutor CRD Reference" + weight: 1 + description: "Custom Resource Definition (CRD) reference for `SpinAppExecutor`" + category: Spin Operator +groups: + - group: core.spinoperator.dev + version: v1alpha1 + kinds: + - name: SpinAppExecutor diff --git a/crd-reference/spin-app-toc.yaml b/crd-reference/spin-app-toc.yaml new file mode 100644 index 0000000..d815980 --- /dev/null +++ b/crd-reference/spin-app-toc.yaml @@ -0,0 +1,9 @@ +metadata: + title: "SpinApp CRD Reference" + weight: 1 + description: "Custom Resource Definition (CRD) reference for `SpinApp`" +groups: + - group: core.spinoperator.dev + version: v1alpha1 + kinds: + - name: SpinApp diff --git a/crd-reference/spin-operator.tmpl b/crd-reference/spin-operator.tmpl new file mode 100644 index 0000000..0e6aca6 --- /dev/null +++ b/crd-reference/spin-operator.tmpl @@ -0,0 +1,97 @@ +--- +title: {{or .Metadata.Title "API Reference"}} +weight: {{or .Metadata.Weight 1 }} +{{- if .Metadata.Description}} +description: {{.Metadata.Description}} +{{- end}} +categories: [Spin Operator] +tags: [reference] +--- +{{- range .Groups }} +{{- $group := . }} +Resource Types: +{{range .Kinds}} +- [{{.Name}}](#{{ anchorize .Name }}) +{{- end}}{{/* range .Kinds */}} + +{{- range .Kinds}} +{{$kind := .}} +## {{.Name}} +{{- range .Types}} +{{- if not .IsTopLevel}} +### `{{.Name}}` +{{if .ParentKey}}[back to parent](#{{.ParentKey}}){{end}} +{{end}} + +{{.Description}} + + + + + + + + + + + + {{- if .IsTopLevel -}} + + + + + + + + + + + + + + + + + + + {{- end -}} + {{- range .Fields -}} + + + + + + + {{- end -}} + +
NameTypeDescriptionRequired
apiVersionstring{{$group.Group}}/{{$group.Version}}true
kindstring{{$kind.Name}}true
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
{{if .TypeKey}}{{.Name}}{{else}}{{.Name}}{{end}}{{.Type}} + {{.Description}}
+ {{- if or .Schema.XValidations .Schema.Format .Schema.Enum .Schema.Default .Schema.Minimum .Schema.Maximum }} +
+ {{- end}} + {{- if .Schema.XValidations }} + Validations: + {{- range .Schema.XValidations -}} +
  • {{ .Rule }}: {{ .Message }}
    • + {{- end -}} + {{- end }} + {{- if .Schema.Format }} + Format: {{ .Schema.Format }}
    + {{- end }} + {{- if .Schema.Enum }} + Enum: {{ .Schema.Enum | toStrings | join ", " }}
    + {{- end }} + {{- if .Schema.Default }} + Default: {{ .Schema.Default }}
    + {{- end }} + {{- if .Schema.Minimum }} + Minimum: {{ .Schema.Minimum }}
    + {{- end }} + {{- if .Schema.Maximum }} + Maximum: {{ .Schema.Maximum }}
    + {{- end }} +     		{{.Required}}
    + +{{end}}{{/* range .Types */}} +{{- end}}{{/* range .Kinds */}} +{{- end}}{{/* range .Groups */}} diff --git a/package.json b/package.json index 594c709..d5cf67c 100644 --- a/package.json +++ b/package.json @@ -32,7 +32,8 @@ "start": "npm run serve", "test": "npm run check:links", "update:pkg:dep": "npm install --save-dev autoprefixer@latest postcss-cli@latest", - "update:pkg:hugo": "npm install --save-dev --save-exact hugo-extended@latest" + "update:pkg:hugo": "npm install --save-dev --save-exact hugo-extended@latest", + "generate:crd:reference": "cd crd-reference && SPIN_OPERATOR_RELEASE=v0.1.0 ./generate.sh" }, "devDependencies": { "autoprefixer": "^10.4.14",