KoiosPlatform

apiVersion: platform.koioss.com/v1alpha1 · kind: KoiosPlatform

Fields of spec. Console says how the OpenShift creation form shows the field (form, advanced or hidden); fields without it are set in YAML. Objects marked open also accept the fields of the upstream resource they configure.

Field

Type

Values

Default

Console

Description

admin_email

string

advanced: Admin E-mail Address

Administrator email used when creating it.

admin_password_secret

string

advanced: Admin Password Secret

User Secret with the admin password in key password; otherwise -admin-password is generated. It must exist.

admin_user

string

advanced: Admin Account Username

Platform administrator username (admin by default). Created once; changing it creates another admin.

api

object

advanced: API deployment configuration

Gateway deployment (Jewel api container). Replaces spec.gateway.replicas/resource_requirements.

api.log_level

string

DEBUG, INFO, WARNING, ERROR, CRITICAL

INFO

The log level for the deployment.

api.node_selector

object

advanced: Node Selector

NodeSelector for the gateway pods.

api.replicas

integer

1

form: Replicas

The number of replicas for the deployment.

api.resource_requirements

object

form: API server resource requirements

Resource requirements for the galaxy api container

api.resource_requirements.limits

object

api.resource_requirements.limits.cpu

string

api.resource_requirements.limits.memory

string

api.resource_requirements.limits.storage

string

api.resource_requirements.requests

object

api.resource_requirements.requests.cpu

string

api.resource_requirements.requests.memory

string

api.resource_requirements.requests.storage

string

api.security_context

object (open)

advanced: Security Context

Settings to apply to the securityContext field of the api container.

api.strategy

object

advanced: Strategy

The deployment strategy to use to replace existing pods with new ones.

api.strategy.rollingUpdate

object

Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate. — TODO: Update this to follow our convention for oneOf, whatever we decide it to be.

api.strategy.rollingUpdate.maxSurge

integer or string

The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.

api.strategy.rollingUpdate.maxUnavailable

integer or string

The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.

api.strategy.type

string

Type of deployment. Can be “Recreate” or “RollingUpdate”. Default is RollingUpdate.

api.tolerations

array of object

advanced: Tolerations

Node tolerations for the gateway pods.

api.topology_spread_constraints

array of object

advanced: Topology Spread Constraints

Topology rule(s) for the pods.

bundle_cacert_secret

string

advanced: Bundle Certificate Authority Secret

Secret with bundle-ca.crt: CA trusted by the gateway and, by default, by controller, EDA and Hub.

controller

object (open)

advanced: Controller

AWX spec fields (awx.ansible.com/v1beta1) for the child AWX. The operator merges them with the fields the platform requires (resource server and JWT extra_settings, api_urlpattern_prefix, ingress_type none, shared database); the platform wins on conflict. With an external database, database_secret.

controller.database_secret

string

External database Secret of the controller (host, port, database, username, password, type=unmanaged; optional sslmode).

database

object

advanced: PostgreSQL Database configuration

Shared platform PostgreSQL, one user per component.

database.database_secret

string

form: External database configuration secret

Secret where the database configuration can be found. Set this to use your own external PostgreSQL database. If not specified, this secret will be generated and Gateway will create a managed postgres pod.

database.external_secret

string

hidden: Deprecated External Database Secret

Deprecated. alias of database_secret: external database Secret of the gateway (host, port, database, username, password, type=unmanaged; optional sslmode). The controller one goes in spec.controller.database_secret.

database.idle_disabled

boolean

False

advanced: Database Idle Disabled

When true, idle_aap keeps the managed PostgreSQL running.

database.image

string

hidden: Deprecated PostgreSQL Image

database.image_version

string

hidden: Deprecated PostgreSQL Image Version

Tag or sha256:.

database.managed

boolean

hidden: Managed Database

true = deployed by the operator; false = external PostgreSQL (databases created by the administrator; cannot change later). When unset, false if database_secret is set and true otherwise.

database.node_selector

object

NodeSelector for the database pod.

database.postgres_extra_settings

array of object

hidden: Postgres Extra Settings

PostgreSQL configuration settings to be added to postgresql.conf

database.postgres_ssl_mode

string

disable, allow, prefer, require, verify-ca, verify-full

advanced: Database SSLMode

PostgreSQL connection sslmode (default prefer). The managed PostgreSQL has no TLS: only disable, allow or prefer. With an external database each database Secret sets its own sslmode key.

database.postgres_storage_class

string

advanced: Database Storage Class

Storage class to use for the PostgreSQL PVC

database.priority_class

string

Assign a pre-existing priority class to the postgres pod

database.resource_requirements

object

form: Database resource requirements

Resource requirements for the database container.

database.resource_requirements.claims

array of object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable.

database.resource_requirements.limits

object

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

database.resource_requirements.requests

object

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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

database.storage_class

string

hidden: Deprecated Database Storage Class

database.storage_requirements

object

form: Database Storage Requirements

Storage requirements for the PostgreSQL container

database.storage_requirements.limits

object

database.storage_requirements.limits.storage

string

database.storage_requirements.requests

object

database.storage_requirements.requests.storage

string

database.storage_size

string

hidden: Deprecated Database Storage Size

database.tolerations

array of object

Node tolerations for the database pod.

db_fields_encryption_secret

string

advanced: DB Fields Encryption Key

User Secret with the field encryption key in key secret_key; otherwise -db-fields-encryption is generated. Cannot change on an existing platform.

eda

object (open)

advanced: EDA

EDA spec fields (eda.ansible.com/v1alpha1) for the child EDA. Enabled unless disabled=true (the CR is kept and its gateway registration removed); name selects the EDA (an existing one is adopted). With an external database: database_secret and event_stream.database_secret. The fields the platform requires win (shared databases, ui_disabled, ingress_type none, gateway settings).

eda.database_secret

string

External database Secret of the EDA (host, port, database, username, password, type=unmanaged; optional sslmode).

eda.disabled

boolean

eda.event_stream

object (open)

eda.event_stream.database_secret

string

Database Secret of the EDA event stream user (CONNECT only on the EDA database).

eda.name

string

extra_settings

array of object

advanced: Extra Settings

Additional gateway settings (setting/value); stored as YAML in a Secret, never as code.

feature_flags

object

advanced: Feature Flags

Gateway feature flags (FEATURE_* keys); Koios validates every key.

gateway

object

hidden: Deprecated gateway settings

Deprecated. use api.replicas, api.resource_requirements, image, image_version, image_proxy and image_proxy_version, as in AnsibleAutomationPlatform. Accepted as an alias; values that contradict the new fields fail the reconciliation.

gateway.envoy_image

string

gateway.envoy_image_version

string

gateway.image

string

gateway.image_version

string

gateway.replicas

integer

1

gateway.resource_requirements

object (open)

hostname

string

advanced: Hostname

Public hostname of the platform (Ingress, LoadBalancer or external proxy).

hub

object (open)

advanced: Hub

Galaxy spec fields (galaxy.ansible.com/v1beta1, galaxy-operator) for the child Hub. Enabled unless disabled=true (the CR is kept and its gateway registration removed); name selects the Galaxy (an existing one is adopted). With an external database: database_secret. The fields the platform requires win (shared database, ingress_type none, gateway pulp_settings).

hub.database_secret

string

External database Secret of the automation hub (host, port, database, username, password, type=unmanaged; optional sslmode).

hub.disabled

boolean

hub.name

string

idle_aap

boolean

hidden: Idle Koios Automation Platform

Scale down the platform to put it into idle mode: gateway, Redis and, unless database.idle_disabled, the managed PostgreSQL to 0 and controller, EDA and Hub with idle_deployment. Data is kept; set false to resume.

image

string

hidden: Gateway Image

Gateway container image

image_proxy

string

hidden: Gateway Proxy Image

Gateway Proxy container image

image_proxy_version

string

hidden: Gateway Proxy Image Version

Gateway Proxy container image version (tag)

image_pull_policy

string

Always, always, Never, never, IfNotPresent, ifnotpresent

advanced: Image Pull Policy

The image pull policy

image_pull_secrets

array of string

advanced: Image Pull Secrets

Existing image pull Secrets; propagated to every component, including job pods.

image_version

string

hidden: Gateway Image Version

Gateway container image version (tag)

ingress

object

hidden: Deprecated ingress settings

Deprecated. use ingress_type, service_type, hostname, ingress_class_name and ingress_tls_secret, as in AnsibleAutomationPlatform. Accepted as an alias; values that contradict the new fields fail the reconciliation.

ingress.hostname

string

ingress.ingress_class

string

ingress.tls_secret

string

ingress.type

string

none, ingress, loadbalancer

ingress_annotations

string

advanced: Ingress annotations

Ingress annotations (YAML block of key: value).

ingress_api_version

string

advanced: Ingress API Version

Ingress API version (networking.k8s.io/v1).

ingress_class_name

string

advanced: Ingress Class Name

IngressClass; empty uses the cluster default.

ingress_path

string

advanced: Ingress Path

Ingress path (/).

ingress_path_type

string

advanced: Ingress Path Type

Ingress pathType (Prefix).

ingress_tls_secret

string

advanced: Ingress TLS secret

Ingress TLS Secret (provided by the user; never managed by the operator).

ingress_type

string

none, Ingress, ingress, Route, route

form: Ingress type

Ingress type: none, Ingress or Route. Defaults to Route on OpenShift and none on Kubernetes.

loadbalancer_port

integer

advanced: LoadBalancer Port

Additional LoadBalancer port (80 by default; port 80 is always published).

loadbalancer_protocol

string

http, https

advanced: LoadBalancer Protocol

LoadBalancer protocol (http by default).

no_log

boolean

True

advanced: No Log Configuration

Hide sensitive values in the operator log; only disable for debugging.

nodeport_port

integer

advanced: NodePort Port

Fixed nodePort with service_type NodePort.

postgres_image

string

hidden: PostgreSQL Image

Registry path to the PostgreSQL container to use

postgres_image_version

string

hidden: PostgreSQL Image Version

PostgreSQL container image version to use

proxy

object

Gateway proxy (Envoy) container.

proxy.concurrency

integer

Number of Envoy worker threads. 0 means one per CPU core (Envoy default). Set this to limit worker threads on high-core-count nodes.

proxy.resource_requirements

object

Resource requirements for the gateway proxy container.

proxy.resource_requirements.limits

object

proxy.resource_requirements.limits.cpu

string

proxy.resource_requirements.limits.memory

string

proxy.resource_requirements.limits.storage

string

proxy.resource_requirements.requests

object

proxy.resource_requirements.requests.cpu

string

proxy.resource_requirements.requests.memory

string

proxy.resource_requirements.requests.storage

string

proxy.security_context

object (open)

Settings to apply to the securityContext field of the proxy container.

public_base_url

string

hidden: Public Base URL for Koios Automation Platform

Public base URL of the platform (the edge: Route, Ingress or LoadBalancer).

redis

object

advanced: Redis deployment configuration

Shared Redis with one ACL user per component.

redis.eda_redis_secret

string

hidden: External EDA redis configuration secret (Deprecated)

Deprecated. This field is ignored. Redis is no longer used by EDA. EDA now uses dispatcherd (backed by PostgreSQL). It will be removed in a future apiVersion.

redis.image

string

hidden: Deprecated Redis Image

redis.image_version

string

hidden: Deprecated Redis Image Version

redis.mode

string

cluster, standalone

hidden: Deprecated Redis Mode

redis.node_selector

object

advanced: Node Selector

NodeSelector for the Redis pods.

redis.redis_secret

string

advanced: External redis configuration secret

Secret of your own external Redis for the gateway: host, port, password and optional username, redis_tls (true/false), redis_ssl_cert_reqs (none, optional, required) and redis_mode (standalone or cluster). The operator then does not deploy Redis. With TLS, trust a private CA with bundle_cacert_secret.

redis.replicas

integer

form: Replicas

Defines Redis Deployment replicas

redis.resource_requirements

object

advanced: Redis deployment resource requirements

Resource requirements for the Redis container

redis.resource_requirements.claims

array of object

Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable.

redis.resource_requirements.limits

object

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

redis.resource_requirements.requests

object

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. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

redis.security_context

object (open)

advanced: Redis Security Context

Settings to apply to the securityContext field of the redis container.

redis.strategy

object

hidden: Strategy

Accepted for compatibility and not used. The managed Redis is a single-replica StatefulSet.

redis.strategy.rollingUpdate

object

Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate. — TODO: Update this to follow our convention for oneOf, whatever we decide it to be.

redis.strategy.rollingUpdate.maxSurge

integer or string

The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.

redis.strategy.rollingUpdate.maxUnavailable

integer or string

The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.

redis.strategy.type

string

Type of deployment. Can be “Recreate” or “RollingUpdate”. Default is RollingUpdate.

redis.tolerations

array of object

advanced: Tolerations

Node tolerations for the Redis pods.

redis_image

string

hidden: Redis Image

Registry path to the redis container to use

redis_image_version

string

hidden: Redis Image Version

Redis container image version to use

redis_mode

string

cluster, standalone

advanced: Redis Mode

Redis mode: standalone (one pod, default) or cluster (six Valkey nodes: three masters and three replicas).

route_annotations

string

form: Route Annotations

Route annotations (YAML block of key: value).

route_api_version

string

advanced: Route API Version

Route API version (route.openshift.io/v1).

route_host

string

form: Route Host

Route host; empty lets OpenShift assign it.

route_tls_secret

string

advanced: Route TLS credential secret

Secret with tls.crt, tls.key and optionally ca.crt for the Route.

route_tls_termination_mechanism

string

Edge, edge, Passthrough, passthrough

advanced: Route TLS termination mechanism

Route TLS termination: Edge. Passthrough is not supported (Envoy does not serve TLS).

service_account_annotations

string

advanced: Service Account Annotations

ServiceAccount annotations

service_annotations

string

advanced: LoadBalancer Service Annotations

Gateway Service annotations (YAML block of key: value).

service_type

string

ClusterIP, clusterip, LoadBalancer, loadbalancer, NodePort, nodeport

form: Service Type

Gateway Service type: ClusterIP (default), LoadBalancer or NodePort.

ui

object

hidden: Platform UI

ui.enabled

boolean

True

ui.image

string

ui.image_version

string