Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Manifest configurations

Following attributes/fields are declared for each Secret Resource object in its YAML manifest file. Some of these attributes need to be mandatorily declared, while others are optional.

Structure of a Secret manifest file

name: ${{secret-name}}
version: v2alpha
type: secret
tags:
  - ${{tag-1}}
  - ${{tag-2}}
description: ${{secret-description}}
owner: ${{owner-id}}
secret:
  type: key-value
  data:
    username: ${{username}}
    password: ${{password}}  
  files:
    gcp_json_key: ${{json-file-path}}

Configuration

Resource meta section

This section is the header of the manifest file. It defines the overall characteristics of the Secret Resource you want to create, using attributes common to all Resource types in DataOS. DataOS uses these attributes to identify, categorize, and manage Resources.

name

Description: A unique name for this Secret Resource. This name is used to identify and reference the Secret in DataOS.

Data Type

Requirement

Default Value

Possible Value

string

mandatory

none

  • must match the RegEx [a-z]([-_.a-z0-9]*[a-z0-9])

  • must be less than 60 characters

  • must start with a lowercase letter

  • must end with a lowercase letter or digit (for example, test-secret- is invalid; use test-secret)

Example usage:


version

Description: API version of the Secret schema. It tells DataOS which manifest structure and validation rules to apply.

Data Type

Requirement

Default Value

Possible Value

string

mandatory

none

v2alpha

Example usage:


type

Description: Resource kind identifier. Set this to secret to tell DataOS that this manifest creates a Secret Resource.

Data Type

Requirement

Default Value

Possible Value

string

mandatory

none

secret

Example usage:


description

Description: Human-readable summary of what this Secret is for (for example, which system it connects to and where it is used).

Data Type

Requirement

Default Value

Possible Value

string

optional

none

any string

Additional information: The description can be within quotes or without.

YAML supports scalars such as strings, numbers, booleans, and null. A scalar value can be unquoted, within single quotes (') or double quotes ("). When the scalar contains a special character, the value must be declared within quotes.

Example usage:


owner

Description: User ID of the owner responsible for this Secret. Ownership helps with governance, auditability, and operations.

Data Type

Requirement

Default Value

Possible Value

string

optional

id of the user applying the Resource

any valid dataos user id

Example usage:


layer

Description: Deployment layer for the Secret. Use this to define whether the Resource belongs to the user or system layer.

Data Type

Requirement

Default Value

Possible Value

string

optional

user

user/system

Additional information: The operating system works at two layers: user and system. This is a logical separation to help you understand how the system works. Example usage:


Resource-specific section

This section is specific to Secret Resource configurations.

secret

Description: Resource-specific configuration block. For Secrets, this block contains how credentials are stored and the actual secret values/files.

Data Type

Requirement

Default Value

Possible Value

mapping

mandatory

none

attributes specific for a particular \<resource-type>

Declaring the Resource type (for example workflow: followed by a space) creates a mapping in YAML. For the key-value pairs inside each mapping, see the page for the relevant DataOS Resource.

Example usage:


secret.type

Description: Storage format for Secret entries. Use key-value when credentials are provided as key-value pairs under secret.data. Use image-pull when the Secret stores container registry credentials to be referenced as an imagePullSecret when deploying a private container image (for example, from an App manifest).

Data Type

Requirement

Default Value

Possible Value

string

mandatory

none

key-value, image-pull

Example usage:

Additional information: For image-pull, secret.data must contain a single key named .dockerconfigjson, whose value is the Docker config.json auth block for the target registry, declared as a YAML block scalar (|). DataOS base64-encodes this value automatically when the manifest is applied. Do not base64-encode it yourself. Reference the resulting Secret by name from spec.service.imagePullSecret in the consuming Resource to pull a private image.


secret.data

Description: Key-value entries to be stored securely in the Secret. Each key is a field name (for example, USERNAME, or .dockerconfigjson for image-pull Secrets) and each value is sensitive content (for example, passwords, tokens, or keys). For multi-line values, use YAML block scalars (for example, |).

Data Type

Requirement

Default Value

Possible Value

mapping

optional

none

source-specific key-value pairs

Example usage:


secret.files

Description: File-based secret entries to be stored securely in the Secret. Use this when the secret value comes from a file (for example, JSON key files, certificates, or private keys). Each key is the field name to store in the Secret, and each value is the file path to read content from. At least one of secret.data or secret.files must be provided.

Data Type

Requirement

Default Value

Possible Value

mapping

optional

none

key-value pairs where value is a file path

Example usage:

Last updated

Was this helpful?