Porter Operator Resources

The Porter Operator provides custom resource definitions (CRDs) that you can use to interact with Porter and control how it is executed. Though both Porter and Kubernetes has the concept of names, namespaces and labels, the resources do not reuse those fields from the CRD, and instead uses the values as defined on the resource spec. This allows you to run the operator in a Kubernetes namespace, and target a different Porter namespace because although they both use the term namespace, there is no relation between Kubernetes namespaces and Porter namespaces. The same goes for the name and labels fields.

• Installation
• CredentialSet
• ParameterSet
• AgentAction
• AgentConfig
• PorterConfig

Installation

See the glossary for more information about the Installation resource.

The Installation spec is the same schema as the Installation resource in Porter. You can copy/paste the output of the porter installation show NAME -o yaml command into the Installation resource spec (removing the status section).

In addition to the normal fields available on a Porter Installation document, the following fields are supported:

CredentialSet

See the glossary for more information about the CredentialSet resource.

The CredentialSet spec is the same schema as the CredentialSet resource in Porter. You can copy/paste the output of the porter credentials show NAME -o yaml command into the CredentialSet resource spec (removing the status section).

In addition to the normal fields available on a Porter Credential Set document, the following fields are supported:

apiVersion: getporter.org/v1
kind: CredentialSet
metadata:
  name: credentialset-sample
spec:
  schemaVersion: 1.0.1
  namespace: operator
  name: porter-test-me
  credentials:
    - name: test-credential
      source:
        secret: test-secret

ParameterSet

See the glossary for more information about the ParameterSet resource.

The ParameterSet spec is the same schema as the ParameterSet resource in Porter. You can copy/paste the output of the porter parameters show NAME -o yaml command into the ParameterSet resource spec (removing the status section).

In addition to the normal fields available on a Porter Parameter Set document, the following fields are supported:

apiVersion: getporter.org/v1
kind: ParameterSet
metadata:
  name: parameterset-sample
spec:
  schemaVersion: 1.0.1
  namespace: operator
  name: porter-test-me
  parameters:
    - name: test-secret
      source:
        value: test-value
    - name: test-secret
      source:
        secret: test-secret

AgentAction

See the glossary for more information about the AgentAction resource.

apiVersion: getporter.org/v1
kind: AgentAction
metadata:
  name: agentaction-sample
spec:
  args: ["installation", "apply", "installation.yaml"]
  files:
    # base64 encoded file contents
    installation.yaml: c2NoZW1hVmVyc2lvbjogMS4wLjAKbmFtZXNwYWNlOiBvcGVyYXRvcgpuYW1lOiBoZWxsbwpidW5kbGU6CiAgcmVwb3NpdG9yeTogZ2hjci5pby9nZXRwb3J0ZXIvdGVzdC9wb3J0ZXItaGVsbG8KICB2ZXJzaW9uOiAwLjIuMApwYXJhbWV0ZXJzOgogIG5hbWU6IGxsYW1hcyAK

AgentConfig

See the glossary for more information about the [AgentConfig] resource.

apiVersion: getporter.org/v1
kind: AgentConfig
metadata:
  name: customAgent
spec:
  porterRepository: ghcr.io/getporter/porter-agent
  porterVersion: v1.0.0
  serviceAccount: porter-agent
  volumeSize: 64Mi
  pullPolicy: Always
  installationServiceAccount: installation-agent
  pluginConfigFile:
    schemaVersion: 1.0.0
    plugins:
      kubernetes:
        version: v1.0.0

Service Account

The only required configuration is the name of the service account under which Porter should run. The configureNamespace action of the porter operator bundle creates a service account named “porter-agent” for you with the porter-operator-agent-role role binding.

PorterConfig

See the glossary for more information about the PorterConfig resource.

ℹ️ The PorterConfig resource uses the same naming convention as the Porter Configuration File, hyphenated instead of camelCase, so that you can copy/paste between the two without changing the field names.

apiVersion: getporter.org/v1
kind: PorterConfig
metadata:
  name: customPorterConfig
spec:
  verbosity: debug
  default-secrets-plugin: kubernetes.secrets
  default-storage: in-cluster-mongodb
  storage:
    - name: in-cluster-mongodb
      plugin: mongodb
      config:
        url: "mongodb://mongodb.porter-operator-system.svc.cluster.local"