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 |
|---|---|---|---|---|---|
|
string |
advanced: Admin E-mail Address |
Administrator email used when creating it. |
||
|
string |
advanced: Admin Password Secret |
User Secret with the admin password in key password; otherwise |
||
|
string |
advanced: Admin Account Username |
Platform administrator username (admin by default). Created once; changing it creates another admin. |
||
|
object |
advanced: API deployment configuration |
Gateway deployment (Jewel api container). Replaces spec.gateway.replicas/resource_requirements. |
||
|
string |
|
|
The log level for the deployment. |
|
|
object |
advanced: Node Selector |
NodeSelector for the gateway pods. |
||
|
integer |
|
form: Replicas |
The number of replicas for the deployment. |
|
|
object |
form: API server resource requirements |
Resource requirements for the galaxy api container |
||
|
object |
||||
|
string |
||||
|
string |
||||
|
string |
||||
|
object |
||||
|
string |
||||
|
string |
||||
|
string |
||||
|
object (open) |
advanced: Security Context |
Settings to apply to the securityContext field of the api container. |
||
|
object |
advanced: Strategy |
The deployment strategy to use to replace existing pods with new ones. |
||
|
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. |
|||
|
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. |
|||
|
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. |
|||
|
string |
Type of deployment. Can be “Recreate” or “RollingUpdate”. Default is RollingUpdate. |
|||
|
array of object |
advanced: Tolerations |
Node tolerations for the gateway pods. |
||
|
array of object |
advanced: Topology Spread Constraints |
Topology rule(s) for the pods. |
||
|
string |
advanced: Bundle Certificate Authority Secret |
Secret with bundle-ca.crt: CA trusted by the gateway and, by default, by controller, EDA and Hub. |
||
|
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. |
||
|
string |
External database Secret of the controller (host, port, database, username, password, type=unmanaged; optional sslmode). |
|||
|
object |
advanced: PostgreSQL Database configuration |
Shared platform PostgreSQL, one user per component. |
||
|
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. |
||
|
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. |
||
|
boolean |
|
advanced: Database Idle Disabled |
When true, idle_aap keeps the managed PostgreSQL running. |
|
|
string |
hidden: Deprecated PostgreSQL Image |
|||
|
string |
hidden: Deprecated PostgreSQL Image Version |
Tag or sha256: |
||
|
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. |
||
|
object |
NodeSelector for the database pod. |
|||
|
array of object |
hidden: Postgres Extra Settings |
PostgreSQL configuration settings to be added to postgresql.conf |
||
|
string |
|
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. |
|
|
string |
advanced: Database Storage Class |
Storage class to use for the PostgreSQL PVC |
||
|
string |
Assign a pre-existing priority class to the postgres pod |
|||
|
object |
form: Database resource requirements |
Resource requirements for the database container. |
||
|
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. |
|||
|
object |
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|||
|
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/ |
|||
|
string |
hidden: Deprecated Database Storage Class |
|||
|
object |
form: Database Storage Requirements |
Storage requirements for the PostgreSQL container |
||
|
object |
||||
|
string |
||||
|
object |
||||
|
string |
||||
|
string |
hidden: Deprecated Database Storage Size |
|||
|
array of object |
Node tolerations for the database pod. |
|||
|
string |
advanced: DB Fields Encryption Key |
User Secret with the field encryption key in key secret_key; otherwise |
||
|
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). |
||
|
string |
External database Secret of the EDA (host, port, database, username, password, type=unmanaged; optional sslmode). |
|||
|
boolean |
||||
|
object (open) |
||||
|
string |
Database Secret of the EDA event stream user (CONNECT only on the EDA database). |
|||
|
string |
||||
|
array of object |
advanced: Extra Settings |
Additional gateway settings (setting/value); stored as YAML in a Secret, never as code. |
||
|
object |
advanced: Feature Flags |
Gateway feature flags (FEATURE_* keys); Koios validates every key. |
||
|
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. |
||
|
string |
||||
|
string |
||||
|
string |
||||
|
string |
||||
|
integer |
|
|||
|
object (open) |
||||
|
string |
advanced: Hostname |
Public hostname of the platform (Ingress, LoadBalancer or external proxy). |
||
|
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). |
||
|
string |
External database Secret of the automation hub (host, port, database, username, password, type=unmanaged; optional sslmode). |
|||
|
boolean |
||||
|
string |
||||
|
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. |
||
|
string |
hidden: Gateway Image |
Gateway container image |
||
|
string |
hidden: Gateway Proxy Image |
Gateway Proxy container image |
||
|
string |
hidden: Gateway Proxy Image Version |
Gateway Proxy container image version (tag) |
||
|
string |
|
advanced: Image Pull Policy |
The image pull policy |
|
|
array of string |
advanced: Image Pull Secrets |
Existing image pull Secrets; propagated to every component, including job pods. |
||
|
string |
hidden: Gateway Image Version |
Gateway container image version (tag) |
||
|
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. |
||
|
string |
||||
|
string |
||||
|
string |
||||
|
string |
|
|||
|
string |
advanced: Ingress annotations |
Ingress annotations (YAML block of key: value). |
||
|
string |
advanced: Ingress API Version |
Ingress API version (networking.k8s.io/v1). |
||
|
string |
advanced: Ingress Class Name |
IngressClass; empty uses the cluster default. |
||
|
string |
advanced: Ingress Path |
Ingress path (/). |
||
|
string |
advanced: Ingress Path Type |
Ingress pathType (Prefix). |
||
|
string |
advanced: Ingress TLS secret |
Ingress TLS Secret (provided by the user; never managed by the operator). |
||
|
string |
|
form: Ingress type |
Ingress type: none, Ingress or Route. Defaults to Route on OpenShift and none on Kubernetes. |
|
|
integer |
advanced: LoadBalancer Port |
Additional LoadBalancer port (80 by default; port 80 is always published). |
||
|
string |
|
advanced: LoadBalancer Protocol |
LoadBalancer protocol (http by default). |
|
|
boolean |
|
advanced: No Log Configuration |
Hide sensitive values in the operator log; only disable for debugging. |
|
|
integer |
advanced: NodePort Port |
Fixed nodePort with service_type NodePort. |
||
|
string |
hidden: PostgreSQL Image |
Registry path to the PostgreSQL container to use |
||
|
string |
hidden: PostgreSQL Image Version |
PostgreSQL container image version to use |
||
|
object |
Gateway proxy (Envoy) container. |
|||
|
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. |
|||
|
object |
Resource requirements for the gateway proxy container. |
|||
|
object |
||||
|
string |
||||
|
string |
||||
|
string |
||||
|
object |
||||
|
string |
||||
|
string |
||||
|
string |
||||
|
object (open) |
Settings to apply to the securityContext field of the proxy container. |
|||
|
string |
hidden: Public Base URL for Koios Automation Platform |
Public base URL of the platform (the edge: Route, Ingress or LoadBalancer). |
||
|
object |
advanced: Redis deployment configuration |
Shared Redis with one ACL user per component. |
||
|
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. |
||
|
string |
hidden: Deprecated Redis Image |
|||
|
string |
hidden: Deprecated Redis Image Version |
|||
|
string |
|
hidden: Deprecated Redis Mode |
||
|
object |
advanced: Node Selector |
NodeSelector for the Redis pods. |
||
|
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. |
||
|
integer |
form: Replicas |
Defines Redis Deployment replicas |
||
|
object |
advanced: Redis deployment resource requirements |
Resource requirements for the Redis container |
||
|
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. |
|||
|
object |
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|||
|
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/ |
|||
|
object (open) |
advanced: Redis Security Context |
Settings to apply to the securityContext field of the redis container. |
||
|
object |
hidden: Strategy |
Accepted for compatibility and not used. The managed Redis is a single-replica StatefulSet. |
||
|
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. |
|||
|
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. |
|||
|
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. |
|||
|
string |
Type of deployment. Can be “Recreate” or “RollingUpdate”. Default is RollingUpdate. |
|||
|
array of object |
advanced: Tolerations |
Node tolerations for the Redis pods. |
||
|
string |
hidden: Redis Image |
Registry path to the redis container to use |
||
|
string |
hidden: Redis Image Version |
Redis container image version to use |
||
|
string |
|
advanced: Redis Mode |
Redis mode: standalone (one pod, default) or cluster (six Valkey nodes: three masters and three replicas). |
|
|
string |
form: Route Annotations |
Route annotations (YAML block of key: value). |
||
|
string |
advanced: Route API Version |
Route API version (route.openshift.io/v1). |
||
|
string |
form: Route Host |
Route host; empty lets OpenShift assign it. |
||
|
string |
advanced: Route TLS credential secret |
Secret with tls.crt, tls.key and optionally ca.crt for the Route. |
||
|
string |
|
advanced: Route TLS termination mechanism |
Route TLS termination: Edge. Passthrough is not supported (Envoy does not serve TLS). |
|
|
string |
advanced: Service Account Annotations |
ServiceAccount annotations |
||
|
string |
advanced: LoadBalancer Service Annotations |
Gateway Service annotations (YAML block of key: value). |
||
|
string |
|
form: Service Type |
Gateway Service type: ClusterIP (default), LoadBalancer or NodePort. |
|
|
object |
hidden: Platform UI |
|||
|
boolean |
|
|||
|
string |
||||
|
string |