From bd1ace1d375bb681fc990b63645c9ae86fe9a2c6 Mon Sep 17 00:00:00 2001 From: Fabien Lassagne <77050098+flassagn@users.noreply.github.com> Date: Mon, 21 Oct 2024 15:29:20 +0200 Subject: [PATCH] [UI-3090] feat(crds): add '0.21.0' aiven.io schemas (#400) --- aiven.io/cassandra_v1alpha1.json | 450 +++++++ aiven.io/clickhouse_v1alpha1.json | 442 +++++++ aiven.io/clickhousedatabase_v1alpha1.json | 154 +++ aiven.io/clickhousegrant_v1alpha1.json | 247 ++++ aiven.io/clickhouserole_v1alpha1.json | 148 +++ aiven.io/clickhouseuser_v1alpha1.json | 209 ++++ aiven.io/connectionpool_v1alpha1.json | 218 ++++ aiven.io/database_v1alpha1.json | 165 +++ aiven.io/kafka_v1alpha1.json | 1089 ++++++++++++++++ aiven.io/kafkaacl_v1alpha1.json | 163 +++ aiven.io/kafkaconnect_v1alpha1.json | 539 ++++++++ aiven.io/kafkaconnector_v1alpha1.json | 222 ++++ aiven.io/kafkaschema_v1alpha1.json | 166 +++ aiven.io/kafkaschemaregistryacl_v1alpha1.json | 180 +++ aiven.io/kafkatopic_v1alpha1.json | 324 +++++ aiven.io/mysql_v1alpha1.json | 726 +++++++++++ aiven.io/opensearch_v1alpha1.json | 1032 ++++++++++++++++ aiven.io/postgresql_v1alpha1.json | 1096 +++++++++++++++++ aiven.io/project_v1alpha1.json | 278 +++++ aiven.io/projectvpc_v1alpha1.json | 158 +++ aiven.io/redis_v1alpha1.json | 561 +++++++++ aiven.io/serviceintegration_v1alpha1.json | 896 ++++++++++++++ .../serviceintegrationendpoint_v1alpha1.json | 727 +++++++++++ aiven.io/serviceuser_v1alpha1.json | 205 +++ 24 files changed, 10395 insertions(+) create mode 100644 aiven.io/cassandra_v1alpha1.json create mode 100644 aiven.io/clickhouse_v1alpha1.json create mode 100644 aiven.io/clickhousedatabase_v1alpha1.json create mode 100644 aiven.io/clickhousegrant_v1alpha1.json create mode 100644 aiven.io/clickhouserole_v1alpha1.json create mode 100644 aiven.io/clickhouseuser_v1alpha1.json create mode 100644 aiven.io/connectionpool_v1alpha1.json create mode 100644 aiven.io/database_v1alpha1.json create mode 100644 aiven.io/kafka_v1alpha1.json create mode 100644 aiven.io/kafkaacl_v1alpha1.json create mode 100644 aiven.io/kafkaconnect_v1alpha1.json create mode 100644 aiven.io/kafkaconnector_v1alpha1.json create mode 100644 aiven.io/kafkaschema_v1alpha1.json create mode 100644 aiven.io/kafkaschemaregistryacl_v1alpha1.json create mode 100644 aiven.io/kafkatopic_v1alpha1.json create mode 100644 aiven.io/mysql_v1alpha1.json create mode 100644 aiven.io/opensearch_v1alpha1.json create mode 100644 aiven.io/postgresql_v1alpha1.json create mode 100644 aiven.io/project_v1alpha1.json create mode 100644 aiven.io/projectvpc_v1alpha1.json create mode 100644 aiven.io/redis_v1alpha1.json create mode 100644 aiven.io/serviceintegration_v1alpha1.json create mode 100644 aiven.io/serviceintegrationendpoint_v1alpha1.json create mode 100644 aiven.io/serviceuser_v1alpha1.json diff --git a/aiven.io/cassandra_v1alpha1.json b/aiven.io/cassandra_v1alpha1.json new file mode 100644 index 00000000..26a45e6e --- /dev/null +++ b/aiven.io/cassandra_v1alpha1.json @@ -0,0 +1,450 @@ +{ + "description": "Cassandra is the Schema for the cassandras API.\nInfo \"Exposes secret keys\": `CASSANDRA_HOST`, `CASSANDRA_PORT`, `CASSANDRA_USER`, `CASSANDRA_PASSWORD`, `CASSANDRA_URI`, `CASSANDRA_HOSTS`, `CASSANDRA_CA_CERT`", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "type": "object" + }, + "spec": { + "description": "CassandraSpec defines the desired state of Cassandra", + "properties": { + "authSecretRef": { + "description": "Authentication reference to Aiven token in a secret", + "properties": { + "key": { + "minLength": 1, + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key", + "name" + ], + "type": "object", + "additionalProperties": false + }, + "cloudName": { + "description": "Cloud the service runs in.", + "maxLength": 256, + "type": "string" + }, + "connInfoSecretTarget": { + "description": "Secret configuration.", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Annotations added to the secret", + "type": "object", + "x-kubernetes-preserve-unknown-fields": true + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels added to the secret", + "type": "object", + "x-kubernetes-preserve-unknown-fields": true + }, + "name": { + "description": "Name of the secret resource to be created. By default, it is equal to the resource name", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "prefix": { + "description": "Prefix for the secret's keys.\nAdded \"as is\" without any transformations.\nBy default, is equal to the kind name in uppercase + underscore, e.g. `KAFKA_`, `REDIS_`, etc.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "additionalProperties": false + }, + "connInfoSecretTargetDisabled": { + "description": "When true, the secret containing connection information will not be created, defaults to false. This field cannot be changed after resource creation.", + "type": "boolean", + "x-kubernetes-validations": [ + { + "message": "connInfoSecretTargetDisabled is immutable.", + "rule": "self == oldSelf" + } + ] + }, + "disk_space": { + "description": "The disk space of the service, possible values depend on the service type, the cloud provider and the project.\nReducing will result in the service re-balancing.\nThe removal of this field does not change the value.", + "pattern": "(?i)^[1-9][0-9]*(GiB|G)?$", + "type": "string" + }, + "maintenanceWindowDow": { + "description": "Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.", + "enum": [ + "monday", + "tuesday", + "wednesday", + "thursday", + "friday", + "saturday", + "sunday" + ], + "type": "string" + }, + "maintenanceWindowTime": { + "description": "Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.", + "maxLength": 8, + "type": "string" + }, + "plan": { + "description": "Subscription plan.", + "maxLength": 128, + "type": "string" + }, + "project": { + "description": "Identifies the project this resource belongs to", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "projectVPCRef": { + "description": "ProjectVPCRef reference to ProjectVPC resource to use its ID as ProjectVPCID automatically", + "properties": { + "name": { + "minLength": 1, + "type": "string" + }, + "namespace": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "additionalProperties": false + }, + "projectVpcId": { + "description": "Identifier of the VPC the service should be in, if any.", + "maxLength": 36, + "type": "string" + }, + "serviceIntegrations": { + "description": "Service integrations to specify when creating a service. Not applied after initial service creation", + "items": { + "description": "Service integrations to specify when creating a service. Not applied after initial service creation", + "properties": { + "integrationType": { + "enum": [ + "read_replica" + ], + "type": "string" + }, + "sourceServiceName": { + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "integrationType", + "sourceServiceName" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 1, + "type": "array", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Tags are key-value pairs that allow you to categorize services.", + "type": "object" + }, + "technicalEmails": { + "description": "Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability.", + "items": { + "properties": { + "email": { + "description": "Email address.", + "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", + "type": "string" + } + }, + "required": [ + "email" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 10, + "type": "array" + }, + "terminationProtection": { + "description": "Prevent service from being deleted. It is recommended to have this enabled for all services.", + "type": "boolean" + }, + "userConfig": { + "description": "Cassandra specific user configuration options", + "properties": { + "additional_backup_regions": { + "description": "Deprecated. Additional Cloud Regions for Backup Replication", + "items": { + "type": "string" + }, + "maxItems": 1, + "type": "array" + }, + "backup_hour": { + "description": "The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed.", + "maximum": 23, + "minimum": 0, + "type": "integer" + }, + "backup_minute": { + "description": "The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed.", + "maximum": 59, + "minimum": 0, + "type": "integer" + }, + "cassandra": { + "description": "cassandra configuration values", + "properties": { + "batch_size_fail_threshold_in_kb": { + "description": "Fail any multiple-partition batch exceeding this value. 50kb (10x warn threshold) by default.", + "maximum": 1000000, + "minimum": 1, + "type": "integer" + }, + "batch_size_warn_threshold_in_kb": { + "description": "Log a warning message on any multiple-partition batch size exceeding this value.5kb per batch by default.Caution should be taken on increasing the size of this thresholdas it can lead to node instability.", + "maximum": 1000000, + "minimum": 1, + "type": "integer" + }, + "datacenter": { + "description": "Name of the datacenter to which nodes of this service belong. Can be set only when creating the service.", + "maxLength": 128, + "type": "string" + } + }, + "type": "object", + "additionalProperties": false + }, + "cassandra_version": { + "description": "Cassandra version", + "enum": [ + "4", + "4.1" + ], + "pattern": "^[0-9]+(\\.[0-9]+)?$", + "type": "string" + }, + "ip_filter": { + "description": "Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'", + "items": { + "description": "CIDR address block, either as a string, or in a dict with an optional description field", + "properties": { + "description": { + "description": "Description for IP filter list entry", + "maxLength": 1024, + "type": "string" + }, + "network": { + "description": "CIDR address block", + "maxLength": 43, + "type": "string" + } + }, + "required": [ + "network" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 1024, + "type": "array" + }, + "migrate_sstableloader": { + "description": "Sets the service into migration mode enabling the sstableloader utility to be used to upload Cassandra data files. Available only on service create.", + "type": "boolean" + }, + "private_access": { + "description": "Allow access to selected service ports from private networks", + "properties": { + "prometheus": { + "description": "Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "project_to_fork_from": { + "description": "Name of another project to fork a service from. This has effect only when a new service is being created.", + "maxLength": 63, + "pattern": "^[a-z][-a-z0-9]{0,63}$|^$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "public_access": { + "description": "Allow access to selected service ports from the public Internet", + "properties": { + "prometheus": { + "description": "Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "service_log": { + "description": "Store logs for the service so that they are available in the HTTP API and console.", + "type": "boolean" + }, + "service_to_fork_from": { + "description": "Name of another service to fork from. This has effect only when a new service is being created.", + "maxLength": 64, + "pattern": "^[a-z][-a-z0-9]{0,63}$|^$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "service_to_join_with": { + "description": "When bootstrapping, instead of creating a new Cassandra cluster try to join an existing one from another service. Can only be set on service creation.", + "maxLength": 64, + "pattern": "^[a-z][-a-z0-9]{0,63}$", + "type": "string" + }, + "static_ips": { + "description": "Use static public IP addresses", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + } + }, + "required": [ + "plan", + "project" + ], + "type": "object", + "x-kubernetes-validations": [ + { + "message": "connInfoSecretTargetDisabled can only be set during resource creation.", + "rule": "has(oldSelf.connInfoSecretTargetDisabled) == has(self.connInfoSecretTargetDisabled)" + } + ], + "additionalProperties": false + }, + "status": { + "description": "ServiceStatus defines the observed state of service", + "properties": { + "conditions": { + "description": "Conditions represent the latest available observations of a service state", + "items": { + "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}", + "properties": { + "lastTransitionTime": { + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis 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", + "type": "string" + }, + "message": { + "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", + "maxLength": 32768, + "type": "string" + }, + "observedGeneration": { + "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "reason": { + "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", + "type": "string" + }, + "status": { + "description": "status of the condition, one of True, False, Unknown.", + "enum": [ + "True", + "False", + "Unknown" + ], + "type": "string" + }, + "type": { + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", + "type": "string" + } + }, + "required": [ + "lastTransitionTime", + "message", + "reason", + "status", + "type" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + }, + "state": { + "description": "Service state", + "type": "string" + } + }, + "type": "object", + "additionalProperties": false + } + }, + "type": "object" +} diff --git a/aiven.io/clickhouse_v1alpha1.json b/aiven.io/clickhouse_v1alpha1.json new file mode 100644 index 00000000..a1886e7b --- /dev/null +++ b/aiven.io/clickhouse_v1alpha1.json @@ -0,0 +1,442 @@ +{ + "description": "Clickhouse is the Schema for the clickhouses API.\nInfo \"Exposes secret keys\": `CLICKHOUSE_HOST`, `CLICKHOUSE_PORT`, `CLICKHOUSE_USER`, `CLICKHOUSE_PASSWORD`", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "type": "object" + }, + "spec": { + "description": "ClickhouseSpec defines the desired state of Clickhouse", + "properties": { + "authSecretRef": { + "description": "Authentication reference to Aiven token in a secret", + "properties": { + "key": { + "minLength": 1, + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key", + "name" + ], + "type": "object", + "additionalProperties": false + }, + "cloudName": { + "description": "Cloud the service runs in.", + "maxLength": 256, + "type": "string" + }, + "connInfoSecretTarget": { + "description": "Secret configuration.", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Annotations added to the secret", + "type": "object", + "x-kubernetes-preserve-unknown-fields": true + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels added to the secret", + "type": "object", + "x-kubernetes-preserve-unknown-fields": true + }, + "name": { + "description": "Name of the secret resource to be created. By default, it is equal to the resource name", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "prefix": { + "description": "Prefix for the secret's keys.\nAdded \"as is\" without any transformations.\nBy default, is equal to the kind name in uppercase + underscore, e.g. `KAFKA_`, `REDIS_`, etc.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "additionalProperties": false + }, + "connInfoSecretTargetDisabled": { + "description": "When true, the secret containing connection information will not be created, defaults to false. This field cannot be changed after resource creation.", + "type": "boolean", + "x-kubernetes-validations": [ + { + "message": "connInfoSecretTargetDisabled is immutable.", + "rule": "self == oldSelf" + } + ] + }, + "disk_space": { + "description": "The disk space of the service, possible values depend on the service type, the cloud provider and the project.\nReducing will result in the service re-balancing.\nThe removal of this field does not change the value.", + "pattern": "(?i)^[1-9][0-9]*(GiB|G)?$", + "type": "string" + }, + "maintenanceWindowDow": { + "description": "Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.", + "enum": [ + "monday", + "tuesday", + "wednesday", + "thursday", + "friday", + "saturday", + "sunday" + ], + "type": "string" + }, + "maintenanceWindowTime": { + "description": "Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.", + "maxLength": 8, + "type": "string" + }, + "plan": { + "description": "Subscription plan.", + "maxLength": 128, + "type": "string" + }, + "project": { + "description": "Identifies the project this resource belongs to", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "projectVPCRef": { + "description": "ProjectVPCRef reference to ProjectVPC resource to use its ID as ProjectVPCID automatically", + "properties": { + "name": { + "minLength": 1, + "type": "string" + }, + "namespace": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "additionalProperties": false + }, + "projectVpcId": { + "description": "Identifier of the VPC the service should be in, if any.", + "maxLength": 36, + "type": "string" + }, + "serviceIntegrations": { + "description": "Service integrations to specify when creating a service. Not applied after initial service creation", + "items": { + "description": "Service integrations to specify when creating a service. Not applied after initial service creation", + "properties": { + "integrationType": { + "enum": [ + "read_replica" + ], + "type": "string" + }, + "sourceServiceName": { + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "integrationType", + "sourceServiceName" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 1, + "type": "array", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Tags are key-value pairs that allow you to categorize services.", + "type": "object" + }, + "technicalEmails": { + "description": "Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability.", + "items": { + "properties": { + "email": { + "description": "Email address.", + "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", + "type": "string" + } + }, + "required": [ + "email" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 10, + "type": "array" + }, + "terminationProtection": { + "description": "Prevent service from being deleted. It is recommended to have this enabled for all services.", + "type": "boolean" + }, + "userConfig": { + "description": "OpenSearch specific user configuration options", + "properties": { + "additional_backup_regions": { + "description": "Deprecated. Additional Cloud Regions for Backup Replication", + "items": { + "type": "string" + }, + "maxItems": 1, + "type": "array" + }, + "ip_filter": { + "description": "Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'", + "items": { + "description": "CIDR address block, either as a string, or in a dict with an optional description field", + "properties": { + "description": { + "description": "Description for IP filter list entry", + "maxLength": 1024, + "type": "string" + }, + "network": { + "description": "CIDR address block", + "maxLength": 43, + "type": "string" + } + }, + "required": [ + "network" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 1024, + "type": "array" + }, + "private_access": { + "description": "Allow access to selected service ports from private networks", + "properties": { + "clickhouse": { + "description": "Allow clients to connect to clickhouse with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations", + "type": "boolean" + }, + "clickhouse_https": { + "description": "Allow clients to connect to clickhouse_https with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations", + "type": "boolean" + }, + "clickhouse_mysql": { + "description": "Allow clients to connect to clickhouse_mysql with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations", + "type": "boolean" + }, + "prometheus": { + "description": "Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "privatelink_access": { + "description": "Allow access to selected service components through Privatelink", + "properties": { + "clickhouse": { + "description": "Enable clickhouse", + "type": "boolean" + }, + "clickhouse_https": { + "description": "Enable clickhouse_https", + "type": "boolean" + }, + "clickhouse_mysql": { + "description": "Enable clickhouse_mysql", + "type": "boolean" + }, + "prometheus": { + "description": "Enable prometheus", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "project_to_fork_from": { + "description": "Name of another project to fork a service from. This has effect only when a new service is being created.", + "maxLength": 63, + "pattern": "^[a-z][-a-z0-9]{0,63}$|^$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "public_access": { + "description": "Allow access to selected service ports from the public Internet", + "properties": { + "clickhouse": { + "description": "Allow clients to connect to clickhouse from the public internet for service nodes that are in a project VPC or another type of private network", + "type": "boolean" + }, + "clickhouse_https": { + "description": "Allow clients to connect to clickhouse_https from the public internet for service nodes that are in a project VPC or another type of private network", + "type": "boolean" + }, + "clickhouse_mysql": { + "description": "Allow clients to connect to clickhouse_mysql from the public internet for service nodes that are in a project VPC or another type of private network", + "type": "boolean" + }, + "prometheus": { + "description": "Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "service_log": { + "description": "Store logs for the service so that they are available in the HTTP API and console.", + "type": "boolean" + }, + "service_to_fork_from": { + "description": "Name of another service to fork from. This has effect only when a new service is being created.", + "maxLength": 64, + "pattern": "^[a-z][-a-z0-9]{0,63}$|^$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "static_ips": { + "description": "Use static public IP addresses", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + } + }, + "required": [ + "plan", + "project" + ], + "type": "object", + "x-kubernetes-validations": [ + { + "message": "connInfoSecretTargetDisabled can only be set during resource creation.", + "rule": "has(oldSelf.connInfoSecretTargetDisabled) == has(self.connInfoSecretTargetDisabled)" + } + ], + "additionalProperties": false + }, + "status": { + "description": "ServiceStatus defines the observed state of service", + "properties": { + "conditions": { + "description": "Conditions represent the latest available observations of a service state", + "items": { + "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}", + "properties": { + "lastTransitionTime": { + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis 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", + "type": "string" + }, + "message": { + "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", + "maxLength": 32768, + "type": "string" + }, + "observedGeneration": { + "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "reason": { + "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", + "type": "string" + }, + "status": { + "description": "status of the condition, one of True, False, Unknown.", + "enum": [ + "True", + "False", + "Unknown" + ], + "type": "string" + }, + "type": { + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", + "type": "string" + } + }, + "required": [ + "lastTransitionTime", + "message", + "reason", + "status", + "type" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + }, + "state": { + "description": "Service state", + "type": "string" + } + }, + "type": "object", + "additionalProperties": false + } + }, + "type": "object" +} diff --git a/aiven.io/clickhousedatabase_v1alpha1.json b/aiven.io/clickhousedatabase_v1alpha1.json new file mode 100644 index 00000000..8415ebe8 --- /dev/null +++ b/aiven.io/clickhousedatabase_v1alpha1.json @@ -0,0 +1,154 @@ +{ + "description": "ClickhouseDatabase is the Schema for the databases API", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "type": "object" + }, + "spec": { + "description": "ClickhouseDatabaseSpec defines the desired state of ClickhouseDatabase", + "properties": { + "authSecretRef": { + "description": "Authentication reference to Aiven token in a secret", + "properties": { + "key": { + "minLength": 1, + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key", + "name" + ], + "type": "object", + "additionalProperties": false + }, + "databaseName": { + "description": "Specifies the Clickhouse database name. Defaults to `metadata.name` if omitted.\nNote: `metadata.name` is ASCII-only. For UTF-8 names, use `spec.databaseName`, but ASCII is advised for compatibility.", + "maxLength": 63, + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "project": { + "description": "Identifies the project this resource belongs to", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "serviceName": { + "description": "Specifies the name of the service that this resource belongs to", + "maxLength": 63, + "pattern": "^[a-z][-a-z0-9]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + } + }, + "required": [ + "project", + "serviceName" + ], + "type": "object", + "x-kubernetes-validations": [ + { + "message": "databaseName is required once set", + "rule": "!has(oldSelf.databaseName) || has(self.databaseName)" + } + ], + "additionalProperties": false + }, + "status": { + "description": "ClickhouseDatabaseStatus defines the observed state of ClickhouseDatabase", + "properties": { + "conditions": { + "description": "Conditions represent the latest available observations of an ClickhouseDatabase state", + "items": { + "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}", + "properties": { + "lastTransitionTime": { + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis 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", + "type": "string" + }, + "message": { + "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", + "maxLength": 32768, + "type": "string" + }, + "observedGeneration": { + "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "reason": { + "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", + "type": "string" + }, + "status": { + "description": "status of the condition, one of True, False, Unknown.", + "enum": [ + "True", + "False", + "Unknown" + ], + "type": "string" + }, + "type": { + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", + "type": "string" + } + }, + "required": [ + "lastTransitionTime", + "message", + "reason", + "status", + "type" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + } + }, + "required": [ + "conditions" + ], + "type": "object", + "additionalProperties": false + } + }, + "type": "object" +} diff --git a/aiven.io/clickhousegrant_v1alpha1.json b/aiven.io/clickhousegrant_v1alpha1.json new file mode 100644 index 00000000..36e5e117 --- /dev/null +++ b/aiven.io/clickhousegrant_v1alpha1.json @@ -0,0 +1,247 @@ +{ + "description": "ClickhouseGrant is the Schema for the ClickhouseGrants API", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "type": "object" + }, + "spec": { + "description": "ClickhouseGrantSpec defines the desired state of ClickhouseGrant", + "properties": { + "authSecretRef": { + "description": "Authentication reference to Aiven token in a secret", + "properties": { + "key": { + "minLength": 1, + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key", + "name" + ], + "type": "object", + "additionalProperties": false + }, + "privilegeGrants": { + "description": "Configuration to grant a privilege. Privileges not in the manifest are revoked. Existing privileges are retained; new ones are granted.", + "items": { + "description": "PrivilegeGrant represents the privileges to be granted to users or roles.\nSee https://clickhouse.com/docs/en/sql-reference/statements/grant#granting-privilege-syntax.", + "properties": { + "columns": { + "description": "The column that the grant refers to.", + "items": { + "type": "string" + }, + "type": "array" + }, + "database": { + "description": "The database that the grant refers to.", + "type": "string" + }, + "grantees": { + "description": "List of grantees (users or roles) to grant the privilege to.", + "items": { + "description": "Grantee represents a user or a role to which privileges or roles are granted.", + "properties": { + "role": { + "type": "string" + }, + "user": { + "type": "string" + } + }, + "type": "object", + "additionalProperties": false + }, + "minItems": 1, + "type": "array" + }, + "privileges": { + "description": "The privileges to grant, i.e. `INSERT`, `SELECT`.\nSee https://clickhouse.com/docs/en/sql-reference/statements/grant#assigning-role-syntax.", + "items": { + "type": "string" + }, + "type": "array" + }, + "table": { + "description": "The tables that the grant refers to. To grant a privilege on all tables in a database, omit this field instead of writing `table: \"*\"`.", + "type": "string" + }, + "withGrantOption": { + "description": "If true, then the grantee (user or role) get the permission to execute the `GRANT` query.\nUsers can grant privileges of the same scope they have and less.\nSee https://clickhouse.com/docs/en/sql-reference/statements/grant#granting-privilege-syntax", + "type": "boolean" + } + }, + "required": [ + "database", + "grantees", + "privileges" + ], + "type": "object", + "x-kubernetes-validations": [ + { + "message": "`table` must be set if `columns` are set", + "rule": "!has(self.columns) || (has(self.columns) && has(self.table))" + } + ], + "additionalProperties": false + }, + "type": "array" + }, + "project": { + "description": "Identifies the project this resource belongs to", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "roleGrants": { + "description": "Configuration to grant a role. Role grants not in the manifest are revoked. Existing role grants are retained; new ones are granted.", + "items": { + "description": "RoleGrant represents the roles to be assigned to users or roles.\nSee https://clickhouse.com/docs/en/sql-reference/statements/grant#assigning-role-syntax.", + "properties": { + "grantees": { + "description": "List of grantees (users or roles) to grant the privilege to.", + "items": { + "description": "Grantee represents a user or a role to which privileges or roles are granted.", + "properties": { + "role": { + "type": "string" + }, + "user": { + "type": "string" + } + }, + "type": "object", + "additionalProperties": false + }, + "minItems": 1, + "type": "array" + }, + "roles": { + "description": "List of roles to grant to the grantees.", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "withAdminOption": { + "description": "If true, the grant is executed with `ADMIN OPTION` privilege.\nSee https://clickhouse.com/docs/en/sql-reference/statements/grant#admin-option.", + "type": "boolean" + } + }, + "required": [ + "grantees", + "roles" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + }, + "serviceName": { + "description": "Specifies the name of the service that this resource belongs to", + "maxLength": 63, + "pattern": "^[a-z][-a-z0-9]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + } + }, + "required": [ + "project", + "serviceName" + ], + "type": "object", + "additionalProperties": false + }, + "status": { + "description": "ClickhouseGrantStatus defines the observed state of ClickhouseGrant", + "properties": { + "conditions": { + "items": { + "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}", + "properties": { + "lastTransitionTime": { + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis 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", + "type": "string" + }, + "message": { + "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", + "maxLength": 32768, + "type": "string" + }, + "observedGeneration": { + "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "reason": { + "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", + "type": "string" + }, + "status": { + "description": "status of the condition, one of True, False, Unknown.", + "enum": [ + "True", + "False", + "Unknown" + ], + "type": "string" + }, + "type": { + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", + "type": "string" + } + }, + "required": [ + "lastTransitionTime", + "message", + "reason", + "status", + "type" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + } + }, + "required": [ + "conditions" + ], + "type": "object", + "additionalProperties": false + } + }, + "type": "object" +} diff --git a/aiven.io/clickhouserole_v1alpha1.json b/aiven.io/clickhouserole_v1alpha1.json new file mode 100644 index 00000000..4247a4ba --- /dev/null +++ b/aiven.io/clickhouserole_v1alpha1.json @@ -0,0 +1,148 @@ +{ + "description": "ClickhouseRole is the Schema for the clickhouseroles API", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "type": "object" + }, + "spec": { + "description": "ClickhouseRoleSpec defines the desired state of ClickhouseRole", + "properties": { + "authSecretRef": { + "description": "Authentication reference to Aiven token in a secret", + "properties": { + "key": { + "minLength": 1, + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key", + "name" + ], + "type": "object", + "additionalProperties": false + }, + "project": { + "description": "Identifies the project this resource belongs to", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "role": { + "description": "The role that is to be created", + "maxLength": 255, + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "serviceName": { + "description": "Specifies the name of the service that this resource belongs to", + "maxLength": 63, + "pattern": "^[a-z][-a-z0-9]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + } + }, + "required": [ + "project", + "role", + "serviceName" + ], + "type": "object", + "additionalProperties": false + }, + "status": { + "description": "ClickhouseRoleStatus defines the observed state of ClickhouseRole", + "properties": { + "conditions": { + "items": { + "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}", + "properties": { + "lastTransitionTime": { + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis 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", + "type": "string" + }, + "message": { + "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", + "maxLength": 32768, + "type": "string" + }, + "observedGeneration": { + "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "reason": { + "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", + "type": "string" + }, + "status": { + "description": "status of the condition, one of True, False, Unknown.", + "enum": [ + "True", + "False", + "Unknown" + ], + "type": "string" + }, + "type": { + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", + "type": "string" + } + }, + "required": [ + "lastTransitionTime", + "message", + "reason", + "status", + "type" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + } + }, + "required": [ + "conditions" + ], + "type": "object", + "additionalProperties": false + } + }, + "type": "object" +} diff --git a/aiven.io/clickhouseuser_v1alpha1.json b/aiven.io/clickhouseuser_v1alpha1.json new file mode 100644 index 00000000..7ab903ed --- /dev/null +++ b/aiven.io/clickhouseuser_v1alpha1.json @@ -0,0 +1,209 @@ +{ + "description": "ClickhouseUser is the Schema for the clickhouseusers API.\nInfo \"Exposes secret keys\": `CLICKHOUSEUSER_HOST`, `CLICKHOUSEUSER_PORT`, `CLICKHOUSEUSER_USER`, `CLICKHOUSEUSER_PASSWORD`", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "type": "object" + }, + "spec": { + "description": "ClickhouseUserSpec defines the desired state of ClickhouseUser", + "properties": { + "authSecretRef": { + "description": "Authentication reference to Aiven token in a secret", + "properties": { + "key": { + "minLength": 1, + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key", + "name" + ], + "type": "object", + "additionalProperties": false + }, + "connInfoSecretTarget": { + "description": "Secret configuration.", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Annotations added to the secret", + "type": "object", + "x-kubernetes-preserve-unknown-fields": true + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels added to the secret", + "type": "object", + "x-kubernetes-preserve-unknown-fields": true + }, + "name": { + "description": "Name of the secret resource to be created. By default, it is equal to the resource name", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "prefix": { + "description": "Prefix for the secret's keys.\nAdded \"as is\" without any transformations.\nBy default, is equal to the kind name in uppercase + underscore, e.g. `KAFKA_`, `REDIS_`, etc.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "additionalProperties": false + }, + "connInfoSecretTargetDisabled": { + "description": "When true, the secret containing connection information will not be created, defaults to false. This field cannot be changed after resource creation.", + "type": "boolean", + "x-kubernetes-validations": [ + { + "message": "connInfoSecretTargetDisabled is immutable.", + "rule": "self == oldSelf" + } + ] + }, + "project": { + "description": "Identifies the project this resource belongs to", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "serviceName": { + "description": "Specifies the name of the service that this resource belongs to", + "maxLength": 63, + "pattern": "^[a-z][-a-z0-9]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "username": { + "description": "Name of the Clickhouse user. Defaults to `metadata.name` if omitted.\nNote: `metadata.name` is ASCII-only. For UTF-8 names, use `spec.username`, but ASCII is advised for compatibility.", + "maxLength": 63, + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + } + }, + "required": [ + "project", + "serviceName" + ], + "type": "object", + "x-kubernetes-validations": [ + { + "message": "connInfoSecretTargetDisabled can only be set during resource creation.", + "rule": "has(oldSelf.connInfoSecretTargetDisabled) == has(self.connInfoSecretTargetDisabled)" + } + ], + "additionalProperties": false + }, + "status": { + "description": "ClickhouseUserStatus defines the observed state of ClickhouseUser", + "properties": { + "conditions": { + "description": "Conditions represent the latest available observations of an ClickhouseUser state", + "items": { + "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}", + "properties": { + "lastTransitionTime": { + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis 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", + "type": "string" + }, + "message": { + "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", + "maxLength": 32768, + "type": "string" + }, + "observedGeneration": { + "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "reason": { + "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", + "type": "string" + }, + "status": { + "description": "status of the condition, one of True, False, Unknown.", + "enum": [ + "True", + "False", + "Unknown" + ], + "type": "string" + }, + "type": { + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", + "type": "string" + } + }, + "required": [ + "lastTransitionTime", + "message", + "reason", + "status", + "type" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + }, + "uuid": { + "description": "Clickhouse user UUID", + "type": "string" + } + }, + "required": [ + "conditions", + "uuid" + ], + "type": "object", + "additionalProperties": false + } + }, + "type": "object" +} diff --git a/aiven.io/connectionpool_v1alpha1.json b/aiven.io/connectionpool_v1alpha1.json new file mode 100644 index 00000000..acc371d3 --- /dev/null +++ b/aiven.io/connectionpool_v1alpha1.json @@ -0,0 +1,218 @@ +{ + "description": "ConnectionPool is the Schema for the connectionpools API.\nInfo \"Exposes secret keys\": `CONNECTIONPOOL_NAME`, `CONNECTIONPOOL_HOST`, `CONNECTIONPOOL_PORT`, `CONNECTIONPOOL_DATABASE`, `CONNECTIONPOOL_USER`, `CONNECTIONPOOL_PASSWORD`, `CONNECTIONPOOL_SSLMODE`, `CONNECTIONPOOL_DATABASE_URI`, `CONNECTIONPOOL_CA_CERT`", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "type": "object" + }, + "spec": { + "description": "ConnectionPoolSpec defines the desired state of ConnectionPool", + "properties": { + "authSecretRef": { + "description": "Authentication reference to Aiven token in a secret", + "properties": { + "key": { + "minLength": 1, + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key", + "name" + ], + "type": "object", + "additionalProperties": false + }, + "connInfoSecretTarget": { + "description": "Secret configuration.", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Annotations added to the secret", + "type": "object", + "x-kubernetes-preserve-unknown-fields": true + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels added to the secret", + "type": "object", + "x-kubernetes-preserve-unknown-fields": true + }, + "name": { + "description": "Name of the secret resource to be created. By default, it is equal to the resource name", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "prefix": { + "description": "Prefix for the secret's keys.\nAdded \"as is\" without any transformations.\nBy default, is equal to the kind name in uppercase + underscore, e.g. `KAFKA_`, `REDIS_`, etc.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "additionalProperties": false + }, + "connInfoSecretTargetDisabled": { + "description": "When true, the secret containing connection information will not be created, defaults to false. This field cannot be changed after resource creation.", + "type": "boolean", + "x-kubernetes-validations": [ + { + "message": "connInfoSecretTargetDisabled is immutable.", + "rule": "self == oldSelf" + } + ] + }, + "databaseName": { + "description": "Name of the database the pool connects to", + "maxLength": 40, + "type": "string" + }, + "poolMode": { + "description": "Mode the pool operates in (session, transaction, statement)", + "enum": [ + "session", + "transaction", + "statement" + ], + "type": "string" + }, + "poolSize": { + "description": "Number of connections the pool may create towards the backend server", + "type": "integer" + }, + "project": { + "description": "Identifies the project this resource belongs to", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "serviceName": { + "description": "Specifies the name of the service that this resource belongs to", + "maxLength": 63, + "pattern": "^[a-z][-a-z0-9]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "username": { + "description": "Name of the service user used to connect to the database", + "maxLength": 64, + "type": "string" + } + }, + "required": [ + "databaseName", + "project", + "serviceName", + "username" + ], + "type": "object", + "x-kubernetes-validations": [ + { + "message": "connInfoSecretTargetDisabled can only be set during resource creation.", + "rule": "has(oldSelf.connInfoSecretTargetDisabled) == has(self.connInfoSecretTargetDisabled)" + } + ], + "additionalProperties": false + }, + "status": { + "description": "ConnectionPoolStatus defines the observed state of ConnectionPool", + "properties": { + "conditions": { + "description": "Conditions represent the latest available observations of an ConnectionPool state", + "items": { + "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}", + "properties": { + "lastTransitionTime": { + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis 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", + "type": "string" + }, + "message": { + "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", + "maxLength": 32768, + "type": "string" + }, + "observedGeneration": { + "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "reason": { + "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", + "type": "string" + }, + "status": { + "description": "status of the condition, one of True, False, Unknown.", + "enum": [ + "True", + "False", + "Unknown" + ], + "type": "string" + }, + "type": { + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", + "type": "string" + } + }, + "required": [ + "lastTransitionTime", + "message", + "reason", + "status", + "type" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + } + }, + "required": [ + "conditions" + ], + "type": "object", + "additionalProperties": false + } + }, + "type": "object" +} diff --git a/aiven.io/database_v1alpha1.json b/aiven.io/database_v1alpha1.json new file mode 100644 index 00000000..6965daad --- /dev/null +++ b/aiven.io/database_v1alpha1.json @@ -0,0 +1,165 @@ +{ + "description": "Database is the Schema for the databases API", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "type": "object" + }, + "spec": { + "description": "DatabaseSpec defines the desired state of Database", + "properties": { + "authSecretRef": { + "description": "Authentication reference to Aiven token in a secret", + "properties": { + "key": { + "minLength": 1, + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key", + "name" + ], + "type": "object", + "additionalProperties": false + }, + "lcCollate": { + "default": "en_US.UTF-8", + "description": "Default string sort order (LC_COLLATE) of the database. Default value: en_US.UTF-8", + "maxLength": 128, + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "lcCtype": { + "default": "en_US.UTF-8", + "description": "Default character classification (LC_CTYPE) of the database. Default value: en_US.UTF-8", + "maxLength": 128, + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "project": { + "description": "Identifies the project this resource belongs to", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "serviceName": { + "description": "Specifies the name of the service that this resource belongs to", + "maxLength": 63, + "pattern": "^[a-z][-a-z0-9]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "terminationProtection": { + "description": "It is a Kubernetes side deletion protections, which prevents the database\nfrom being deleted by Kubernetes. It is recommended to enable this for any production\ndatabases containing critical data.", + "type": "boolean" + } + }, + "required": [ + "project", + "serviceName" + ], + "type": "object", + "additionalProperties": false + }, + "status": { + "description": "DatabaseStatus defines the observed state of Database", + "properties": { + "conditions": { + "description": "Conditions represent the latest available observations of an Database state", + "items": { + "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}", + "properties": { + "lastTransitionTime": { + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis 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", + "type": "string" + }, + "message": { + "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", + "maxLength": 32768, + "type": "string" + }, + "observedGeneration": { + "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "reason": { + "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", + "type": "string" + }, + "status": { + "description": "status of the condition, one of True, False, Unknown.", + "enum": [ + "True", + "False", + "Unknown" + ], + "type": "string" + }, + "type": { + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", + "type": "string" + } + }, + "required": [ + "lastTransitionTime", + "message", + "reason", + "status", + "type" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + } + }, + "required": [ + "conditions" + ], + "type": "object", + "additionalProperties": false + } + }, + "type": "object" +} diff --git a/aiven.io/kafka_v1alpha1.json b/aiven.io/kafka_v1alpha1.json new file mode 100644 index 00000000..5ea59267 --- /dev/null +++ b/aiven.io/kafka_v1alpha1.json @@ -0,0 +1,1089 @@ +{ + "description": "Kafka is the Schema for the kafkas API.\nInfo \"Exposes secret keys\": `KAFKA_HOST`, `KAFKA_PORT`, `KAFKA_USERNAME`, `KAFKA_PASSWORD`, `KAFKA_ACCESS_CERT`, `KAFKA_ACCESS_KEY`, `KAFKA_SASL_HOST`, `KAFKA_SASL_PORT`, `KAFKA_SCHEMA_REGISTRY_HOST`, `KAFKA_SCHEMA_REGISTRY_PORT`, `KAFKA_CONNECT_HOST`, `KAFKA_CONNECT_PORT`, `KAFKA_REST_HOST`, `KAFKA_REST_PORT`, `KAFKA_CA_CERT`", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "type": "object" + }, + "spec": { + "description": "KafkaSpec defines the desired state of Kafka", + "properties": { + "authSecretRef": { + "description": "Authentication reference to Aiven token in a secret", + "properties": { + "key": { + "minLength": 1, + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key", + "name" + ], + "type": "object", + "additionalProperties": false + }, + "cloudName": { + "description": "Cloud the service runs in.", + "maxLength": 256, + "type": "string" + }, + "connInfoSecretTarget": { + "description": "Secret configuration.", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Annotations added to the secret", + "type": "object", + "x-kubernetes-preserve-unknown-fields": true + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels added to the secret", + "type": "object", + "x-kubernetes-preserve-unknown-fields": true + }, + "name": { + "description": "Name of the secret resource to be created. By default, it is equal to the resource name", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "prefix": { + "description": "Prefix for the secret's keys.\nAdded \"as is\" without any transformations.\nBy default, is equal to the kind name in uppercase + underscore, e.g. `KAFKA_`, `REDIS_`, etc.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "additionalProperties": false + }, + "connInfoSecretTargetDisabled": { + "description": "When true, the secret containing connection information will not be created, defaults to false. This field cannot be changed after resource creation.", + "type": "boolean", + "x-kubernetes-validations": [ + { + "message": "connInfoSecretTargetDisabled is immutable.", + "rule": "self == oldSelf" + } + ] + }, + "disk_space": { + "description": "The disk space of the service, possible values depend on the service type, the cloud provider and the project.\nReducing will result in the service re-balancing.\nThe removal of this field does not change the value.", + "pattern": "(?i)^[1-9][0-9]*(GiB|G)?$", + "type": "string" + }, + "karapace": { + "description": "Switch the service to use Karapace for schema registry and REST proxy", + "type": "boolean" + }, + "maintenanceWindowDow": { + "description": "Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.", + "enum": [ + "monday", + "tuesday", + "wednesday", + "thursday", + "friday", + "saturday", + "sunday" + ], + "type": "string" + }, + "maintenanceWindowTime": { + "description": "Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.", + "maxLength": 8, + "type": "string" + }, + "plan": { + "description": "Subscription plan.", + "maxLength": 128, + "type": "string" + }, + "project": { + "description": "Identifies the project this resource belongs to", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "projectVPCRef": { + "description": "ProjectVPCRef reference to ProjectVPC resource to use its ID as ProjectVPCID automatically", + "properties": { + "name": { + "minLength": 1, + "type": "string" + }, + "namespace": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "additionalProperties": false + }, + "projectVpcId": { + "description": "Identifier of the VPC the service should be in, if any.", + "maxLength": 36, + "type": "string" + }, + "serviceIntegrations": { + "description": "Service integrations to specify when creating a service. Not applied after initial service creation", + "items": { + "description": "Service integrations to specify when creating a service. Not applied after initial service creation", + "properties": { + "integrationType": { + "enum": [ + "read_replica" + ], + "type": "string" + }, + "sourceServiceName": { + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "integrationType", + "sourceServiceName" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 1, + "type": "array", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Tags are key-value pairs that allow you to categorize services.", + "type": "object" + }, + "technicalEmails": { + "description": "Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability.", + "items": { + "properties": { + "email": { + "description": "Email address.", + "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", + "type": "string" + } + }, + "required": [ + "email" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 10, + "type": "array" + }, + "terminationProtection": { + "description": "Prevent service from being deleted. It is recommended to have this enabled for all services.", + "type": "boolean" + }, + "userConfig": { + "description": "Kafka specific user configuration options", + "properties": { + "additional_backup_regions": { + "description": "Deprecated. Additional Cloud Regions for Backup Replication", + "items": { + "type": "string" + }, + "maxItems": 1, + "type": "array" + }, + "aiven_kafka_topic_messages": { + "description": "Allow access to read Kafka topic messages in the Aiven Console and REST API.", + "type": "boolean" + }, + "custom_domain": { + "description": "Serve the web frontend using a custom CNAME pointing to the Aiven DNS name", + "maxLength": 255, + "type": "string" + }, + "ip_filter": { + "description": "Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'", + "items": { + "description": "CIDR address block, either as a string, or in a dict with an optional description field", + "properties": { + "description": { + "description": "Description for IP filter list entry", + "maxLength": 1024, + "type": "string" + }, + "network": { + "description": "CIDR address block", + "maxLength": 43, + "type": "string" + } + }, + "required": [ + "network" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 1024, + "type": "array" + }, + "kafka": { + "description": "Kafka broker configuration values", + "properties": { + "auto_create_topics_enable": { + "description": "Enable auto creation of topics", + "type": "boolean" + }, + "compression_type": { + "description": "Specify the final compression type for a given topic. This configuration accepts the standard compression codecs ('gzip', 'snappy', 'lz4', 'zstd'). It additionally accepts 'uncompressed' which is equivalent to no compression; and 'producer' which means retain the original compression codec set by the producer.", + "enum": [ + "gzip", + "snappy", + "lz4", + "zstd", + "uncompressed", + "producer" + ], + "type": "string" + }, + "connections_max_idle_ms": { + "description": "Idle connections timeout: the server socket processor threads close the connections that idle for longer than this.", + "maximum": 3600000, + "minimum": 1000, + "type": "integer" + }, + "default_replication_factor": { + "description": "Replication factor for autocreated topics", + "maximum": 10, + "minimum": 1, + "type": "integer" + }, + "group_initial_rebalance_delay_ms": { + "description": "The amount of time, in milliseconds, the group coordinator will wait for more consumers to join a new group before performing the first rebalance. A longer delay means potentially fewer rebalances, but increases the time until processing begins. The default value for this is 3 seconds. During development and testing it might be desirable to set this to 0 in order to not delay test execution time.", + "maximum": 300000, + "minimum": 0, + "type": "integer" + }, + "group_max_session_timeout_ms": { + "description": "The maximum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures.", + "maximum": 1800000, + "minimum": 0, + "type": "integer" + }, + "group_min_session_timeout_ms": { + "description": "The minimum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures.", + "maximum": 60000, + "minimum": 0, + "type": "integer" + }, + "log_cleaner_delete_retention_ms": { + "description": "How long are delete records retained?", + "maximum": 315569260000, + "minimum": 0, + "type": "integer" + }, + "log_cleaner_max_compaction_lag_ms": { + "description": "The maximum amount of time message will remain uncompacted. Only applicable for logs that are being compacted", + "minimum": 30000, + "type": "integer" + }, + "log_cleaner_min_cleanable_ratio": { + "description": "Controls log compactor frequency. Larger value means more frequent compactions but also more space wasted for logs. Consider setting log.cleaner.max.compaction.lag.ms to enforce compactions sooner, instead of setting a very high value for this option.", + "maximum": 0.9, + "minimum": 0.2, + "type": "number" + }, + "log_cleaner_min_compaction_lag_ms": { + "description": "The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted.", + "minimum": 0, + "type": "integer" + }, + "log_cleanup_policy": { + "description": "The default cleanup policy for segments beyond the retention window", + "enum": [ + "delete", + "compact", + "compact,delete" + ], + "type": "string" + }, + "log_flush_interval_messages": { + "description": "The number of messages accumulated on a log partition before messages are flushed to disk", + "minimum": 1, + "type": "integer" + }, + "log_flush_interval_ms": { + "description": "The maximum time in ms that a message in any topic is kept in memory before flushed to disk. If not set, the value in log.flush.scheduler.interval.ms is used", + "minimum": 0, + "type": "integer" + }, + "log_index_interval_bytes": { + "description": "The interval with which Kafka adds an entry to the offset index", + "maximum": 104857600, + "minimum": 0, + "type": "integer" + }, + "log_index_size_max_bytes": { + "description": "The maximum size in bytes of the offset index", + "maximum": 104857600, + "minimum": 1048576, + "type": "integer" + }, + "log_local_retention_bytes": { + "description": "The maximum size of local log segments that can grow for a partition before it gets eligible for deletion. If set to -2, the value of log.retention.bytes is used. The effective value should always be less than or equal to log.retention.bytes value.", + "minimum": -2, + "type": "integer" + }, + "log_local_retention_ms": { + "description": "The number of milliseconds to keep the local log segments before it gets eligible for deletion. If set to -2, the value of log.retention.ms is used. The effective value should always be less than or equal to log.retention.ms value.", + "minimum": -2, + "type": "integer" + }, + "log_message_downconversion_enable": { + "description": "This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests.", + "type": "boolean" + }, + "log_message_timestamp_difference_max_ms": { + "description": "The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message", + "minimum": 0, + "type": "integer" + }, + "log_message_timestamp_type": { + "description": "Define whether the timestamp in the message is message create time or log append time.", + "enum": [ + "CreateTime", + "LogAppendTime" + ], + "type": "string" + }, + "log_preallocate": { + "description": "Should pre allocate file when create new segment?", + "type": "boolean" + }, + "log_retention_bytes": { + "description": "The maximum size of the log before deleting messages", + "minimum": -1, + "type": "integer" + }, + "log_retention_hours": { + "description": "The number of hours to keep a log file before deleting it", + "maximum": 2147483647, + "minimum": -1, + "type": "integer" + }, + "log_retention_ms": { + "description": "The number of milliseconds to keep a log file before deleting it (in milliseconds), If not set, the value in log.retention.minutes is used. If set to -1, no time limit is applied.", + "minimum": -1, + "type": "integer" + }, + "log_roll_jitter_ms": { + "description": "The maximum jitter to subtract from logRollTimeMillis (in milliseconds). If not set, the value in log.roll.jitter.hours is used", + "minimum": 0, + "type": "integer" + }, + "log_roll_ms": { + "description": "The maximum time before a new log segment is rolled out (in milliseconds).", + "minimum": 1, + "type": "integer" + }, + "log_segment_bytes": { + "description": "The maximum size of a single log file", + "maximum": 1073741824, + "minimum": 10485760, + "type": "integer" + }, + "log_segment_delete_delay_ms": { + "description": "The amount of time to wait before deleting a file from the filesystem", + "maximum": 3600000, + "minimum": 0, + "type": "integer" + }, + "max_connections_per_ip": { + "description": "The maximum number of connections allowed from each ip address (defaults to 2147483647).", + "maximum": 2147483647, + "minimum": 256, + "type": "integer" + }, + "max_incremental_fetch_session_cache_slots": { + "description": "The maximum number of incremental fetch sessions that the broker will maintain.", + "maximum": 10000, + "minimum": 1000, + "type": "integer" + }, + "message_max_bytes": { + "description": "The maximum size of message that the server can receive.", + "maximum": 100001200, + "minimum": 0, + "type": "integer" + }, + "min_insync_replicas": { + "description": "When a producer sets acks to 'all' (or '-1'), min.insync.replicas specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful.", + "maximum": 7, + "minimum": 1, + "type": "integer" + }, + "num_partitions": { + "description": "Number of partitions for autocreated topics", + "maximum": 1000, + "minimum": 1, + "type": "integer" + }, + "offsets_retention_minutes": { + "description": "Log retention window in minutes for offsets topic", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "producer_purgatory_purge_interval_requests": { + "description": "The purge interval (in number of requests) of the producer request purgatory(defaults to 1000).", + "maximum": 10000, + "minimum": 10, + "type": "integer" + }, + "replica_fetch_max_bytes": { + "description": "The number of bytes of messages to attempt to fetch for each partition (defaults to 1048576). This is not an absolute maximum, if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made.", + "maximum": 104857600, + "minimum": 1048576, + "type": "integer" + }, + "replica_fetch_response_max_bytes": { + "description": "Maximum bytes expected for the entire fetch response (defaults to 10485760). Records are fetched in batches, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. As such, this is not an absolute maximum.", + "maximum": 1048576000, + "minimum": 10485760, + "type": "integer" + }, + "sasl_oauthbearer_expected_audience": { + "description": "The (optional) comma-delimited setting for the broker to use to verify that the JWT was issued for one of the expected audiences.", + "maxLength": 128, + "pattern": "^[^\\r\\n]*$", + "type": "string" + }, + "sasl_oauthbearer_expected_issuer": { + "description": "Optional setting for the broker to use to verify that the JWT was created by the expected issuer.", + "maxLength": 128, + "pattern": "^[^\\r\\n]*$", + "type": "string" + }, + "sasl_oauthbearer_jwks_endpoint_url": { + "description": "OIDC JWKS endpoint URL. By setting this the SASL SSL OAuth2/OIDC authentication is enabled. See also other options for SASL OAuth2/OIDC.", + "maxLength": 2048, + "type": "string" + }, + "sasl_oauthbearer_sub_claim_name": { + "description": "Name of the scope from which to extract the subject claim from the JWT. Defaults to sub.", + "maxLength": 128, + "pattern": "^[^\\r\\n]*$", + "type": "string" + }, + "socket_request_max_bytes": { + "description": "The maximum number of bytes in a socket request (defaults to 104857600).", + "maximum": 209715200, + "minimum": 10485760, + "type": "integer" + }, + "transaction_partition_verification_enable": { + "description": "Enable verification that checks that the partition has been added to the transaction before writing transactional records to the partition", + "type": "boolean" + }, + "transaction_remove_expired_transaction_cleanup_interval_ms": { + "description": "The interval at which to remove transactions that have expired due to transactional.id.expiration.ms passing (defaults to 3600000 (1 hour)).", + "maximum": 3600000, + "minimum": 600000, + "type": "integer" + }, + "transaction_state_log_segment_bytes": { + "description": "The transaction topic segment bytes should be kept relatively small in order to facilitate faster log compaction and cache loads (defaults to 104857600 (100 mebibytes)).", + "maximum": 2147483647, + "minimum": 1048576, + "type": "integer" + } + }, + "type": "object", + "additionalProperties": false + }, + "kafka_authentication_methods": { + "description": "Kafka authentication methods", + "properties": { + "certificate": { + "description": "Enable certificate/SSL authentication", + "type": "boolean" + }, + "sasl": { + "description": "Enable SASL authentication", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "kafka_connect": { + "description": "Enable Kafka Connect service", + "type": "boolean" + }, + "kafka_connect_config": { + "description": "Kafka Connect configuration values", + "properties": { + "connector_client_config_override_policy": { + "description": "Defines what client configurations can be overridden by the connector. Default is None", + "enum": [ + "None", + "All" + ], + "type": "string" + }, + "consumer_auto_offset_reset": { + "description": "What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server. Default is earliest", + "enum": [ + "earliest", + "latest" + ], + "type": "string" + }, + "consumer_fetch_max_bytes": { + "description": "Records are fetched in batches by the consumer, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that the consumer can make progress. As such, this is not a absolute maximum.", + "maximum": 104857600, + "minimum": 1048576, + "type": "integer" + }, + "consumer_isolation_level": { + "description": "Transaction read isolation level. read_uncommitted is the default, but read_committed can be used if consume-exactly-once behavior is desired.", + "enum": [ + "read_uncommitted", + "read_committed" + ], + "type": "string" + }, + "consumer_max_partition_fetch_bytes": { + "description": "Records are fetched in batches by the consumer.If the first record batch in the first non-empty partition of the fetch is larger than this limit, the batch will still be returned to ensure that the consumer can make progress.", + "maximum": 104857600, + "minimum": 1048576, + "type": "integer" + }, + "consumer_max_poll_interval_ms": { + "description": "The maximum delay in milliseconds between invocations of poll() when using consumer group management (defaults to 300000).", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "consumer_max_poll_records": { + "description": "The maximum number of records returned in a single call to poll() (defaults to 500).", + "maximum": 10000, + "minimum": 1, + "type": "integer" + }, + "offset_flush_interval_ms": { + "description": "The interval at which to try committing offsets for tasks (defaults to 60000).", + "maximum": 100000000, + "minimum": 1, + "type": "integer" + }, + "offset_flush_timeout_ms": { + "description": "Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt (defaults to 5000).", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "producer_batch_size": { + "description": "This setting gives the upper bound of the batch size to be sent. If there are fewer than this many bytes accumulated for this partition, the producer will 'linger' for the linger.ms time waiting for more records to show up. A batch size of zero will disable batching entirely (defaults to 16384).", + "maximum": 5242880, + "minimum": 0, + "type": "integer" + }, + "producer_buffer_memory": { + "description": "The total bytes of memory the producer can use to buffer records waiting to be sent to the broker (defaults to 33554432).", + "maximum": 134217728, + "minimum": 5242880, + "type": "integer" + }, + "producer_compression_type": { + "description": "Specify the default compression type for producers. This configuration accepts the standard compression codecs ('gzip', 'snappy', 'lz4', 'zstd'). It additionally accepts 'none' which is the default and equivalent to no compression.", + "enum": [ + "gzip", + "snappy", + "lz4", + "zstd", + "none" + ], + "type": "string" + }, + "producer_linger_ms": { + "description": "This setting gives the upper bound on the delay for batching: once there is batch.size worth of records for a partition it will be sent immediately regardless of this setting, however if there are fewer than this many bytes accumulated for this partition the producer will 'linger' for the specified time waiting for more records to show up. Defaults to 0.", + "maximum": 5000, + "minimum": 0, + "type": "integer" + }, + "producer_max_request_size": { + "description": "This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests.", + "maximum": 67108864, + "minimum": 131072, + "type": "integer" + }, + "scheduled_rebalance_max_delay_ms": { + "description": "The maximum delay that is scheduled in order to wait for the return of one or more departed workers before rebalancing and reassigning their connectors and tasks to the group. During this period the connectors and tasks of the departed workers remain unassigned. Defaults to 5 minutes.", + "maximum": 600000, + "minimum": 0, + "type": "integer" + }, + "session_timeout_ms": { + "description": "The timeout in milliseconds used to detect failures when using Kafka\u2019s group management facilities (defaults to 10000).", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + } + }, + "type": "object", + "additionalProperties": false + }, + "kafka_connect_secret_providers": { + "description": "Configure external secret providers in order to reference external secrets in connector configuration. Currently Hashicorp Vault (provider: vault, auth_method: token) and AWS Secrets Manager (provider: aws, auth_method: credentials) are supported. Secrets can be referenced in connector config with ${::}", + "items": { + "description": "SecretProvider", + "properties": { + "aws": { + "description": "AWS config for Secret Provider", + "properties": { + "access_key": { + "description": "Access key used to authenticate with aws", + "maxLength": 128, + "type": "string" + }, + "auth_method": { + "description": "Auth method of the vault secret provider", + "enum": [ + "credentials" + ], + "type": "string" + }, + "region": { + "description": "Region used to lookup secrets with AWS SecretManager", + "maxLength": 64, + "type": "string" + }, + "secret_key": { + "description": "Secret key used to authenticate with aws", + "maxLength": 128, + "type": "string" + } + }, + "required": [ + "auth_method", + "region" + ], + "type": "object", + "additionalProperties": false + }, + "name": { + "description": "Name of the secret provider. Used to reference secrets in connector config.", + "type": "string" + }, + "vault": { + "description": "Vault Config for Secret Provider", + "properties": { + "address": { + "description": "Address of the Vault server", + "maxLength": 65536, + "minLength": 1, + "type": "string" + }, + "auth_method": { + "description": "Auth method of the vault secret provider", + "enum": [ + "token" + ], + "type": "string" + }, + "engine_version": { + "description": "KV Secrets Engine version of the Vault server instance", + "enum": [ + 1, + 2 + ], + "type": "integer" + }, + "token": { + "description": "Token used to authenticate with vault and auth method `token`.", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "address", + "auth_method" + ], + "type": "object", + "additionalProperties": false + } + }, + "required": [ + "name" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + }, + "kafka_rest": { + "description": "Enable Kafka-REST service", + "type": "boolean" + }, + "kafka_rest_authorization": { + "description": "Enable authorization in Kafka-REST service", + "type": "boolean" + }, + "kafka_rest_config": { + "description": "Kafka REST configuration", + "properties": { + "consumer_enable_auto_commit": { + "description": "If true the consumer's offset will be periodically committed to Kafka in the background", + "type": "boolean" + }, + "consumer_request_max_bytes": { + "description": "Maximum number of bytes in unencoded message keys and values by a single request", + "maximum": 671088640, + "minimum": 0, + "type": "integer" + }, + "consumer_request_timeout_ms": { + "description": "The maximum total time to wait for messages for a request if the maximum number of messages has not yet been reached", + "enum": [ + 1000, + 15000, + 30000 + ], + "maximum": 30000, + "minimum": 1000, + "type": "integer" + }, + "name_strategy": { + "description": "Name strategy to use when selecting subject for storing schemas", + "enum": [ + "topic_name", + "record_name", + "topic_record_name" + ], + "type": "string" + }, + "name_strategy_validation": { + "description": "If true, validate that given schema is registered under expected subject name by the used name strategy when producing messages.", + "type": "boolean" + }, + "producer_acks": { + "description": "The number of acknowledgments the producer requires the leader to have received before considering a request complete. If set to 'all' or '-1', the leader will wait for the full set of in-sync replicas to acknowledge the record.", + "enum": [ + "all", + "-1", + "0", + "1" + ], + "type": "string" + }, + "producer_compression_type": { + "description": "Specify the default compression type for producers. This configuration accepts the standard compression codecs ('gzip', 'snappy', 'lz4', 'zstd'). It additionally accepts 'none' which is the default and equivalent to no compression.", + "enum": [ + "gzip", + "snappy", + "lz4", + "zstd", + "none" + ], + "type": "string" + }, + "producer_linger_ms": { + "description": "Wait for up to the given delay to allow batching records together", + "maximum": 5000, + "minimum": 0, + "type": "integer" + }, + "producer_max_request_size": { + "description": "The maximum size of a request in bytes. Note that Kafka broker can also cap the record batch size.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "simpleconsumer_pool_size_max": { + "description": "Maximum number of SimpleConsumers that can be instantiated per broker", + "maximum": 250, + "minimum": 10, + "type": "integer" + } + }, + "type": "object", + "additionalProperties": false + }, + "kafka_version": { + "description": "Kafka major version", + "enum": [ + "3.4", + "3.5", + "3.6", + "3.7" + ], + "type": "string" + }, + "letsencrypt_sasl_privatelink": { + "description": "Use Letsencrypt CA for Kafka SASL via Privatelink", + "type": "boolean" + }, + "private_access": { + "description": "Allow access to selected service ports from private networks", + "properties": { + "kafka": { + "description": "Allow clients to connect to kafka with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations", + "type": "boolean" + }, + "kafka_connect": { + "description": "Allow clients to connect to kafka_connect with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations", + "type": "boolean" + }, + "kafka_rest": { + "description": "Allow clients to connect to kafka_rest with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations", + "type": "boolean" + }, + "prometheus": { + "description": "Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations", + "type": "boolean" + }, + "schema_registry": { + "description": "Allow clients to connect to schema_registry with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "privatelink_access": { + "description": "Allow access to selected service components through Privatelink", + "properties": { + "jolokia": { + "description": "Enable jolokia", + "type": "boolean" + }, + "kafka": { + "description": "Enable kafka", + "type": "boolean" + }, + "kafka_connect": { + "description": "Enable kafka_connect", + "type": "boolean" + }, + "kafka_rest": { + "description": "Enable kafka_rest", + "type": "boolean" + }, + "prometheus": { + "description": "Enable prometheus", + "type": "boolean" + }, + "schema_registry": { + "description": "Enable schema_registry", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "public_access": { + "description": "Allow access to selected service ports from the public Internet", + "properties": { + "kafka": { + "description": "Allow clients to connect to kafka from the public internet for service nodes that are in a project VPC or another type of private network", + "type": "boolean" + }, + "kafka_connect": { + "description": "Allow clients to connect to kafka_connect from the public internet for service nodes that are in a project VPC or another type of private network", + "type": "boolean" + }, + "kafka_rest": { + "description": "Allow clients to connect to kafka_rest from the public internet for service nodes that are in a project VPC or another type of private network", + "type": "boolean" + }, + "prometheus": { + "description": "Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network", + "type": "boolean" + }, + "schema_registry": { + "description": "Allow clients to connect to schema_registry from the public internet for service nodes that are in a project VPC or another type of private network", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "schema_registry": { + "description": "Enable Schema-Registry service", + "type": "boolean" + }, + "schema_registry_config": { + "description": "Schema Registry configuration", + "properties": { + "leader_eligibility": { + "description": "If true, Karapace / Schema Registry on the service nodes can participate in leader election. It might be needed to disable this when the schemas topic is replicated to a secondary cluster and Karapace / Schema Registry there must not participate in leader election. Defaults to `true`.", + "type": "boolean" + }, + "topic_name": { + "description": "The durable single partition topic that acts as the durable log for the data. This topic must be compacted to avoid losing data due to retention policy. Please note that changing this configuration in an existing Schema Registry / Karapace setup leads to previous schemas being inaccessible, data encoded with them potentially unreadable and schema ID sequence put out of order. It's only possible to do the switch while Schema Registry / Karapace is disabled. Defaults to `_schemas`.", + "maxLength": 249, + "minLength": 1, + "type": "string" + } + }, + "type": "object", + "additionalProperties": false + }, + "service_log": { + "description": "Store logs for the service so that they are available in the HTTP API and console.", + "type": "boolean" + }, + "static_ips": { + "description": "Use static public IP addresses", + "type": "boolean" + }, + "tiered_storage": { + "description": "Tiered storage configuration", + "properties": { + "enabled": { + "description": "Whether to enable the tiered storage functionality", + "type": "boolean" + }, + "local_cache": { + "description": "Deprecated. Local cache configuration", + "properties": { + "size": { + "description": "Deprecated. Local cache size in bytes", + "maximum": 107374182400, + "minimum": 1, + "type": "integer" + } + }, + "type": "object", + "additionalProperties": false + } + }, + "type": "object", + "additionalProperties": false + } + }, + "type": "object", + "additionalProperties": false + } + }, + "required": [ + "plan", + "project" + ], + "type": "object", + "x-kubernetes-validations": [ + { + "message": "connInfoSecretTargetDisabled can only be set during resource creation.", + "rule": "has(oldSelf.connInfoSecretTargetDisabled) == has(self.connInfoSecretTargetDisabled)" + } + ], + "additionalProperties": false + }, + "status": { + "description": "ServiceStatus defines the observed state of service", + "properties": { + "conditions": { + "description": "Conditions represent the latest available observations of a service state", + "items": { + "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}", + "properties": { + "lastTransitionTime": { + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis 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", + "type": "string" + }, + "message": { + "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", + "maxLength": 32768, + "type": "string" + }, + "observedGeneration": { + "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "reason": { + "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", + "type": "string" + }, + "status": { + "description": "status of the condition, one of True, False, Unknown.", + "enum": [ + "True", + "False", + "Unknown" + ], + "type": "string" + }, + "type": { + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", + "type": "string" + } + }, + "required": [ + "lastTransitionTime", + "message", + "reason", + "status", + "type" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + }, + "state": { + "description": "Service state", + "type": "string" + } + }, + "type": "object", + "additionalProperties": false + } + }, + "type": "object" +} diff --git a/aiven.io/kafkaacl_v1alpha1.json b/aiven.io/kafkaacl_v1alpha1.json new file mode 100644 index 00000000..98d23591 --- /dev/null +++ b/aiven.io/kafkaacl_v1alpha1.json @@ -0,0 +1,163 @@ +{ + "description": "KafkaACL is the Schema for the kafkaacls API", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "type": "object" + }, + "spec": { + "description": "KafkaACLSpec defines the desired state of KafkaACL", + "properties": { + "authSecretRef": { + "description": "Authentication reference to Aiven token in a secret", + "properties": { + "key": { + "minLength": 1, + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key", + "name" + ], + "type": "object", + "additionalProperties": false + }, + "permission": { + "description": "Kafka permission to grant (admin, read, readwrite, write)", + "enum": [ + "admin", + "read", + "readwrite", + "write" + ], + "type": "string" + }, + "project": { + "description": "Identifies the project this resource belongs to", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "serviceName": { + "description": "Specifies the name of the service that this resource belongs to", + "maxLength": 63, + "pattern": "^[a-z][-a-z0-9]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "topic": { + "description": "Topic name pattern for the ACL entry", + "type": "string" + }, + "username": { + "description": "Username pattern for the ACL entry", + "type": "string" + } + }, + "required": [ + "permission", + "project", + "serviceName", + "topic", + "username" + ], + "type": "object", + "additionalProperties": false + }, + "status": { + "description": "KafkaACLStatus defines the observed state of KafkaACL", + "properties": { + "conditions": { + "description": "Conditions represent the latest available observations of an KafkaACL state", + "items": { + "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}", + "properties": { + "lastTransitionTime": { + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis 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", + "type": "string" + }, + "message": { + "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", + "maxLength": 32768, + "type": "string" + }, + "observedGeneration": { + "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "reason": { + "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", + "type": "string" + }, + "status": { + "description": "status of the condition, one of True, False, Unknown.", + "enum": [ + "True", + "False", + "Unknown" + ], + "type": "string" + }, + "type": { + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", + "type": "string" + } + }, + "required": [ + "lastTransitionTime", + "message", + "reason", + "status", + "type" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + }, + "id": { + "description": "Kafka ACL ID", + "type": "string" + } + }, + "required": [ + "conditions", + "id" + ], + "type": "object", + "additionalProperties": false + } + }, + "type": "object" +} diff --git a/aiven.io/kafkaconnect_v1alpha1.json b/aiven.io/kafkaconnect_v1alpha1.json new file mode 100644 index 00000000..c493279c --- /dev/null +++ b/aiven.io/kafkaconnect_v1alpha1.json @@ -0,0 +1,539 @@ +{ + "description": "KafkaConnect is the Schema for the kafkaconnects API", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "type": "object" + }, + "spec": { + "description": "KafkaConnectSpec defines the desired state of KafkaConnect", + "properties": { + "authSecretRef": { + "description": "Authentication reference to Aiven token in a secret", + "properties": { + "key": { + "minLength": 1, + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key", + "name" + ], + "type": "object", + "additionalProperties": false + }, + "cloudName": { + "description": "Cloud the service runs in.", + "maxLength": 256, + "type": "string" + }, + "maintenanceWindowDow": { + "description": "Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.", + "enum": [ + "monday", + "tuesday", + "wednesday", + "thursday", + "friday", + "saturday", + "sunday" + ], + "type": "string" + }, + "maintenanceWindowTime": { + "description": "Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.", + "maxLength": 8, + "type": "string" + }, + "plan": { + "description": "Subscription plan.", + "maxLength": 128, + "type": "string" + }, + "project": { + "description": "Identifies the project this resource belongs to", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "projectVPCRef": { + "description": "ProjectVPCRef reference to ProjectVPC resource to use its ID as ProjectVPCID automatically", + "properties": { + "name": { + "minLength": 1, + "type": "string" + }, + "namespace": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "additionalProperties": false + }, + "projectVpcId": { + "description": "Identifier of the VPC the service should be in, if any.", + "maxLength": 36, + "type": "string" + }, + "serviceIntegrations": { + "description": "Service integrations to specify when creating a service. Not applied after initial service creation", + "items": { + "description": "Service integrations to specify when creating a service. Not applied after initial service creation", + "properties": { + "integrationType": { + "enum": [ + "read_replica" + ], + "type": "string" + }, + "sourceServiceName": { + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "integrationType", + "sourceServiceName" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 1, + "type": "array", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Tags are key-value pairs that allow you to categorize services.", + "type": "object" + }, + "technicalEmails": { + "description": "Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability.", + "items": { + "properties": { + "email": { + "description": "Email address.", + "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", + "type": "string" + } + }, + "required": [ + "email" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 10, + "type": "array" + }, + "terminationProtection": { + "description": "Prevent service from being deleted. It is recommended to have this enabled for all services.", + "type": "boolean" + }, + "userConfig": { + "description": "KafkaConnect specific user configuration options", + "properties": { + "additional_backup_regions": { + "description": "Deprecated. Additional Cloud Regions for Backup Replication", + "items": { + "type": "string" + }, + "maxItems": 1, + "type": "array" + }, + "ip_filter": { + "description": "Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'", + "items": { + "description": "CIDR address block, either as a string, or in a dict with an optional description field", + "properties": { + "description": { + "description": "Description for IP filter list entry", + "maxLength": 1024, + "type": "string" + }, + "network": { + "description": "CIDR address block", + "maxLength": 43, + "type": "string" + } + }, + "required": [ + "network" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 1024, + "type": "array" + }, + "kafka_connect": { + "description": "Kafka Connect configuration values", + "properties": { + "connector_client_config_override_policy": { + "description": "Defines what client configurations can be overridden by the connector. Default is None", + "enum": [ + "None", + "All" + ], + "type": "string" + }, + "consumer_auto_offset_reset": { + "description": "What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server. Default is earliest", + "enum": [ + "earliest", + "latest" + ], + "type": "string" + }, + "consumer_fetch_max_bytes": { + "description": "Records are fetched in batches by the consumer, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that the consumer can make progress. As such, this is not a absolute maximum.", + "maximum": 104857600, + "minimum": 1048576, + "type": "integer" + }, + "consumer_isolation_level": { + "description": "Transaction read isolation level. read_uncommitted is the default, but read_committed can be used if consume-exactly-once behavior is desired.", + "enum": [ + "read_uncommitted", + "read_committed" + ], + "type": "string" + }, + "consumer_max_partition_fetch_bytes": { + "description": "Records are fetched in batches by the consumer.If the first record batch in the first non-empty partition of the fetch is larger than this limit, the batch will still be returned to ensure that the consumer can make progress.", + "maximum": 104857600, + "minimum": 1048576, + "type": "integer" + }, + "consumer_max_poll_interval_ms": { + "description": "The maximum delay in milliseconds between invocations of poll() when using consumer group management (defaults to 300000).", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "consumer_max_poll_records": { + "description": "The maximum number of records returned in a single call to poll() (defaults to 500).", + "maximum": 10000, + "minimum": 1, + "type": "integer" + }, + "offset_flush_interval_ms": { + "description": "The interval at which to try committing offsets for tasks (defaults to 60000).", + "maximum": 100000000, + "minimum": 1, + "type": "integer" + }, + "offset_flush_timeout_ms": { + "description": "Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt (defaults to 5000).", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "producer_batch_size": { + "description": "This setting gives the upper bound of the batch size to be sent. If there are fewer than this many bytes accumulated for this partition, the producer will 'linger' for the linger.ms time waiting for more records to show up. A batch size of zero will disable batching entirely (defaults to 16384).", + "maximum": 5242880, + "minimum": 0, + "type": "integer" + }, + "producer_buffer_memory": { + "description": "The total bytes of memory the producer can use to buffer records waiting to be sent to the broker (defaults to 33554432).", + "maximum": 134217728, + "minimum": 5242880, + "type": "integer" + }, + "producer_compression_type": { + "description": "Specify the default compression type for producers. This configuration accepts the standard compression codecs ('gzip', 'snappy', 'lz4', 'zstd'). It additionally accepts 'none' which is the default and equivalent to no compression.", + "enum": [ + "gzip", + "snappy", + "lz4", + "zstd", + "none" + ], + "type": "string" + }, + "producer_linger_ms": { + "description": "This setting gives the upper bound on the delay for batching: once there is batch.size worth of records for a partition it will be sent immediately regardless of this setting, however if there are fewer than this many bytes accumulated for this partition the producer will 'linger' for the specified time waiting for more records to show up. Defaults to 0.", + "maximum": 5000, + "minimum": 0, + "type": "integer" + }, + "producer_max_request_size": { + "description": "This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests.", + "maximum": 67108864, + "minimum": 131072, + "type": "integer" + }, + "scheduled_rebalance_max_delay_ms": { + "description": "The maximum delay that is scheduled in order to wait for the return of one or more departed workers before rebalancing and reassigning their connectors and tasks to the group. During this period the connectors and tasks of the departed workers remain unassigned. Defaults to 5 minutes.", + "maximum": 600000, + "minimum": 0, + "type": "integer" + }, + "session_timeout_ms": { + "description": "The timeout in milliseconds used to detect failures when using Kafka\u2019s group management facilities (defaults to 10000).", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + } + }, + "type": "object", + "additionalProperties": false + }, + "private_access": { + "description": "Allow access to selected service ports from private networks", + "properties": { + "kafka_connect": { + "description": "Allow clients to connect to kafka_connect with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations", + "type": "boolean" + }, + "prometheus": { + "description": "Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "privatelink_access": { + "description": "Allow access to selected service components through Privatelink", + "properties": { + "jolokia": { + "description": "Enable jolokia", + "type": "boolean" + }, + "kafka_connect": { + "description": "Enable kafka_connect", + "type": "boolean" + }, + "prometheus": { + "description": "Enable prometheus", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "public_access": { + "description": "Allow access to selected service ports from the public Internet", + "properties": { + "kafka_connect": { + "description": "Allow clients to connect to kafka_connect from the public internet for service nodes that are in a project VPC or another type of private network", + "type": "boolean" + }, + "prometheus": { + "description": "Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "secret_providers": { + "description": "Configure external secret providers in order to reference external secrets in connector configuration. Currently Hashicorp Vault (provider: vault, auth_method: token) and AWS Secrets Manager (provider: aws, auth_method: credentials) are supported. Secrets can be referenced in connector config with ${::}", + "items": { + "description": "SecretProvider", + "properties": { + "aws": { + "description": "AWS config for Secret Provider", + "properties": { + "access_key": { + "description": "Access key used to authenticate with aws", + "maxLength": 128, + "type": "string" + }, + "auth_method": { + "description": "Auth method of the vault secret provider", + "enum": [ + "credentials" + ], + "type": "string" + }, + "region": { + "description": "Region used to lookup secrets with AWS SecretManager", + "maxLength": 64, + "type": "string" + }, + "secret_key": { + "description": "Secret key used to authenticate with aws", + "maxLength": 128, + "type": "string" + } + }, + "required": [ + "auth_method", + "region" + ], + "type": "object", + "additionalProperties": false + }, + "name": { + "description": "Name of the secret provider. Used to reference secrets in connector config.", + "type": "string" + }, + "vault": { + "description": "Vault Config for Secret Provider", + "properties": { + "address": { + "description": "Address of the Vault server", + "maxLength": 65536, + "minLength": 1, + "type": "string" + }, + "auth_method": { + "description": "Auth method of the vault secret provider", + "enum": [ + "token" + ], + "type": "string" + }, + "engine_version": { + "description": "KV Secrets Engine version of the Vault server instance", + "enum": [ + 1, + 2 + ], + "type": "integer" + }, + "token": { + "description": "Token used to authenticate with vault and auth method `token`.", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "address", + "auth_method" + ], + "type": "object", + "additionalProperties": false + } + }, + "required": [ + "name" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + }, + "service_log": { + "description": "Store logs for the service so that they are available in the HTTP API and console.", + "type": "boolean" + }, + "static_ips": { + "description": "Use static public IP addresses", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + } + }, + "required": [ + "plan", + "project" + ], + "type": "object", + "additionalProperties": false + }, + "status": { + "description": "ServiceStatus defines the observed state of service", + "properties": { + "conditions": { + "description": "Conditions represent the latest available observations of a service state", + "items": { + "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}", + "properties": { + "lastTransitionTime": { + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis 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", + "type": "string" + }, + "message": { + "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", + "maxLength": 32768, + "type": "string" + }, + "observedGeneration": { + "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "reason": { + "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", + "type": "string" + }, + "status": { + "description": "status of the condition, one of True, False, Unknown.", + "enum": [ + "True", + "False", + "Unknown" + ], + "type": "string" + }, + "type": { + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", + "type": "string" + } + }, + "required": [ + "lastTransitionTime", + "message", + "reason", + "status", + "type" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + }, + "state": { + "description": "Service state", + "type": "string" + } + }, + "type": "object", + "additionalProperties": false + } + }, + "type": "object" +} diff --git a/aiven.io/kafkaconnector_v1alpha1.json b/aiven.io/kafkaconnector_v1alpha1.json new file mode 100644 index 00000000..5061a840 --- /dev/null +++ b/aiven.io/kafkaconnector_v1alpha1.json @@ -0,0 +1,222 @@ +{ + "description": "KafkaConnector is the Schema for the kafkaconnectors API", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "type": "object" + }, + "spec": { + "description": "KafkaConnectorSpec defines the desired state of KafkaConnector", + "properties": { + "authSecretRef": { + "description": "Authentication reference to Aiven token in a secret", + "properties": { + "key": { + "minLength": 1, + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key", + "name" + ], + "type": "object", + "additionalProperties": false + }, + "connectorClass": { + "description": "The Java class of the connector.", + "maxLength": 1024, + "type": "string" + }, + "project": { + "description": "Identifies the project this resource belongs to", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "serviceName": { + "description": "Specifies the name of the service that this resource belongs to", + "maxLength": 63, + "pattern": "^[a-z][-a-z0-9]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "userConfig": { + "additionalProperties": { + "type": "string" + }, + "description": "The connector specific configuration\nTo build config values from secret the template function {{ fromSecret \"name\" \"key\" }}\nis provided when interpreting the keys", + "type": "object" + } + }, + "required": [ + "connectorClass", + "project", + "serviceName", + "userConfig" + ], + "type": "object", + "additionalProperties": false + }, + "status": { + "description": "KafkaConnectorStatus defines the observed state of KafkaConnector", + "properties": { + "conditions": { + "description": "Conditions represent the latest available observations of an kafka connector state", + "items": { + "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}", + "properties": { + "lastTransitionTime": { + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis 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", + "type": "string" + }, + "message": { + "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", + "maxLength": 32768, + "type": "string" + }, + "observedGeneration": { + "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "reason": { + "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", + "type": "string" + }, + "status": { + "description": "status of the condition, one of True, False, Unknown.", + "enum": [ + "True", + "False", + "Unknown" + ], + "type": "string" + }, + "type": { + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", + "type": "string" + } + }, + "required": [ + "lastTransitionTime", + "message", + "reason", + "status", + "type" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + }, + "pluginStatus": { + "description": "PluginStatus contains metadata about the configured connector plugin", + "properties": { + "author": { + "type": "string" + }, + "class": { + "type": "string" + }, + "docUrl": { + "type": "string" + }, + "title": { + "type": "string" + }, + "type": { + "type": "string" + }, + "version": { + "type": "string" + } + }, + "required": [ + "author", + "class", + "docUrl", + "title", + "type", + "version" + ], + "type": "object", + "additionalProperties": false + }, + "state": { + "description": "Connector state", + "type": "string" + }, + "tasksStatus": { + "description": "TasksStatus contains metadata about the running tasks", + "properties": { + "failed": { + "type": "integer" + }, + "paused": { + "type": "integer" + }, + "running": { + "type": "integer" + }, + "stackTrace": { + "type": "string" + }, + "total": { + "type": "integer" + }, + "unassigned": { + "type": "integer" + }, + "unknown": { + "type": "integer" + } + }, + "required": [ + "total" + ], + "type": "object", + "additionalProperties": false + } + }, + "required": [ + "conditions", + "pluginStatus", + "state", + "tasksStatus" + ], + "type": "object", + "additionalProperties": false + } + }, + "type": "object" +} diff --git a/aiven.io/kafkaschema_v1alpha1.json b/aiven.io/kafkaschema_v1alpha1.json new file mode 100644 index 00000000..5d2344e0 --- /dev/null +++ b/aiven.io/kafkaschema_v1alpha1.json @@ -0,0 +1,166 @@ +{ + "description": "KafkaSchema is the Schema for the kafkaschemas API", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "type": "object" + }, + "spec": { + "description": "KafkaSchemaSpec defines the desired state of KafkaSchema", + "properties": { + "authSecretRef": { + "description": "Authentication reference to Aiven token in a secret", + "properties": { + "key": { + "minLength": 1, + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key", + "name" + ], + "type": "object", + "additionalProperties": false + }, + "compatibilityLevel": { + "description": "Kafka Schemas compatibility level", + "enum": [ + "BACKWARD", + "BACKWARD_TRANSITIVE", + "FORWARD", + "FORWARD_TRANSITIVE", + "FULL", + "FULL_TRANSITIVE", + "NONE" + ], + "type": "string" + }, + "project": { + "description": "Identifies the project this resource belongs to", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "schema": { + "description": "Kafka Schema configuration should be a valid Avro Schema JSON format", + "type": "string" + }, + "serviceName": { + "description": "Specifies the name of the service that this resource belongs to", + "maxLength": 63, + "pattern": "^[a-z][-a-z0-9]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "subjectName": { + "description": "Kafka Schema Subject name", + "maxLength": 63, + "type": "string" + } + }, + "required": [ + "project", + "schema", + "serviceName", + "subjectName" + ], + "type": "object", + "additionalProperties": false + }, + "status": { + "description": "KafkaSchemaStatus defines the observed state of KafkaSchema", + "properties": { + "conditions": { + "description": "Conditions represent the latest available observations of an KafkaSchema state", + "items": { + "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}", + "properties": { + "lastTransitionTime": { + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis 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", + "type": "string" + }, + "message": { + "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", + "maxLength": 32768, + "type": "string" + }, + "observedGeneration": { + "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "reason": { + "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", + "type": "string" + }, + "status": { + "description": "status of the condition, one of True, False, Unknown.", + "enum": [ + "True", + "False", + "Unknown" + ], + "type": "string" + }, + "type": { + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", + "type": "string" + } + }, + "required": [ + "lastTransitionTime", + "message", + "reason", + "status", + "type" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + }, + "version": { + "description": "Kafka Schema configuration version", + "type": "integer" + } + }, + "required": [ + "conditions", + "version" + ], + "type": "object", + "additionalProperties": false + } + }, + "type": "object" +} diff --git a/aiven.io/kafkaschemaregistryacl_v1alpha1.json b/aiven.io/kafkaschemaregistryacl_v1alpha1.json new file mode 100644 index 00000000..912afa1c --- /dev/null +++ b/aiven.io/kafkaschemaregistryacl_v1alpha1.json @@ -0,0 +1,180 @@ +{ + "description": "KafkaSchemaRegistryACL is the Schema for the kafkaschemaregistryacls API", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "type": "object" + }, + "spec": { + "description": "KafkaSchemaRegistryACLSpec defines the desired state of KafkaSchemaRegistryACL", + "properties": { + "authSecretRef": { + "description": "Authentication reference to Aiven token in a secret", + "properties": { + "key": { + "minLength": 1, + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key", + "name" + ], + "type": "object", + "additionalProperties": false + }, + "permission": { + "enum": [ + "schema_registry_read", + "schema_registry_write" + ], + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "project": { + "description": "Identifies the project this resource belongs to", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "resource": { + "description": "Resource name pattern for the Schema Registry ACL entry", + "maxLength": 249, + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "serviceName": { + "description": "Specifies the name of the service that this resource belongs to", + "maxLength": 63, + "pattern": "^[a-z][-a-z0-9]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "username": { + "description": "Username pattern for the ACL entry", + "maxLength": 64, + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + } + }, + "required": [ + "permission", + "project", + "resource", + "serviceName", + "username" + ], + "type": "object", + "additionalProperties": false + }, + "status": { + "description": "KafkaSchemaRegistryACLStatus defines the observed state of KafkaSchemaRegistryACL", + "properties": { + "acl_id": { + "description": "Kafka ACL ID", + "type": "string" + }, + "conditions": { + "description": "Conditions represent the latest available observations of an KafkaSchemaRegistryACL state", + "items": { + "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}", + "properties": { + "lastTransitionTime": { + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis 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", + "type": "string" + }, + "message": { + "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", + "maxLength": 32768, + "type": "string" + }, + "observedGeneration": { + "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "reason": { + "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", + "type": "string" + }, + "status": { + "description": "status of the condition, one of True, False, Unknown.", + "enum": [ + "True", + "False", + "Unknown" + ], + "type": "string" + }, + "type": { + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", + "type": "string" + } + }, + "required": [ + "lastTransitionTime", + "message", + "reason", + "status", + "type" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + } + }, + "required": [ + "acl_id", + "conditions" + ], + "type": "object", + "additionalProperties": false + } + }, + "type": "object" +} diff --git a/aiven.io/kafkatopic_v1alpha1.json b/aiven.io/kafkatopic_v1alpha1.json new file mode 100644 index 00000000..961a079d --- /dev/null +++ b/aiven.io/kafkatopic_v1alpha1.json @@ -0,0 +1,324 @@ +{ + "description": "KafkaTopic is the Schema for the kafkatopics API", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "type": "object" + }, + "spec": { + "description": "KafkaTopicSpec defines the desired state of KafkaTopic", + "properties": { + "authSecretRef": { + "description": "Authentication reference to Aiven token in a secret", + "properties": { + "key": { + "minLength": 1, + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key", + "name" + ], + "type": "object", + "additionalProperties": false + }, + "config": { + "description": "Kafka topic configuration", + "properties": { + "cleanup_policy": { + "description": "cleanup.policy value", + "type": "string" + }, + "compression_type": { + "description": "compression.type value", + "type": "string" + }, + "delete_retention_ms": { + "description": "delete.retention.ms value", + "format": "int64", + "type": "integer" + }, + "file_delete_delay_ms": { + "description": "file.delete.delay.ms value", + "format": "int64", + "type": "integer" + }, + "flush_messages": { + "description": "flush.messages value", + "format": "int64", + "type": "integer" + }, + "flush_ms": { + "description": "flush.ms value", + "format": "int64", + "type": "integer" + }, + "index_interval_bytes": { + "description": "index.interval.bytes value", + "format": "int64", + "type": "integer" + }, + "local_retention_bytes": { + "description": "local.retention.bytes value", + "format": "int64", + "type": "integer" + }, + "local_retention_ms": { + "description": "local.retention.ms value", + "format": "int64", + "type": "integer" + }, + "max_compaction_lag_ms": { + "description": "max.compaction.lag.ms value", + "format": "int64", + "type": "integer" + }, + "max_message_bytes": { + "description": "max.message.bytes value", + "format": "int64", + "type": "integer" + }, + "message_downconversion_enable": { + "description": "message.downconversion.enable value", + "type": "boolean" + }, + "message_format_version": { + "description": "message.format.version value", + "type": "string" + }, + "message_timestamp_difference_max_ms": { + "description": "message.timestamp.difference.max.ms value", + "format": "int64", + "type": "integer" + }, + "message_timestamp_type": { + "description": "message.timestamp.type value", + "type": "string" + }, + "min_cleanable_dirty_ratio": { + "description": "min.cleanable.dirty.ratio value", + "type": "number" + }, + "min_compaction_lag_ms": { + "description": "min.compaction.lag.ms value", + "format": "int64", + "type": "integer" + }, + "min_insync_replicas": { + "description": "min.insync.replicas value", + "format": "int64", + "type": "integer" + }, + "preallocate": { + "description": "preallocate value", + "type": "boolean" + }, + "remote_storage_enable": { + "description": "remote_storage_enable", + "type": "boolean" + }, + "retention_bytes": { + "description": "retention.bytes value", + "format": "int64", + "type": "integer" + }, + "retention_ms": { + "description": "retention.ms value", + "format": "int64", + "type": "integer" + }, + "segment_bytes": { + "description": "segment.bytes value", + "format": "int64", + "type": "integer" + }, + "segment_index_bytes": { + "description": "segment.index.bytes value", + "format": "int64", + "type": "integer" + }, + "segment_jitter_ms": { + "description": "segment.jitter.ms value", + "format": "int64", + "type": "integer" + }, + "segment_ms": { + "description": "segment.ms value", + "format": "int64", + "type": "integer" + } + }, + "type": "object", + "additionalProperties": false + }, + "partitions": { + "description": "Number of partitions to create in the topic", + "maximum": 1000000, + "minimum": 1, + "type": "integer" + }, + "project": { + "description": "Identifies the project this resource belongs to", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "replication": { + "description": "Replication factor for the topic", + "minimum": 2, + "type": "integer" + }, + "serviceName": { + "description": "Specifies the name of the service that this resource belongs to", + "maxLength": 63, + "pattern": "^[a-z][-a-z0-9]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "tags": { + "description": "Kafka topic tags", + "items": { + "properties": { + "key": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + }, + "value": { + "maxLength": 256, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string" + } + }, + "required": [ + "key" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + }, + "termination_protection": { + "description": "It is a Kubernetes side deletion protections, which prevents the kafka topic\nfrom being deleted by Kubernetes. It is recommended to enable this for any production\ndatabases containing critical data.", + "type": "boolean" + }, + "topicName": { + "description": "Topic name. If provided, is used instead of metadata.name.\nThis field supports additional characters, has a longer length,\nand will replace metadata.name in future releases", + "maxLength": 249, + "minLength": 1, + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + } + }, + "required": [ + "partitions", + "project", + "replication", + "serviceName" + ], + "type": "object", + "additionalProperties": false + }, + "status": { + "description": "KafkaTopicStatus defines the observed state of KafkaTopic", + "properties": { + "conditions": { + "description": "Conditions represent the latest available observations of an KafkaTopic state", + "items": { + "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}", + "properties": { + "lastTransitionTime": { + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis 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", + "type": "string" + }, + "message": { + "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", + "maxLength": 32768, + "type": "string" + }, + "observedGeneration": { + "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "reason": { + "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", + "type": "string" + }, + "status": { + "description": "status of the condition, one of True, False, Unknown.", + "enum": [ + "True", + "False", + "Unknown" + ], + "type": "string" + }, + "type": { + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", + "type": "string" + } + }, + "required": [ + "lastTransitionTime", + "message", + "reason", + "status", + "type" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + }, + "state": { + "description": "State represents the state of the kafka topic", + "type": "string" + } + }, + "required": [ + "conditions", + "state" + ], + "type": "object", + "additionalProperties": false + } + }, + "type": "object" +} diff --git a/aiven.io/mysql_v1alpha1.json b/aiven.io/mysql_v1alpha1.json new file mode 100644 index 00000000..bacc1ab4 --- /dev/null +++ b/aiven.io/mysql_v1alpha1.json @@ -0,0 +1,726 @@ +{ + "description": "MySQL is the Schema for the mysqls API.\nInfo \"Exposes secret keys\": `MYSQL_HOST`, `MYSQL_PORT`, `MYSQL_DATABASE`, `MYSQL_USER`, `MYSQL_PASSWORD`, `MYSQL_SSL_MODE`, `MYSQL_URI`, `MYSQL_REPLICA_URI`, `MYSQL_CA_CERT`", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "type": "object" + }, + "spec": { + "description": "MySQLSpec defines the desired state of MySQL", + "properties": { + "authSecretRef": { + "description": "Authentication reference to Aiven token in a secret", + "properties": { + "key": { + "minLength": 1, + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key", + "name" + ], + "type": "object", + "additionalProperties": false + }, + "cloudName": { + "description": "Cloud the service runs in.", + "maxLength": 256, + "type": "string" + }, + "connInfoSecretTarget": { + "description": "Secret configuration.", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Annotations added to the secret", + "type": "object", + "x-kubernetes-preserve-unknown-fields": true + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels added to the secret", + "type": "object", + "x-kubernetes-preserve-unknown-fields": true + }, + "name": { + "description": "Name of the secret resource to be created. By default, it is equal to the resource name", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "prefix": { + "description": "Prefix for the secret's keys.\nAdded \"as is\" without any transformations.\nBy default, is equal to the kind name in uppercase + underscore, e.g. `KAFKA_`, `REDIS_`, etc.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "additionalProperties": false + }, + "connInfoSecretTargetDisabled": { + "description": "When true, the secret containing connection information will not be created, defaults to false. This field cannot be changed after resource creation.", + "type": "boolean", + "x-kubernetes-validations": [ + { + "message": "connInfoSecretTargetDisabled is immutable.", + "rule": "self == oldSelf" + } + ] + }, + "disk_space": { + "description": "The disk space of the service, possible values depend on the service type, the cloud provider and the project.\nReducing will result in the service re-balancing.\nThe removal of this field does not change the value.", + "pattern": "(?i)^[1-9][0-9]*(GiB|G)?$", + "type": "string" + }, + "maintenanceWindowDow": { + "description": "Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.", + "enum": [ + "monday", + "tuesday", + "wednesday", + "thursday", + "friday", + "saturday", + "sunday" + ], + "type": "string" + }, + "maintenanceWindowTime": { + "description": "Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.", + "maxLength": 8, + "type": "string" + }, + "plan": { + "description": "Subscription plan.", + "maxLength": 128, + "type": "string" + }, + "project": { + "description": "Identifies the project this resource belongs to", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "projectVPCRef": { + "description": "ProjectVPCRef reference to ProjectVPC resource to use its ID as ProjectVPCID automatically", + "properties": { + "name": { + "minLength": 1, + "type": "string" + }, + "namespace": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "additionalProperties": false + }, + "projectVpcId": { + "description": "Identifier of the VPC the service should be in, if any.", + "maxLength": 36, + "type": "string" + }, + "serviceIntegrations": { + "description": "Service integrations to specify when creating a service. Not applied after initial service creation", + "items": { + "description": "Service integrations to specify when creating a service. Not applied after initial service creation", + "properties": { + "integrationType": { + "enum": [ + "read_replica" + ], + "type": "string" + }, + "sourceServiceName": { + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "integrationType", + "sourceServiceName" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 1, + "type": "array", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Tags are key-value pairs that allow you to categorize services.", + "type": "object" + }, + "technicalEmails": { + "description": "Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability.", + "items": { + "properties": { + "email": { + "description": "Email address.", + "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", + "type": "string" + } + }, + "required": [ + "email" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 10, + "type": "array" + }, + "terminationProtection": { + "description": "Prevent service from being deleted. It is recommended to have this enabled for all services.", + "type": "boolean" + }, + "userConfig": { + "description": "MySQL specific user configuration options", + "properties": { + "additional_backup_regions": { + "description": "Additional Cloud Regions for Backup Replication", + "items": { + "type": "string" + }, + "maxItems": 1, + "type": "array" + }, + "admin_password": { + "description": "Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.", + "maxLength": 256, + "minLength": 8, + "pattern": "^[a-zA-Z0-9-_]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "admin_username": { + "description": "Custom username for admin user. This must be set only when a new service is being created.", + "maxLength": 64, + "pattern": "^[_A-Za-z0-9][-._A-Za-z0-9]{0,63}$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "backup_hour": { + "description": "The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed.", + "maximum": 23, + "minimum": 0, + "type": "integer" + }, + "backup_minute": { + "description": "The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed.", + "maximum": 59, + "minimum": 0, + "type": "integer" + }, + "binlog_retention_period": { + "description": "The minimum amount of time in seconds to keep binlog entries before deletion. This may be extended for services that require binlog entries for longer than the default for example if using the MySQL Debezium Kafka connector.", + "maximum": 86400, + "minimum": 600, + "type": "integer" + }, + "ip_filter": { + "description": "Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'", + "items": { + "description": "CIDR address block, either as a string, or in a dict with an optional description field", + "properties": { + "description": { + "description": "Description for IP filter list entry", + "maxLength": 1024, + "type": "string" + }, + "network": { + "description": "CIDR address block", + "maxLength": 43, + "type": "string" + } + }, + "required": [ + "network" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 1024, + "type": "array" + }, + "migration": { + "description": "Migrate data from existing server", + "properties": { + "dbname": { + "description": "Database name for bootstrapping the initial connection", + "maxLength": 63, + "type": "string" + }, + "host": { + "description": "Hostname or IP address of the server where to migrate data from", + "maxLength": 255, + "type": "string" + }, + "ignore_dbs": { + "description": "Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment)", + "maxLength": 2048, + "type": "string" + }, + "method": { + "description": "The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types)", + "enum": [ + "dump", + "replication" + ], + "type": "string" + }, + "password": { + "description": "Password for authentication with the server where to migrate data from", + "maxLength": 256, + "type": "string" + }, + "port": { + "description": "Port number of the server where to migrate data from", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "ssl": { + "description": "The server where to migrate data from is secured with SSL", + "type": "boolean" + }, + "username": { + "description": "User name for authentication with the server where to migrate data from", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "host", + "port" + ], + "type": "object", + "additionalProperties": false + }, + "mysql": { + "description": "mysql.conf configuration values", + "properties": { + "connect_timeout": { + "description": "The number of seconds that the mysqld server waits for a connect packet before responding with Bad handshake", + "maximum": 3600, + "minimum": 2, + "type": "integer" + }, + "default_time_zone": { + "description": "Default server time zone as an offset from UTC (from -12:00 to +12:00), a time zone name, or 'SYSTEM' to use the MySQL server default.", + "maxLength": 100, + "minLength": 2, + "pattern": "^([-+][\\d:]*|[\\w/]*)$", + "type": "string" + }, + "group_concat_max_len": { + "description": "The maximum permitted result length in bytes for the GROUP_CONCAT() function.", + "minimum": 4, + "type": "integer" + }, + "information_schema_stats_expiry": { + "description": "The time, in seconds, before cached statistics expire", + "maximum": 31536000, + "minimum": 900, + "type": "integer" + }, + "innodb_change_buffer_max_size": { + "description": "Maximum size for the InnoDB change buffer, as a percentage of the total size of the buffer pool. Default is 25", + "maximum": 50, + "minimum": 0, + "type": "integer" + }, + "innodb_flush_neighbors": { + "description": "Specifies whether flushing a page from the InnoDB buffer pool also flushes other dirty pages in the same extent (default is 1): 0 - dirty pages in the same extent are not flushed, 1 - flush contiguous dirty pages in the same extent, 2 - flush dirty pages in the same extent", + "maximum": 2, + "minimum": 0, + "type": "integer" + }, + "innodb_ft_min_token_size": { + "description": "Minimum length of words that are stored in an InnoDB FULLTEXT index. Changing this parameter will lead to a restart of the MySQL service.", + "maximum": 16, + "minimum": 0, + "type": "integer" + }, + "innodb_ft_server_stopword_table": { + "description": "This option is used to specify your own InnoDB FULLTEXT index stopword list for all InnoDB tables.", + "maxLength": 1024, + "pattern": "^.+/.+$", + "type": "string" + }, + "innodb_lock_wait_timeout": { + "description": "The length of time in seconds an InnoDB transaction waits for a row lock before giving up. Default is 120.", + "maximum": 3600, + "minimum": 1, + "type": "integer" + }, + "innodb_log_buffer_size": { + "description": "The size in bytes of the buffer that InnoDB uses to write to the log files on disk.", + "maximum": 4294967295, + "minimum": 1048576, + "type": "integer" + }, + "innodb_online_alter_log_max_size": { + "description": "The upper limit in bytes on the size of the temporary log files used during online DDL operations for InnoDB tables.", + "maximum": 1099511627776, + "minimum": 65536, + "type": "integer" + }, + "innodb_print_all_deadlocks": { + "description": "When enabled, information about all deadlocks in InnoDB user transactions is recorded in the error log. Disabled by default.", + "type": "boolean" + }, + "innodb_read_io_threads": { + "description": "The number of I/O threads for read operations in InnoDB. Default is 4. Changing this parameter will lead to a restart of the MySQL service.", + "maximum": 64, + "minimum": 1, + "type": "integer" + }, + "innodb_rollback_on_timeout": { + "description": "When enabled a transaction timeout causes InnoDB to abort and roll back the entire transaction. Changing this parameter will lead to a restart of the MySQL service.", + "type": "boolean" + }, + "innodb_thread_concurrency": { + "description": "Defines the maximum number of threads permitted inside of InnoDB. Default is 0 (infinite concurrency - no limit)", + "maximum": 1000, + "minimum": 0, + "type": "integer" + }, + "innodb_write_io_threads": { + "description": "The number of I/O threads for write operations in InnoDB. Default is 4. Changing this parameter will lead to a restart of the MySQL service.", + "maximum": 64, + "minimum": 1, + "type": "integer" + }, + "interactive_timeout": { + "description": "The number of seconds the server waits for activity on an interactive connection before closing it.", + "maximum": 604800, + "minimum": 30, + "type": "integer" + }, + "internal_tmp_mem_storage_engine": { + "description": "The storage engine for in-memory internal temporary tables.", + "enum": [ + "TempTable", + "MEMORY" + ], + "type": "string" + }, + "long_query_time": { + "description": "The slow_query_logs work as SQL statements that take more than long_query_time seconds to execute. Default is 10s", + "maximum": 3600, + "minimum": 0, + "type": "number" + }, + "max_allowed_packet": { + "description": "Size of the largest message in bytes that can be received by the server. Default is 67108864 (64M)", + "maximum": 1073741824, + "minimum": 102400, + "type": "integer" + }, + "max_heap_table_size": { + "description": "Limits the size of internal in-memory tables. Also set tmp_table_size. Default is 16777216 (16M)", + "maximum": 1073741824, + "minimum": 1048576, + "type": "integer" + }, + "net_buffer_length": { + "description": "Start sizes of connection buffer and result buffer. Default is 16384 (16K). Changing this parameter will lead to a restart of the MySQL service.", + "maximum": 1048576, + "minimum": 1024, + "type": "integer" + }, + "net_read_timeout": { + "description": "The number of seconds to wait for more data from a connection before aborting the read.", + "maximum": 3600, + "minimum": 1, + "type": "integer" + }, + "net_write_timeout": { + "description": "The number of seconds to wait for a block to be written to a connection before aborting the write.", + "maximum": 3600, + "minimum": 1, + "type": "integer" + }, + "slow_query_log": { + "description": "Slow query log enables capturing of slow queries. Setting slow_query_log to false also truncates the mysql.slow_log table. Default is off", + "type": "boolean" + }, + "sort_buffer_size": { + "description": "Sort buffer size in bytes for ORDER BY optimization. Default is 262144 (256K)", + "maximum": 1073741824, + "minimum": 32768, + "type": "integer" + }, + "sql_mode": { + "description": "Global SQL mode. Set to empty to use MySQL server defaults. When creating a new service and not setting this field Aiven default SQL mode (strict, SQL standard compliant) will be assigned.", + "maxLength": 1024, + "pattern": "^[A-Z_]*(,[A-Z_]+)*$", + "type": "string" + }, + "sql_require_primary_key": { + "description": "Require primary key to be defined for new tables or old tables modified with ALTER TABLE and fail if missing. It is recommended to always have primary keys because various functionality may break if any large table is missing them.", + "type": "boolean" + }, + "tmp_table_size": { + "description": "Limits the size of internal in-memory tables. Also set max_heap_table_size. Default is 16777216 (16M)", + "maximum": 1073741824, + "minimum": 1048576, + "type": "integer" + }, + "wait_timeout": { + "description": "The number of seconds the server waits for activity on a noninteractive connection before closing it.", + "maximum": 2147483, + "minimum": 1, + "type": "integer" + } + }, + "type": "object", + "additionalProperties": false + }, + "mysql_version": { + "description": "MySQL major version", + "enum": [ + "8" + ], + "type": "string" + }, + "private_access": { + "description": "Allow access to selected service ports from private networks", + "properties": { + "mysql": { + "description": "Allow clients to connect to mysql with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations", + "type": "boolean" + }, + "mysqlx": { + "description": "Allow clients to connect to mysqlx with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations", + "type": "boolean" + }, + "prometheus": { + "description": "Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "privatelink_access": { + "description": "Allow access to selected service components through Privatelink", + "properties": { + "mysql": { + "description": "Enable mysql", + "type": "boolean" + }, + "mysqlx": { + "description": "Enable mysqlx", + "type": "boolean" + }, + "prometheus": { + "description": "Enable prometheus", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "project_to_fork_from": { + "description": "Name of another project to fork a service from. This has effect only when a new service is being created.", + "maxLength": 63, + "pattern": "^[a-z][-a-z0-9]{0,63}$|^$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "public_access": { + "description": "Allow access to selected service ports from the public Internet", + "properties": { + "mysql": { + "description": "Allow clients to connect to mysql from the public internet for service nodes that are in a project VPC or another type of private network", + "type": "boolean" + }, + "mysqlx": { + "description": "Allow clients to connect to mysqlx from the public internet for service nodes that are in a project VPC or another type of private network", + "type": "boolean" + }, + "prometheus": { + "description": "Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "recovery_target_time": { + "description": "Recovery target time when forking a service. This has effect only when a new service is being created.", + "maxLength": 32, + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "service_log": { + "description": "Store logs for the service so that they are available in the HTTP API and console.", + "type": "boolean" + }, + "service_to_fork_from": { + "description": "Name of another service to fork from. This has effect only when a new service is being created.", + "maxLength": 64, + "pattern": "^[a-z][-a-z0-9]{0,63}$|^$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "static_ips": { + "description": "Use static public IP addresses", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + } + }, + "required": [ + "plan", + "project" + ], + "type": "object", + "x-kubernetes-validations": [ + { + "message": "connInfoSecretTargetDisabled can only be set during resource creation.", + "rule": "has(oldSelf.connInfoSecretTargetDisabled) == has(self.connInfoSecretTargetDisabled)" + } + ], + "additionalProperties": false + }, + "status": { + "description": "ServiceStatus defines the observed state of service", + "properties": { + "conditions": { + "description": "Conditions represent the latest available observations of a service state", + "items": { + "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}", + "properties": { + "lastTransitionTime": { + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis 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", + "type": "string" + }, + "message": { + "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", + "maxLength": 32768, + "type": "string" + }, + "observedGeneration": { + "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "reason": { + "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", + "type": "string" + }, + "status": { + "description": "status of the condition, one of True, False, Unknown.", + "enum": [ + "True", + "False", + "Unknown" + ], + "type": "string" + }, + "type": { + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", + "type": "string" + } + }, + "required": [ + "lastTransitionTime", + "message", + "reason", + "status", + "type" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + }, + "state": { + "description": "Service state", + "type": "string" + } + }, + "type": "object", + "additionalProperties": false + } + }, + "type": "object" +} diff --git a/aiven.io/opensearch_v1alpha1.json b/aiven.io/opensearch_v1alpha1.json new file mode 100644 index 00000000..60a7c469 --- /dev/null +++ b/aiven.io/opensearch_v1alpha1.json @@ -0,0 +1,1032 @@ +{ + "description": "OpenSearch is the Schema for the opensearches API.\nInfo \"Exposes secret keys\": `OPENSEARCH_HOST`, `OPENSEARCH_PORT`, `OPENSEARCH_USER`, `OPENSEARCH_PASSWORD`", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "type": "object" + }, + "spec": { + "description": "OpenSearchSpec defines the desired state of OpenSearch", + "properties": { + "authSecretRef": { + "description": "Authentication reference to Aiven token in a secret", + "properties": { + "key": { + "minLength": 1, + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key", + "name" + ], + "type": "object", + "additionalProperties": false + }, + "cloudName": { + "description": "Cloud the service runs in.", + "maxLength": 256, + "type": "string" + }, + "connInfoSecretTarget": { + "description": "Secret configuration.", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Annotations added to the secret", + "type": "object", + "x-kubernetes-preserve-unknown-fields": true + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels added to the secret", + "type": "object", + "x-kubernetes-preserve-unknown-fields": true + }, + "name": { + "description": "Name of the secret resource to be created. By default, it is equal to the resource name", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "prefix": { + "description": "Prefix for the secret's keys.\nAdded \"as is\" without any transformations.\nBy default, is equal to the kind name in uppercase + underscore, e.g. `KAFKA_`, `REDIS_`, etc.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "additionalProperties": false + }, + "connInfoSecretTargetDisabled": { + "description": "When true, the secret containing connection information will not be created, defaults to false. This field cannot be changed after resource creation.", + "type": "boolean", + "x-kubernetes-validations": [ + { + "message": "connInfoSecretTargetDisabled is immutable.", + "rule": "self == oldSelf" + } + ] + }, + "disk_space": { + "description": "The disk space of the service, possible values depend on the service type, the cloud provider and the project.\nReducing will result in the service re-balancing.\nThe removal of this field does not change the value.", + "pattern": "(?i)^[1-9][0-9]*(GiB|G)?$", + "type": "string" + }, + "maintenanceWindowDow": { + "description": "Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.", + "enum": [ + "monday", + "tuesday", + "wednesday", + "thursday", + "friday", + "saturday", + "sunday" + ], + "type": "string" + }, + "maintenanceWindowTime": { + "description": "Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.", + "maxLength": 8, + "type": "string" + }, + "plan": { + "description": "Subscription plan.", + "maxLength": 128, + "type": "string" + }, + "project": { + "description": "Identifies the project this resource belongs to", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "projectVPCRef": { + "description": "ProjectVPCRef reference to ProjectVPC resource to use its ID as ProjectVPCID automatically", + "properties": { + "name": { + "minLength": 1, + "type": "string" + }, + "namespace": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "additionalProperties": false + }, + "projectVpcId": { + "description": "Identifier of the VPC the service should be in, if any.", + "maxLength": 36, + "type": "string" + }, + "serviceIntegrations": { + "description": "Service integrations to specify when creating a service. Not applied after initial service creation", + "items": { + "description": "Service integrations to specify when creating a service. Not applied after initial service creation", + "properties": { + "integrationType": { + "enum": [ + "read_replica" + ], + "type": "string" + }, + "sourceServiceName": { + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "integrationType", + "sourceServiceName" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 1, + "type": "array", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Tags are key-value pairs that allow you to categorize services.", + "type": "object" + }, + "technicalEmails": { + "description": "Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability.", + "items": { + "properties": { + "email": { + "description": "Email address.", + "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", + "type": "string" + } + }, + "required": [ + "email" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 10, + "type": "array" + }, + "terminationProtection": { + "description": "Prevent service from being deleted. It is recommended to have this enabled for all services.", + "type": "boolean" + }, + "userConfig": { + "description": "OpenSearch specific user configuration options", + "properties": { + "additional_backup_regions": { + "description": "Additional Cloud Regions for Backup Replication", + "items": { + "type": "string" + }, + "maxItems": 1, + "type": "array" + }, + "custom_domain": { + "description": "Serve the web frontend using a custom CNAME pointing to the Aiven DNS name", + "maxLength": 255, + "type": "string" + }, + "disable_replication_factor_adjustment": { + "description": "DEPRECATED: Disable automatic replication factor adjustment for multi-node services. By default, Aiven ensures all indexes are replicated at least to two nodes. Note: Due to potential data loss in case of losing a service node, this setting can no longer be activated.", + "type": "boolean" + }, + "index_patterns": { + "description": "Index patterns", + "items": { + "description": "Allows you to create glob style patterns and set a max number of indexes matching this pattern you want to keep. Creating indexes exceeding this value will cause the oldest one to get deleted. You could for example create a pattern looking like 'logs.?' and then create index logs.1, logs.2 etc, it will delete logs.1 once you create logs.6. Do note 'logs.?' does not apply to logs.10. Note: Setting max_index_count to 0 will do nothing and the pattern gets ignored.", + "properties": { + "max_index_count": { + "description": "Maximum number of indexes to keep", + "minimum": 0, + "type": "integer" + }, + "pattern": { + "description": "fnmatch pattern", + "maxLength": 1024, + "pattern": "^[A-Za-z0-9-_.*?]+$", + "type": "string" + }, + "sorting_algorithm": { + "description": "Deletion sorting algorithm", + "enum": [ + "alphabetical", + "creation_date" + ], + "type": "string" + } + }, + "required": [ + "max_index_count", + "pattern" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 512, + "type": "array" + }, + "index_template": { + "description": "Template settings for all new indexes", + "properties": { + "mapping_nested_objects_limit": { + "description": "The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000.", + "maximum": 100000, + "minimum": 0, + "type": "integer" + }, + "number_of_replicas": { + "description": "The number of replicas each primary shard has.", + "maximum": 29, + "minimum": 0, + "type": "integer" + }, + "number_of_shards": { + "description": "The number of primary shards that an index should have.", + "maximum": 1024, + "minimum": 1, + "type": "integer" + } + }, + "type": "object", + "additionalProperties": false + }, + "ip_filter": { + "description": "Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'", + "items": { + "description": "CIDR address block, either as a string, or in a dict with an optional description field", + "properties": { + "description": { + "description": "Description for IP filter list entry", + "maxLength": 1024, + "type": "string" + }, + "network": { + "description": "CIDR address block", + "maxLength": 43, + "type": "string" + } + }, + "required": [ + "network" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 1024, + "type": "array" + }, + "keep_index_refresh_interval": { + "description": "Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn't fit your case, you can disable this by setting up this flag to true.", + "type": "boolean" + }, + "max_index_count": { + "description": "DEPRECATED: use index_patterns instead", + "minimum": 0, + "type": "integer" + }, + "openid": { + "description": "OpenSearch OpenID Connect Configuration", + "properties": { + "client_id": { + "description": "The ID of the OpenID Connect client configured in your IdP. Required.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[^\\r\\n]*$", + "type": "string" + }, + "client_secret": { + "description": "The client secret of the OpenID Connect client configured in your IdP. Required.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[^\\r\\n]*$", + "type": "string" + }, + "connect_url": { + "description": "The URL of your IdP where the Security plugin can find the OpenID Connect metadata/configuration settings.", + "maxLength": 2048, + "type": "string" + }, + "enabled": { + "description": "Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider.", + "type": "boolean" + }, + "header": { + "description": "HTTP header name of the JWT token. Optional. Default is Authorization.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[^\\r\\n]*$", + "type": "string" + }, + "jwt_header": { + "description": "The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer . Optional. Default is Authorization.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[^\\r\\n]*$", + "type": "string" + }, + "jwt_url_parameter": { + "description": "If the token is not transmitted in the HTTP header, but as an URL parameter, define the name of the parameter here. Optional.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[^\\r\\n]*$", + "type": "string" + }, + "refresh_rate_limit_count": { + "description": "The maximum number of unknown key IDs in the time frame. Default is 10. Optional.", + "minimum": 10, + "type": "integer" + }, + "refresh_rate_limit_time_window_ms": { + "description": "The time frame to use when checking the maximum number of unknown key IDs, in milliseconds. Optional.Default is 10000 (10 seconds).", + "minimum": 10000, + "type": "integer" + }, + "roles_key": { + "description": "The key in the JSON payload that stores the user\u2019s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[^\\r\\n]*$", + "type": "string" + }, + "scope": { + "description": "The scope of the identity token issued by the IdP. Optional. Default is openid profile email address phone.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[^\\r\\n]*$", + "type": "string" + }, + "subject_key": { + "description": "The key in the JSON payload that stores the user\u2019s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[^\\r\\n]*$", + "type": "string" + } + }, + "required": [ + "client_id", + "client_secret", + "connect_url", + "enabled" + ], + "type": "object", + "additionalProperties": false + }, + "opensearch": { + "description": "OpenSearch settings", + "properties": { + "action_auto_create_index_enabled": { + "description": "Explicitly allow or block automatic creation of indices. Defaults to true", + "type": "boolean" + }, + "action_destructive_requires_name": { + "description": "Require explicit index names when deleting", + "type": "boolean" + }, + "auth_failure_listeners": { + "description": "Opensearch Security Plugin Settings", + "properties": { + "internal_authentication_backend_limiting": { + "properties": { + "allowed_tries": { + "description": "The number of login attempts allowed before login is blocked", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "authentication_backend": { + "description": "internal_authentication_backend_limiting.authentication_backend", + "enum": [ + "internal" + ], + "maxLength": 1024, + "type": "string" + }, + "block_expiry_seconds": { + "description": "The duration of time that login remains blocked after a failed login", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "max_blocked_clients": { + "description": "internal_authentication_backend_limiting.max_blocked_clients", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "max_tracked_clients": { + "description": "The maximum number of tracked IP addresses that have failed login", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "time_window_seconds": { + "description": "The window of time in which the value for `allowed_tries` is enforced", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "type": { + "description": "internal_authentication_backend_limiting.type", + "enum": [ + "username" + ], + "maxLength": 1024, + "type": "string" + } + }, + "type": "object", + "additionalProperties": false + }, + "ip_rate_limiting": { + "description": "IP address rate limiting settings", + "properties": { + "allowed_tries": { + "description": "The number of login attempts allowed before login is blocked", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "block_expiry_seconds": { + "description": "The duration of time that login remains blocked after a failed login", + "maximum": 36000, + "minimum": 1, + "type": "integer" + }, + "max_blocked_clients": { + "description": "The maximum number of blocked IP addresses", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "max_tracked_clients": { + "description": "The maximum number of tracked IP addresses that have failed login", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "time_window_seconds": { + "description": "The window of time in which the value for `allowed_tries` is enforced", + "maximum": 36000, + "minimum": 1, + "type": "integer" + }, + "type": { + "description": "The type of rate limiting", + "enum": [ + "ip" + ], + "maxLength": 1024, + "type": "string" + } + }, + "type": "object", + "additionalProperties": false + } + }, + "type": "object", + "additionalProperties": false + }, + "cluster_max_shards_per_node": { + "description": "Controls the number of shards allowed in the cluster per data node", + "maximum": 10000, + "minimum": 100, + "type": "integer" + }, + "cluster_routing_allocation_node_concurrent_recoveries": { + "description": "How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to 2.", + "maximum": 16, + "minimum": 2, + "type": "integer" + }, + "email_sender_name": { + "description": "Sender name placeholder to be used in Opensearch Dashboards and Opensearch keystore", + "maxLength": 40, + "pattern": "^[a-zA-Z0-9-_]+$", + "type": "string" + }, + "email_sender_password": { + "description": "Sender password for Opensearch alerts to authenticate with SMTP server", + "maxLength": 1024, + "pattern": "^[^\\x00-\\x1F]+$", + "type": "string" + }, + "email_sender_username": { + "description": "Sender username for Opensearch alerts", + "maxLength": 320, + "pattern": "^[^\\x00-\\x1F]+$", + "type": "string" + }, + "enable_security_audit": { + "description": "Enable/Disable security audit", + "type": "boolean" + }, + "http_max_content_length": { + "description": "Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes.", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "http_max_header_size": { + "description": "The max size of allowed headers, in bytes", + "maximum": 262144, + "minimum": 1024, + "type": "integer" + }, + "http_max_initial_line_length": { + "description": "The max length of an HTTP URL, in bytes", + "maximum": 65536, + "minimum": 1024, + "type": "integer" + }, + "indices_fielddata_cache_size": { + "description": "Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations.", + "maximum": 100, + "minimum": 3, + "type": "integer" + }, + "indices_memory_index_buffer_size": { + "description": "Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance.", + "maximum": 40, + "minimum": 3, + "type": "integer" + }, + "indices_memory_max_index_buffer_size": { + "description": "Absolute value. Default is unbound. Doesn't work without indices.memory.index_buffer_size. Maximum amount of heap used for query cache, an absolute indices.memory.index_buffer_size maximum hard limit.", + "maximum": 2048, + "minimum": 3, + "type": "integer" + }, + "indices_memory_min_index_buffer_size": { + "description": "Absolute value. Default is 48mb. Doesn't work without indices.memory.index_buffer_size. Minimum amount of heap used for query cache, an absolute indices.memory.index_buffer_size minimal hard limit.", + "maximum": 2048, + "minimum": 3, + "type": "integer" + }, + "indices_queries_cache_size": { + "description": "Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other OpenSearch functionality.", + "maximum": 40, + "minimum": 3, + "type": "integer" + }, + "indices_query_bool_max_clause_count": { + "description": "Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value.", + "maximum": 4096, + "minimum": 64, + "type": "integer" + }, + "indices_recovery_max_bytes_per_sec": { + "description": "Limits total inbound and outbound recovery traffic for each node. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Defaults to 40mb", + "maximum": 400, + "minimum": 40, + "type": "integer" + }, + "indices_recovery_max_concurrent_file_chunks": { + "description": "Number of file chunks sent in parallel for each recovery. Defaults to 2.", + "maximum": 5, + "minimum": 2, + "type": "integer" + }, + "ism_enabled": { + "description": "Specifies whether ISM is enabled or not", + "type": "boolean" + }, + "ism_history_enabled": { + "description": "Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document.", + "type": "boolean" + }, + "ism_history_max_age": { + "description": "The maximum age before rolling over the audit history index in hours", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "ism_history_max_docs": { + "description": "The maximum number of documents before rolling over the audit history index.", + "minimum": 1, + "type": "integer" + }, + "ism_history_rollover_check_period": { + "description": "The time between rollover checks for the audit history index in hours.", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "ism_history_rollover_retention_period": { + "description": "How long audit history indices are kept in days.", + "maximum": 2147483647, + "minimum": 1, + "type": "integer" + }, + "override_main_response_version": { + "description": "Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false", + "type": "boolean" + }, + "plugins_alerting_filter_by_backend_roles": { + "description": "Enable or disable filtering of alerting by backend roles. Requires Security plugin. Defaults to false", + "type": "boolean" + }, + "reindex_remote_whitelist": { + "description": "Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.", + "items": { + "type": "string" + }, + "maxItems": 32, + "type": "array" + }, + "script_max_compilations_rate": { + "description": "Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context", + "maxLength": 1024, + "type": "string" + }, + "search_max_buckets": { + "description": "Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined.", + "maximum": 1000000, + "minimum": 1, + "type": "integer" + }, + "thread_pool_analyze_queue_size": { + "description": "Size for the thread pool queue. See documentation for exact details.", + "maximum": 2000, + "minimum": 10, + "type": "integer" + }, + "thread_pool_analyze_size": { + "description": "Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.", + "maximum": 128, + "minimum": 1, + "type": "integer" + }, + "thread_pool_force_merge_size": { + "description": "Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.", + "maximum": 128, + "minimum": 1, + "type": "integer" + }, + "thread_pool_get_queue_size": { + "description": "Size for the thread pool queue. See documentation for exact details.", + "maximum": 2000, + "minimum": 10, + "type": "integer" + }, + "thread_pool_get_size": { + "description": "Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.", + "maximum": 128, + "minimum": 1, + "type": "integer" + }, + "thread_pool_search_queue_size": { + "description": "Size for the thread pool queue. See documentation for exact details.", + "maximum": 2000, + "minimum": 10, + "type": "integer" + }, + "thread_pool_search_size": { + "description": "Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.", + "maximum": 128, + "minimum": 1, + "type": "integer" + }, + "thread_pool_search_throttled_queue_size": { + "description": "Size for the thread pool queue. See documentation for exact details.", + "maximum": 2000, + "minimum": 10, + "type": "integer" + }, + "thread_pool_search_throttled_size": { + "description": "Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.", + "maximum": 128, + "minimum": 1, + "type": "integer" + }, + "thread_pool_write_queue_size": { + "description": "Size for the thread pool queue. See documentation for exact details.", + "maximum": 2000, + "minimum": 10, + "type": "integer" + }, + "thread_pool_write_size": { + "description": "Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.", + "maximum": 128, + "minimum": 1, + "type": "integer" + } + }, + "type": "object", + "additionalProperties": false + }, + "opensearch_dashboards": { + "description": "OpenSearch Dashboards settings", + "properties": { + "enabled": { + "description": "Enable or disable OpenSearch Dashboards", + "type": "boolean" + }, + "max_old_space_size": { + "description": "Limits the maximum amount of memory (in MiB) the OpenSearch Dashboards process can use. This sets the max_old_space_size option of the nodejs running the OpenSearch Dashboards. Note: the memory reserved by OpenSearch Dashboards is not available for OpenSearch.", + "maximum": 2048, + "minimum": 64, + "type": "integer" + }, + "opensearch_request_timeout": { + "description": "Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch", + "maximum": 120000, + "minimum": 5000, + "type": "integer" + } + }, + "type": "object", + "additionalProperties": false + }, + "opensearch_version": { + "description": "OpenSearch major version", + "enum": [ + "1", + "2" + ], + "type": "string" + }, + "private_access": { + "description": "Allow access to selected service ports from private networks", + "properties": { + "opensearch": { + "description": "Allow clients to connect to opensearch with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations", + "type": "boolean" + }, + "opensearch_dashboards": { + "description": "Allow clients to connect to opensearch_dashboards with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations", + "type": "boolean" + }, + "prometheus": { + "description": "Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "privatelink_access": { + "description": "Allow access to selected service components through Privatelink", + "properties": { + "opensearch": { + "description": "Enable opensearch", + "type": "boolean" + }, + "opensearch_dashboards": { + "description": "Enable opensearch_dashboards", + "type": "boolean" + }, + "prometheus": { + "description": "Enable prometheus", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "project_to_fork_from": { + "description": "Name of another project to fork a service from. This has effect only when a new service is being created.", + "maxLength": 63, + "pattern": "^[a-z][-a-z0-9]{0,63}$|^$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "public_access": { + "description": "Allow access to selected service ports from the public Internet", + "properties": { + "opensearch": { + "description": "Allow clients to connect to opensearch from the public internet for service nodes that are in a project VPC or another type of private network", + "type": "boolean" + }, + "opensearch_dashboards": { + "description": "Allow clients to connect to opensearch_dashboards from the public internet for service nodes that are in a project VPC or another type of private network", + "type": "boolean" + }, + "prometheus": { + "description": "Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "recovery_basebackup_name": { + "description": "Name of the basebackup to restore in forked service", + "maxLength": 128, + "pattern": "^[a-zA-Z0-9-_:.]+$", + "type": "string" + }, + "saml": { + "description": "OpenSearch SAML configuration", + "properties": { + "enabled": { + "description": "Enables or disables SAML-based authentication for OpenSearch. When enabled, users can authenticate using SAML with an Identity Provider.", + "type": "boolean" + }, + "idp_entity_id": { + "description": "The unique identifier for the Identity Provider (IdP) entity that is used for SAML authentication. This value is typically provided by the IdP.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[^\\r\\n]*$", + "type": "string" + }, + "idp_metadata_url": { + "description": "The URL of the SAML metadata for the Identity Provider (IdP). This is used to configure SAML-based authentication with the IdP.", + "maxLength": 2048, + "minLength": 1, + "type": "string" + }, + "idp_pemtrustedcas_content": { + "description": "This parameter specifies the PEM-encoded root certificate authority (CA) content for the SAML identity provider (IdP) server verification. The root CA content is used to verify the SSL/TLS certificate presented by the server.", + "maxLength": 16384, + "type": "string" + }, + "roles_key": { + "description": "Optional. Specifies the attribute in the SAML response where role information is stored, if available. Role attributes are not required for SAML authentication, but can be included in SAML assertions by most Identity Providers (IdPs) to determine user access levels or permissions.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[^\\r\\n]*$", + "type": "string" + }, + "sp_entity_id": { + "description": "The unique identifier for the Service Provider (SP) entity that is used for SAML authentication. This value is typically provided by the SP.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[^\\r\\n]*$", + "type": "string" + }, + "subject_key": { + "description": "Optional. Specifies the attribute in the SAML response where the subject identifier is stored. If not configured, the NameID attribute is used by default.", + "maxLength": 256, + "minLength": 1, + "pattern": "^[^\\r\\n]*$", + "type": "string" + } + }, + "required": [ + "enabled", + "idp_entity_id", + "idp_metadata_url", + "sp_entity_id" + ], + "type": "object", + "additionalProperties": false + }, + "service_log": { + "description": "Store logs for the service so that they are available in the HTTP API and console.", + "type": "boolean" + }, + "service_to_fork_from": { + "description": "Name of another service to fork from. This has effect only when a new service is being created.", + "maxLength": 64, + "pattern": "^[a-z][-a-z0-9]{0,63}$|^$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "static_ips": { + "description": "Use static public IP addresses", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + } + }, + "required": [ + "plan", + "project" + ], + "type": "object", + "x-kubernetes-validations": [ + { + "message": "connInfoSecretTargetDisabled can only be set during resource creation.", + "rule": "has(oldSelf.connInfoSecretTargetDisabled) == has(self.connInfoSecretTargetDisabled)" + } + ], + "additionalProperties": false + }, + "status": { + "description": "ServiceStatus defines the observed state of service", + "properties": { + "conditions": { + "description": "Conditions represent the latest available observations of a service state", + "items": { + "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}", + "properties": { + "lastTransitionTime": { + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis 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", + "type": "string" + }, + "message": { + "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", + "maxLength": 32768, + "type": "string" + }, + "observedGeneration": { + "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "reason": { + "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", + "type": "string" + }, + "status": { + "description": "status of the condition, one of True, False, Unknown.", + "enum": [ + "True", + "False", + "Unknown" + ], + "type": "string" + }, + "type": { + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", + "type": "string" + } + }, + "required": [ + "lastTransitionTime", + "message", + "reason", + "status", + "type" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + }, + "state": { + "description": "Service state", + "type": "string" + } + }, + "type": "object", + "additionalProperties": false + } + }, + "type": "object" +} diff --git a/aiven.io/postgresql_v1alpha1.json b/aiven.io/postgresql_v1alpha1.json new file mode 100644 index 00000000..2ee31ecd --- /dev/null +++ b/aiven.io/postgresql_v1alpha1.json @@ -0,0 +1,1096 @@ +{ + "description": "PostgreSQL is the Schema for the postgresql API.\nInfo \"Exposes secret keys\": `POSTGRESQL_HOST`, `POSTGRESQL_PORT`, `POSTGRESQL_DATABASE`, `POSTGRESQL_USER`, `POSTGRESQL_PASSWORD`, `POSTGRESQL_SSLMODE`, `POSTGRESQL_DATABASE_URI`, `POSTGRESQL_CA_CERT`", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "type": "object" + }, + "spec": { + "description": "PostgreSQLSpec defines the desired state of postgres instance", + "properties": { + "authSecretRef": { + "description": "Authentication reference to Aiven token in a secret", + "properties": { + "key": { + "minLength": 1, + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key", + "name" + ], + "type": "object", + "additionalProperties": false + }, + "cloudName": { + "description": "Cloud the service runs in.", + "maxLength": 256, + "type": "string" + }, + "connInfoSecretTarget": { + "description": "Secret configuration.", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Annotations added to the secret", + "type": "object", + "x-kubernetes-preserve-unknown-fields": true + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels added to the secret", + "type": "object", + "x-kubernetes-preserve-unknown-fields": true + }, + "name": { + "description": "Name of the secret resource to be created. By default, it is equal to the resource name", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "prefix": { + "description": "Prefix for the secret's keys.\nAdded \"as is\" without any transformations.\nBy default, is equal to the kind name in uppercase + underscore, e.g. `KAFKA_`, `REDIS_`, etc.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "additionalProperties": false + }, + "connInfoSecretTargetDisabled": { + "description": "When true, the secret containing connection information will not be created, defaults to false. This field cannot be changed after resource creation.", + "type": "boolean", + "x-kubernetes-validations": [ + { + "message": "connInfoSecretTargetDisabled is immutable.", + "rule": "self == oldSelf" + } + ] + }, + "disk_space": { + "description": "The disk space of the service, possible values depend on the service type, the cloud provider and the project.\nReducing will result in the service re-balancing.\nThe removal of this field does not change the value.", + "pattern": "(?i)^[1-9][0-9]*(GiB|G)?$", + "type": "string" + }, + "maintenanceWindowDow": { + "description": "Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.", + "enum": [ + "monday", + "tuesday", + "wednesday", + "thursday", + "friday", + "saturday", + "sunday" + ], + "type": "string" + }, + "maintenanceWindowTime": { + "description": "Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.", + "maxLength": 8, + "type": "string" + }, + "plan": { + "description": "Subscription plan.", + "maxLength": 128, + "type": "string" + }, + "project": { + "description": "Identifies the project this resource belongs to", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "projectVPCRef": { + "description": "ProjectVPCRef reference to ProjectVPC resource to use its ID as ProjectVPCID automatically", + "properties": { + "name": { + "minLength": 1, + "type": "string" + }, + "namespace": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "additionalProperties": false + }, + "projectVpcId": { + "description": "Identifier of the VPC the service should be in, if any.", + "maxLength": 36, + "type": "string" + }, + "serviceIntegrations": { + "description": "Service integrations to specify when creating a service. Not applied after initial service creation", + "items": { + "description": "Service integrations to specify when creating a service. Not applied after initial service creation", + "properties": { + "integrationType": { + "enum": [ + "read_replica" + ], + "type": "string" + }, + "sourceServiceName": { + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "integrationType", + "sourceServiceName" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 1, + "type": "array", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Tags are key-value pairs that allow you to categorize services.", + "type": "object" + }, + "technicalEmails": { + "description": "Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability.", + "items": { + "properties": { + "email": { + "description": "Email address.", + "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", + "type": "string" + } + }, + "required": [ + "email" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 10, + "type": "array" + }, + "terminationProtection": { + "description": "Prevent service from being deleted. It is recommended to have this enabled for all services.", + "type": "boolean" + }, + "userConfig": { + "description": "PostgreSQL specific user configuration options", + "properties": { + "additional_backup_regions": { + "description": "Additional Cloud Regions for Backup Replication", + "items": { + "type": "string" + }, + "maxItems": 1, + "type": "array" + }, + "admin_password": { + "description": "Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.", + "maxLength": 256, + "minLength": 8, + "pattern": "^[a-zA-Z0-9-_]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "admin_username": { + "description": "Custom username for admin user. This must be set only when a new service is being created.", + "maxLength": 64, + "pattern": "^[_A-Za-z0-9][-._A-Za-z0-9]{0,63}$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "backup_hour": { + "description": "The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed.", + "maximum": 23, + "minimum": 0, + "type": "integer" + }, + "backup_minute": { + "description": "The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed.", + "maximum": 59, + "minimum": 0, + "type": "integer" + }, + "enable_ipv6": { + "description": "Register AAAA DNS records for the service, and allow IPv6 packets to service ports", + "type": "boolean" + }, + "ip_filter": { + "description": "Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'", + "items": { + "description": "CIDR address block, either as a string, or in a dict with an optional description field", + "properties": { + "description": { + "description": "Description for IP filter list entry", + "maxLength": 1024, + "type": "string" + }, + "network": { + "description": "CIDR address block", + "maxLength": 43, + "type": "string" + } + }, + "required": [ + "network" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 1024, + "type": "array" + }, + "migration": { + "description": "Migrate data from existing server", + "properties": { + "dbname": { + "description": "Database name for bootstrapping the initial connection", + "maxLength": 63, + "type": "string" + }, + "host": { + "description": "Hostname or IP address of the server where to migrate data from", + "maxLength": 255, + "type": "string" + }, + "ignore_dbs": { + "description": "Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment)", + "maxLength": 2048, + "type": "string" + }, + "method": { + "description": "The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types)", + "enum": [ + "dump", + "replication" + ], + "type": "string" + }, + "password": { + "description": "Password for authentication with the server where to migrate data from", + "maxLength": 256, + "type": "string" + }, + "port": { + "description": "Port number of the server where to migrate data from", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "ssl": { + "description": "The server where to migrate data from is secured with SSL", + "type": "boolean" + }, + "username": { + "description": "User name for authentication with the server where to migrate data from", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "host", + "port" + ], + "type": "object", + "additionalProperties": false + }, + "pg": { + "description": "postgresql.conf configuration values", + "properties": { + "autovacuum_analyze_scale_factor": { + "description": "Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE. The default is 0.2 (20% of table size)", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "autovacuum_analyze_threshold": { + "description": "Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is 50 tuples.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "autovacuum_freeze_max_age": { + "description": "Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. Note that the system will launch autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. This parameter will cause the server to be restarted.", + "maximum": 1500000000, + "minimum": 200000000, + "type": "integer" + }, + "autovacuum_max_workers": { + "description": "Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is three. This parameter can only be set at server start.", + "maximum": 20, + "minimum": 1, + "type": "integer" + }, + "autovacuum_naptime": { + "description": "Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds, and the default is one minute", + "maximum": 86400, + "minimum": 1, + "type": "integer" + }, + "autovacuum_vacuum_cost_delay": { + "description": "Specifies the cost delay value that will be used in automatic VACUUM operations. If -1 is specified, the regular vacuum_cost_delay value will be used. The default value is 20 milliseconds", + "maximum": 100, + "minimum": -1, + "type": "integer" + }, + "autovacuum_vacuum_cost_limit": { + "description": "Specifies the cost limit value that will be used in automatic VACUUM operations. If -1 is specified (which is the default), the regular vacuum_cost_limit value will be used.", + "maximum": 10000, + "minimum": -1, + "type": "integer" + }, + "autovacuum_vacuum_scale_factor": { + "description": "Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM. The default is 0.2 (20% of table size)", + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "autovacuum_vacuum_threshold": { + "description": "Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is 50 tuples", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "bgwriter_delay": { + "description": "Specifies the delay between activity rounds for the background writer in milliseconds. Default is 200.", + "maximum": 10000, + "minimum": 10, + "type": "integer" + }, + "bgwriter_flush_after": { + "description": "Whenever more than bgwriter_flush_after bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes, default is 512. Setting of 0 disables forced writeback.", + "maximum": 2048, + "minimum": 0, + "type": "integer" + }, + "bgwriter_lru_maxpages": { + "description": "In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. Default is 100.", + "maximum": 1073741823, + "minimum": 0, + "type": "integer" + }, + "bgwriter_lru_multiplier": { + "description": "The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a \u201cjust in time\u201d policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is 2.0.", + "maximum": 10, + "minimum": 0, + "type": "number" + }, + "deadlock_timeout": { + "description": "This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition.", + "maximum": 1800000, + "minimum": 500, + "type": "integer" + }, + "default_toast_compression": { + "description": "Specifies the default TOAST compression method for values of compressible columns (the default is lz4).", + "enum": [ + "lz4", + "pglz" + ], + "type": "string" + }, + "idle_in_transaction_session_timeout": { + "description": "Time out sessions with open transactions after this number of milliseconds", + "maximum": 604800000, + "minimum": 0, + "type": "integer" + }, + "jit": { + "description": "Controls system-wide use of Just-in-Time Compilation (JIT).", + "type": "boolean" + }, + "log_autovacuum_min_duration": { + "description": "Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one (the default) disables logging autovacuum actions.", + "maximum": 2147483647, + "minimum": -1, + "type": "integer" + }, + "log_error_verbosity": { + "description": "Controls the amount of detail written in the server log for each message that is logged.", + "enum": [ + "TERSE", + "DEFAULT", + "VERBOSE" + ], + "type": "string" + }, + "log_line_prefix": { + "description": "Choose from one of the available log formats.", + "enum": [ + "'pid=%p,user=%u,db=%d,app=%a,client=%h '", + "'%t [%p]: [%l-1] user=%u,db=%d,app=%a,client=%h '", + "'%m [%p] %q[user=%u,db=%d,app=%a] '" + ], + "type": "string" + }, + "log_min_duration_statement": { + "description": "Log statements that take more than this number of milliseconds to run, -1 disables", + "maximum": 86400000, + "minimum": -1, + "type": "integer" + }, + "log_temp_files": { + "description": "Log statements for each temporary file created larger than this number of kilobytes, -1 disables", + "maximum": 2147483647, + "minimum": -1, + "type": "integer" + }, + "max_files_per_process": { + "description": "PostgreSQL maximum number of files that can be open per process", + "maximum": 4096, + "minimum": 1000, + "type": "integer" + }, + "max_locks_per_transaction": { + "description": "PostgreSQL maximum locks per transaction", + "maximum": 6400, + "minimum": 64, + "type": "integer" + }, + "max_logical_replication_workers": { + "description": "PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers)", + "maximum": 64, + "minimum": 4, + "type": "integer" + }, + "max_parallel_workers": { + "description": "Sets the maximum number of workers that the system can support for parallel queries", + "maximum": 96, + "minimum": 0, + "type": "integer" + }, + "max_parallel_workers_per_gather": { + "description": "Sets the maximum number of workers that can be started by a single Gather or Gather Merge node", + "maximum": 96, + "minimum": 0, + "type": "integer" + }, + "max_pred_locks_per_transaction": { + "description": "PostgreSQL maximum predicate locks per transaction", + "maximum": 5120, + "minimum": 64, + "type": "integer" + }, + "max_prepared_transactions": { + "description": "PostgreSQL maximum prepared transactions", + "maximum": 10000, + "minimum": 0, + "type": "integer" + }, + "max_replication_slots": { + "description": "PostgreSQL maximum replication slots", + "maximum": 64, + "minimum": 8, + "type": "integer" + }, + "max_slot_wal_keep_size": { + "description": "PostgreSQL maximum WAL size (MB) reserved for replication slots. Default is -1 (unlimited). wal_keep_size minimum WAL size setting takes precedence over this.", + "maximum": 2147483647, + "minimum": -1, + "type": "integer" + }, + "max_stack_depth": { + "description": "Maximum depth of the stack in bytes", + "maximum": 6291456, + "minimum": 2097152, + "type": "integer" + }, + "max_standby_archive_delay": { + "description": "Max standby archive delay in milliseconds", + "maximum": 43200000, + "minimum": 1, + "type": "integer" + }, + "max_standby_streaming_delay": { + "description": "Max standby streaming delay in milliseconds", + "maximum": 43200000, + "minimum": 1, + "type": "integer" + }, + "max_wal_senders": { + "description": "PostgreSQL maximum WAL senders", + "maximum": 64, + "minimum": 20, + "type": "integer" + }, + "max_worker_processes": { + "description": "Sets the maximum number of background processes that the system can support", + "maximum": 96, + "minimum": 8, + "type": "integer" + }, + "pg_partman_bgw.interval": { + "description": "Sets the time interval to run pg_partman's scheduled tasks", + "maximum": 604800, + "minimum": 3600, + "type": "integer" + }, + "pg_partman_bgw.role": { + "description": "Controls which role to use for pg_partman's scheduled background tasks.", + "maxLength": 64, + "pattern": "^[_A-Za-z0-9][-._A-Za-z0-9]{0,63}$", + "type": "string" + }, + "pg_stat_monitor.pgsm_enable_query_plan": { + "description": "Enables or disables query plan monitoring", + "type": "boolean" + }, + "pg_stat_monitor.pgsm_max_buckets": { + "description": "Sets the maximum number of buckets", + "maximum": 10, + "minimum": 1, + "type": "integer" + }, + "pg_stat_statements.track": { + "description": "Controls which statements are counted. Specify top to track top-level statements (those issued directly by clients), all to also track nested statements (such as statements invoked within functions), or none to disable statement statistics collection. The default value is top.", + "enum": [ + "all", + "top", + "none" + ], + "type": "string" + }, + "temp_file_limit": { + "description": "PostgreSQL temporary file limit in KiB, -1 for unlimited", + "maximum": 2147483647, + "minimum": -1, + "type": "integer" + }, + "timezone": { + "description": "PostgreSQL service timezone", + "maxLength": 64, + "pattern": "^[\\w/]*$", + "type": "string" + }, + "track_activity_query_size": { + "description": "Specifies the number of bytes reserved to track the currently executing command for each active session.", + "maximum": 10240, + "minimum": 1024, + "type": "integer" + }, + "track_commit_timestamp": { + "description": "Record commit time of transactions.", + "enum": [ + "off", + "on" + ], + "type": "string" + }, + "track_functions": { + "description": "Enables tracking of function call counts and time used.", + "enum": [ + "all", + "pl", + "none" + ], + "type": "string" + }, + "track_io_timing": { + "description": "Enables timing of database I/O calls. This parameter is off by default, because it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms.", + "enum": [ + "off", + "on" + ], + "type": "string" + }, + "wal_sender_timeout": { + "description": "Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout.", + "type": "integer" + }, + "wal_writer_delay": { + "description": "WAL flush interval in milliseconds. Note that setting this value to lower than the default 200ms may negatively impact performance", + "maximum": 200, + "minimum": 10, + "type": "integer" + } + }, + "type": "object", + "additionalProperties": false + }, + "pg_qualstats": { + "description": "Deprecated. System-wide settings for the pg_qualstats extension", + "properties": { + "enabled": { + "description": "Deprecated. Enable / Disable pg_qualstats", + "type": "boolean" + }, + "min_err_estimate_num": { + "description": "Deprecated. Error estimation num threshold to save quals", + "minimum": 0, + "type": "integer" + }, + "min_err_estimate_ratio": { + "description": "Deprecated. Error estimation ratio threshold to save quals", + "minimum": 0, + "type": "integer" + }, + "track_constants": { + "description": "Deprecated. Enable / Disable pg_qualstats constants tracking", + "type": "boolean" + }, + "track_pg_catalog": { + "description": "Deprecated. Track quals on system catalogs too.", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "pg_read_replica": { + "description": "Should the service which is being forked be a read replica (deprecated, use read_replica service integration instead).", + "type": "boolean" + }, + "pg_service_to_fork_from": { + "description": "Name of the PG Service from which to fork (deprecated, use service_to_fork_from). This has effect only when a new service is being created.", + "maxLength": 64, + "pattern": "^[a-z][-a-z0-9]{0,63}$|^$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "pg_stat_monitor_enable": { + "description": "Enable the pg_stat_monitor extension. Enabling this extension will cause the cluster to be restarted.When this extension is enabled, pg_stat_statements results for utility commands are unreliable", + "type": "boolean" + }, + "pg_version": { + "description": "PostgreSQL major version", + "enum": [ + "12", + "13", + "14", + "15", + "16" + ], + "type": "string" + }, + "pgaudit": { + "description": "Deprecated. System-wide settings for the pgaudit extension", + "properties": { + "feature_enabled": { + "description": "Deprecated. Enable pgaudit extension. When enabled, pgaudit extension will be automatically installed.Otherwise, extension will be uninstalled but auditing configurations will be preserved.", + "type": "boolean" + }, + "log": { + "description": "Deprecated. Specifies which classes of statements will be logged by session audit logging.", + "items": { + "type": "string" + }, + "type": "array" + }, + "log_catalog": { + "description": "Deprecated. Specifies that session logging should be enabled in the casewhere all relations in a statement are in pg_catalog.", + "type": "boolean" + }, + "log_client": { + "description": "Deprecated. Specifies whether log messages will be visible to a client process such as psql.", + "type": "boolean" + }, + "log_level": { + "description": "Deprecated. Specifies the log level that will be used for log entries.", + "type": "string" + }, + "log_max_string_length": { + "description": "Deprecated. Crop parameters representation and whole statements if they exceed this threshold. A (default) value of -1 disable the truncation.", + "maximum": 102400, + "minimum": -1, + "type": "integer" + }, + "log_nested_statements": { + "description": "Deprecated. This GUC allows to turn off logging nested statements, that is, statements that are executed as part of another ExecutorRun.", + "type": "boolean" + }, + "log_parameter": { + "description": "Deprecated. Specifies that audit logging should include the parameters that were passed with the statement.", + "type": "boolean" + }, + "log_parameter_max_size": { + "description": "Deprecated. Specifies that parameter values longer than this setting (in bytes) should not be logged, but replaced with .", + "type": "integer" + }, + "log_relation": { + "description": "Deprecated. Specifies whether session audit logging should create a separate log entry for each relation (TABLE, VIEW, etc.) referenced in a SELECT or DML statement.", + "type": "boolean" + }, + "log_rows": { + "description": "Deprecated. Specifies that audit logging should include the rows retrieved or affected by a statement. When enabled the rows field will be included after the parameter field.", + "type": "boolean" + }, + "log_statement": { + "description": "Deprecated. Specifies whether logging will include the statement text and parameters (if enabled).", + "type": "boolean" + }, + "log_statement_once": { + "description": "Deprecated. Specifies whether logging will include the statement text and parameters with the first log entry for a statement/substatement combination or with every entry.", + "type": "boolean" + }, + "role": { + "description": "Deprecated. Specifies the master role to use for object audit logging.", + "maxLength": 64, + "pattern": "^[_A-Za-z0-9][-._A-Za-z0-9]{0,63}$", + "type": "string" + } + }, + "type": "object", + "additionalProperties": false + }, + "pgbouncer": { + "description": "PGBouncer connection pooling settings", + "properties": { + "autodb_idle_timeout": { + "description": "If the automatically created database pools have been unused this many seconds, they are freed. If 0 then timeout is disabled. [seconds]", + "maximum": 86400, + "minimum": 0, + "type": "integer" + }, + "autodb_max_db_connections": { + "description": "Do not allow more than this many server connections per database (regardless of user). Setting it to 0 means unlimited.", + "maximum": 2147483647, + "minimum": 0, + "type": "integer" + }, + "autodb_pool_mode": { + "description": "PGBouncer pool mode", + "enum": [ + "session", + "transaction", + "statement" + ], + "type": "string" + }, + "autodb_pool_size": { + "description": "If non-zero then create automatically a pool of that size per user when a pool doesn't exist.", + "maximum": 10000, + "minimum": 0, + "type": "integer" + }, + "ignore_startup_parameters": { + "description": "List of parameters to ignore when given in startup packet", + "items": { + "type": "string" + }, + "maxItems": 32, + "type": "array" + }, + "min_pool_size": { + "description": "Add more server connections to pool if below this number. Improves behavior when usual load comes suddenly back after period of total inactivity. The value is effectively capped at the pool size.", + "maximum": 10000, + "minimum": 0, + "type": "integer" + }, + "server_idle_timeout": { + "description": "If a server connection has been idle more than this many seconds it will be dropped. If 0 then timeout is disabled. [seconds]", + "maximum": 86400, + "minimum": 0, + "type": "integer" + }, + "server_lifetime": { + "description": "The pooler will close an unused server connection that has been connected longer than this. [seconds]", + "maximum": 86400, + "minimum": 60, + "type": "integer" + }, + "server_reset_query_always": { + "description": "Run server_reset_query (DISCARD ALL) in all pooling modes", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "pglookout": { + "description": "System-wide settings for pglookout.", + "properties": { + "max_failover_replication_time_lag": { + "description": "Number of seconds of master unavailability before triggering database failover to standby", + "minimum": 10, + "type": "integer" + } + }, + "type": "object", + "additionalProperties": false + }, + "private_access": { + "description": "Allow access to selected service ports from private networks", + "properties": { + "pg": { + "description": "Allow clients to connect to pg with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations", + "type": "boolean" + }, + "pgbouncer": { + "description": "Allow clients to connect to pgbouncer with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations", + "type": "boolean" + }, + "prometheus": { + "description": "Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "privatelink_access": { + "description": "Allow access to selected service components through Privatelink", + "properties": { + "pg": { + "description": "Enable pg", + "type": "boolean" + }, + "pgbouncer": { + "description": "Enable pgbouncer", + "type": "boolean" + }, + "prometheus": { + "description": "Enable prometheus", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "project_to_fork_from": { + "description": "Name of another project to fork a service from. This has effect only when a new service is being created.", + "maxLength": 63, + "pattern": "^[a-z][-a-z0-9]{0,63}$|^$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "public_access": { + "description": "Allow access to selected service ports from the public Internet", + "properties": { + "pg": { + "description": "Allow clients to connect to pg from the public internet for service nodes that are in a project VPC or another type of private network", + "type": "boolean" + }, + "pgbouncer": { + "description": "Allow clients to connect to pgbouncer from the public internet for service nodes that are in a project VPC or another type of private network", + "type": "boolean" + }, + "prometheus": { + "description": "Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "recovery_target_time": { + "description": "Recovery target time when forking a service. This has effect only when a new service is being created.", + "maxLength": 32, + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "service_log": { + "description": "Store logs for the service so that they are available in the HTTP API and console.", + "type": "boolean" + }, + "service_to_fork_from": { + "description": "Name of another service to fork from. This has effect only when a new service is being created.", + "maxLength": 64, + "pattern": "^[a-z][-a-z0-9]{0,63}$|^$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "shared_buffers_percentage": { + "description": "Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value.", + "maximum": 60, + "minimum": 20, + "type": "number" + }, + "static_ips": { + "description": "Use static public IP addresses", + "type": "boolean" + }, + "synchronous_replication": { + "description": "Synchronous replication type. Note that the service plan also needs to support synchronous replication.", + "enum": [ + "quorum", + "off" + ], + "type": "string" + }, + "timescaledb": { + "description": "System-wide settings for the timescaledb extension", + "properties": { + "max_background_workers": { + "description": "The number of background workers for timescaledb operations. You should configure this setting to the sum of your number of databases and the total number of concurrent background workers you want running at any given point in time.", + "maximum": 4096, + "minimum": 1, + "type": "integer" + } + }, + "type": "object", + "additionalProperties": false + }, + "variant": { + "description": "Variant of the PostgreSQL service, may affect the features that are exposed by default", + "enum": [ + "aiven", + "timescale" + ], + "type": "string" + }, + "work_mem": { + "description": "Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. Default is 1MB + 0.075% of total RAM (up to 32MB).", + "maximum": 1024, + "minimum": 1, + "type": "integer" + } + }, + "type": "object", + "additionalProperties": false + } + }, + "required": [ + "plan", + "project" + ], + "type": "object", + "x-kubernetes-validations": [ + { + "message": "connInfoSecretTargetDisabled can only be set during resource creation.", + "rule": "has(oldSelf.connInfoSecretTargetDisabled) == has(self.connInfoSecretTargetDisabled)" + } + ], + "additionalProperties": false + }, + "status": { + "description": "ServiceStatus defines the observed state of service", + "properties": { + "conditions": { + "description": "Conditions represent the latest available observations of a service state", + "items": { + "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}", + "properties": { + "lastTransitionTime": { + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis 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", + "type": "string" + }, + "message": { + "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", + "maxLength": 32768, + "type": "string" + }, + "observedGeneration": { + "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "reason": { + "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", + "type": "string" + }, + "status": { + "description": "status of the condition, one of True, False, Unknown.", + "enum": [ + "True", + "False", + "Unknown" + ], + "type": "string" + }, + "type": { + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", + "type": "string" + } + }, + "required": [ + "lastTransitionTime", + "message", + "reason", + "status", + "type" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + }, + "state": { + "description": "Service state", + "type": "string" + } + }, + "type": "object", + "additionalProperties": false + } + }, + "type": "object" +} diff --git a/aiven.io/project_v1alpha1.json b/aiven.io/project_v1alpha1.json new file mode 100644 index 00000000..71273f40 --- /dev/null +++ b/aiven.io/project_v1alpha1.json @@ -0,0 +1,278 @@ +{ + "description": "Project is the Schema for the projects API.\nInfo \"Exposes secret keys\": `PROJECT_CA_CERT`", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "type": "object" + }, + "spec": { + "description": "ProjectSpec defines the desired state of Project", + "properties": { + "accountId": { + "description": "Account ID", + "maxLength": 32, + "type": "string" + }, + "authSecretRef": { + "description": "Authentication reference to Aiven token in a secret", + "properties": { + "key": { + "minLength": 1, + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key", + "name" + ], + "type": "object", + "additionalProperties": false + }, + "billingAddress": { + "description": "Billing name and address of the project", + "maxLength": 1000, + "type": "string" + }, + "billingCurrency": { + "description": "Billing currency", + "enum": [ + "AUD", + "CAD", + "CHF", + "DKK", + "EUR", + "GBP", + "NOK", + "SEK", + "USD" + ], + "type": "string" + }, + "billingEmails": { + "description": "Billing contact emails of the project", + "items": { + "type": "string" + }, + "maxItems": 10, + "type": "array" + }, + "billingExtraText": { + "description": "Extra text to be included in all project invoices, e.g. purchase order or cost center number", + "maxLength": 1000, + "type": "string" + }, + "billingGroupId": { + "description": "BillingGroup ID", + "maxLength": 36, + "minLength": 36, + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "cardId": { + "description": "Credit card ID; The ID may be either last 4 digits of the card or the actual ID", + "maxLength": 64, + "type": "string" + }, + "cloud": { + "description": "Target cloud, example: aws-eu-central-1", + "maxLength": 256, + "type": "string" + }, + "connInfoSecretTarget": { + "description": "Secret configuration.", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Annotations added to the secret", + "type": "object", + "x-kubernetes-preserve-unknown-fields": true + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels added to the secret", + "type": "object", + "x-kubernetes-preserve-unknown-fields": true + }, + "name": { + "description": "Name of the secret resource to be created. By default, it is equal to the resource name", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "prefix": { + "description": "Prefix for the secret's keys.\nAdded \"as is\" without any transformations.\nBy default, is equal to the kind name in uppercase + underscore, e.g. `KAFKA_`, `REDIS_`, etc.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "additionalProperties": false + }, + "connInfoSecretTargetDisabled": { + "description": "When true, the secret containing connection information will not be created, defaults to false. This field cannot be changed after resource creation.", + "type": "boolean", + "x-kubernetes-validations": [ + { + "message": "connInfoSecretTargetDisabled is immutable.", + "rule": "self == oldSelf" + } + ] + }, + "copyFromProject": { + "description": "Project name from which to copy settings to the new project", + "maxLength": 63, + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "countryCode": { + "description": "Billing country code of the project", + "maxLength": 2, + "minLength": 2, + "type": "string" + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Tags are key-value pairs that allow you to categorize projects", + "type": "object" + }, + "technicalEmails": { + "description": "Technical contact emails of the project", + "items": { + "type": "string" + }, + "maxItems": 10, + "type": "array" + } + }, + "type": "object", + "x-kubernetes-validations": [ + { + "message": "connInfoSecretTargetDisabled can only be set during resource creation.", + "rule": "has(oldSelf.connInfoSecretTargetDisabled) == has(self.connInfoSecretTargetDisabled)" + } + ], + "additionalProperties": false + }, + "status": { + "description": "ProjectStatus defines the observed state of Project", + "properties": { + "availableCredits": { + "description": "Available credirs", + "type": "string" + }, + "conditions": { + "description": "Conditions represent the latest available observations of an Project state", + "items": { + "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}", + "properties": { + "lastTransitionTime": { + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis 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", + "type": "string" + }, + "message": { + "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", + "maxLength": 32768, + "type": "string" + }, + "observedGeneration": { + "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "reason": { + "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", + "type": "string" + }, + "status": { + "description": "status of the condition, one of True, False, Unknown.", + "enum": [ + "True", + "False", + "Unknown" + ], + "type": "string" + }, + "type": { + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", + "type": "string" + } + }, + "required": [ + "lastTransitionTime", + "message", + "reason", + "status", + "type" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + }, + "country": { + "description": "Country name", + "type": "string" + }, + "estimatedBalance": { + "description": "Estimated balance", + "type": "string" + }, + "paymentMethod": { + "description": "Payment method name", + "type": "string" + }, + "vatId": { + "description": "EU VAT Identification Number", + "maxLength": 64, + "type": "string" + } + }, + "required": [ + "conditions" + ], + "type": "object", + "additionalProperties": false + } + }, + "type": "object" +} diff --git a/aiven.io/projectvpc_v1alpha1.json b/aiven.io/projectvpc_v1alpha1.json new file mode 100644 index 00000000..07638fe6 --- /dev/null +++ b/aiven.io/projectvpc_v1alpha1.json @@ -0,0 +1,158 @@ +{ + "description": "ProjectVPC is the Schema for the projectvpcs API", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "type": "object" + }, + "spec": { + "description": "ProjectVPCSpec defines the desired state of ProjectVPC", + "properties": { + "authSecretRef": { + "description": "Authentication reference to Aiven token in a secret", + "properties": { + "key": { + "minLength": 1, + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key", + "name" + ], + "type": "object", + "additionalProperties": false + }, + "cloudName": { + "description": "Cloud the VPC is in", + "maxLength": 256, + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "networkCidr": { + "description": "Network address range used by the VPC like 192.168.0.0/24", + "maxLength": 36, + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "project": { + "description": "Identifies the project this resource belongs to", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + } + }, + "required": [ + "cloudName", + "networkCidr", + "project" + ], + "type": "object", + "additionalProperties": false + }, + "status": { + "description": "ProjectVPCStatus defines the observed state of ProjectVPC", + "properties": { + "conditions": { + "description": "Conditions represent the latest available observations of an ProjectVPC state", + "items": { + "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}", + "properties": { + "lastTransitionTime": { + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis 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", + "type": "string" + }, + "message": { + "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", + "maxLength": 32768, + "type": "string" + }, + "observedGeneration": { + "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "reason": { + "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", + "type": "string" + }, + "status": { + "description": "status of the condition, one of True, False, Unknown.", + "enum": [ + "True", + "False", + "Unknown" + ], + "type": "string" + }, + "type": { + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", + "type": "string" + } + }, + "required": [ + "lastTransitionTime", + "message", + "reason", + "status", + "type" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + }, + "id": { + "description": "Project VPC id", + "type": "string" + }, + "state": { + "description": "State of VPC", + "type": "string" + } + }, + "required": [ + "conditions", + "id", + "state" + ], + "type": "object", + "additionalProperties": false + } + }, + "type": "object" +} diff --git a/aiven.io/redis_v1alpha1.json b/aiven.io/redis_v1alpha1.json new file mode 100644 index 00000000..91f7b862 --- /dev/null +++ b/aiven.io/redis_v1alpha1.json @@ -0,0 +1,561 @@ +{ + "description": "Redis is the Schema for the redis API.\nInfo \"Exposes secret keys\": `REDIS_HOST`, `REDIS_PORT`, `REDIS_USER`, `REDIS_PASSWORD`", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "type": "object" + }, + "spec": { + "description": "RedisSpec defines the desired state of Redis", + "properties": { + "authSecretRef": { + "description": "Authentication reference to Aiven token in a secret", + "properties": { + "key": { + "minLength": 1, + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key", + "name" + ], + "type": "object", + "additionalProperties": false + }, + "cloudName": { + "description": "Cloud the service runs in.", + "maxLength": 256, + "type": "string" + }, + "connInfoSecretTarget": { + "description": "Secret configuration.", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Annotations added to the secret", + "type": "object", + "x-kubernetes-preserve-unknown-fields": true + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels added to the secret", + "type": "object", + "x-kubernetes-preserve-unknown-fields": true + }, + "name": { + "description": "Name of the secret resource to be created. By default, it is equal to the resource name", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "prefix": { + "description": "Prefix for the secret's keys.\nAdded \"as is\" without any transformations.\nBy default, is equal to the kind name in uppercase + underscore, e.g. `KAFKA_`, `REDIS_`, etc.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "additionalProperties": false + }, + "connInfoSecretTargetDisabled": { + "description": "When true, the secret containing connection information will not be created, defaults to false. This field cannot be changed after resource creation.", + "type": "boolean", + "x-kubernetes-validations": [ + { + "message": "connInfoSecretTargetDisabled is immutable.", + "rule": "self == oldSelf" + } + ] + }, + "disk_space": { + "description": "The disk space of the service, possible values depend on the service type, the cloud provider and the project.\nReducing will result in the service re-balancing.\nThe removal of this field does not change the value.", + "pattern": "(?i)^[1-9][0-9]*(GiB|G)?$", + "type": "string" + }, + "maintenanceWindowDow": { + "description": "Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.", + "enum": [ + "monday", + "tuesday", + "wednesday", + "thursday", + "friday", + "saturday", + "sunday" + ], + "type": "string" + }, + "maintenanceWindowTime": { + "description": "Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.", + "maxLength": 8, + "type": "string" + }, + "plan": { + "description": "Subscription plan.", + "maxLength": 128, + "type": "string" + }, + "project": { + "description": "Identifies the project this resource belongs to", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "projectVPCRef": { + "description": "ProjectVPCRef reference to ProjectVPC resource to use its ID as ProjectVPCID automatically", + "properties": { + "name": { + "minLength": 1, + "type": "string" + }, + "namespace": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "additionalProperties": false + }, + "projectVpcId": { + "description": "Identifier of the VPC the service should be in, if any.", + "maxLength": 36, + "type": "string" + }, + "serviceIntegrations": { + "description": "Service integrations to specify when creating a service. Not applied after initial service creation", + "items": { + "description": "Service integrations to specify when creating a service. Not applied after initial service creation", + "properties": { + "integrationType": { + "enum": [ + "read_replica" + ], + "type": "string" + }, + "sourceServiceName": { + "maxLength": 64, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "integrationType", + "sourceServiceName" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 1, + "type": "array", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Tags are key-value pairs that allow you to categorize services.", + "type": "object" + }, + "technicalEmails": { + "description": "Defines the email addresses that will receive alerts about upcoming maintenance updates or warnings about service instability.", + "items": { + "properties": { + "email": { + "description": "Email address.", + "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", + "type": "string" + } + }, + "required": [ + "email" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 10, + "type": "array" + }, + "terminationProtection": { + "description": "Prevent service from being deleted. It is recommended to have this enabled for all services.", + "type": "boolean" + }, + "userConfig": { + "description": "Redis specific user configuration options", + "properties": { + "additional_backup_regions": { + "description": "Additional Cloud Regions for Backup Replication", + "items": { + "type": "string" + }, + "maxItems": 1, + "type": "array" + }, + "ip_filter": { + "description": "Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'", + "items": { + "description": "CIDR address block, either as a string, or in a dict with an optional description field", + "properties": { + "description": { + "description": "Description for IP filter list entry", + "maxLength": 1024, + "type": "string" + }, + "network": { + "description": "CIDR address block", + "maxLength": 43, + "type": "string" + } + }, + "required": [ + "network" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 1024, + "type": "array" + }, + "migration": { + "description": "Migrate data from existing server", + "properties": { + "dbname": { + "description": "Database name for bootstrapping the initial connection", + "maxLength": 63, + "type": "string" + }, + "host": { + "description": "Hostname or IP address of the server where to migrate data from", + "maxLength": 255, + "type": "string" + }, + "ignore_dbs": { + "description": "Comma-separated list of databases, which should be ignored during migration (supported by MySQL and PostgreSQL only at the moment)", + "maxLength": 2048, + "type": "string" + }, + "method": { + "description": "The migration method to be used (currently supported only by Redis, Dragonfly, MySQL and PostgreSQL service types)", + "enum": [ + "dump", + "replication" + ], + "type": "string" + }, + "password": { + "description": "Password for authentication with the server where to migrate data from", + "maxLength": 256, + "type": "string" + }, + "port": { + "description": "Port number of the server where to migrate data from", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "ssl": { + "description": "The server where to migrate data from is secured with SSL", + "type": "boolean" + }, + "username": { + "description": "User name for authentication with the server where to migrate data from", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "host", + "port" + ], + "type": "object", + "additionalProperties": false + }, + "private_access": { + "description": "Allow access to selected service ports from private networks", + "properties": { + "prometheus": { + "description": "Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations", + "type": "boolean" + }, + "redis": { + "description": "Allow clients to connect to redis with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "privatelink_access": { + "description": "Allow access to selected service components through Privatelink", + "properties": { + "prometheus": { + "description": "Enable prometheus", + "type": "boolean" + }, + "redis": { + "description": "Enable redis", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "project_to_fork_from": { + "description": "Name of another project to fork a service from. This has effect only when a new service is being created.", + "maxLength": 63, + "pattern": "^[a-z][-a-z0-9]{0,63}$|^$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "public_access": { + "description": "Allow access to selected service ports from the public Internet", + "properties": { + "prometheus": { + "description": "Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network", + "type": "boolean" + }, + "redis": { + "description": "Allow clients to connect to redis from the public internet for service nodes that are in a project VPC or another type of private network", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "recovery_basebackup_name": { + "description": "Name of the basebackup to restore in forked service", + "maxLength": 128, + "pattern": "^[a-zA-Z0-9-_:.]+$", + "type": "string" + }, + "redis_acl_channels_default": { + "description": "Determines default pub/sub channels' ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn't affect Redis configuration acl-pubsub-default.", + "enum": [ + "allchannels", + "resetchannels" + ], + "type": "string" + }, + "redis_io_threads": { + "description": "Set Redis IO thread count. Changing this will cause a restart of the Redis service.", + "maximum": 32, + "minimum": 1, + "type": "integer" + }, + "redis_lfu_decay_time": { + "description": "LFU maxmemory-policy counter decay time in minutes", + "maximum": 120, + "minimum": 1, + "type": "integer" + }, + "redis_lfu_log_factor": { + "description": "Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies", + "maximum": 100, + "minimum": 0, + "type": "integer" + }, + "redis_maxmemory_policy": { + "description": "Redis maxmemory-policy", + "enum": [ + "noeviction", + "allkeys-lru", + "volatile-lru", + "allkeys-random", + "volatile-random", + "volatile-ttl", + "volatile-lfu", + "allkeys-lfu" + ], + "type": "string" + }, + "redis_notify_keyspace_events": { + "description": "Set notify-keyspace-events option", + "maxLength": 32, + "pattern": "^[KEg\\$lshzxentdmA]*$", + "type": "string" + }, + "redis_number_of_databases": { + "description": "Set number of Redis databases. Changing this will cause a restart of the Redis service.", + "maximum": 128, + "minimum": 1, + "type": "integer" + }, + "redis_persistence": { + "description": "When persistence is 'rdb', Redis does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to the backup schedule for backup purposes. When persistence is 'off', no RDB dumps or backups are done, so data can be lost at any moment if the service is restarted for any reason, or if the service is powered off. Also, the service can't be forked.", + "enum": [ + "off", + "rdb" + ], + "type": "string" + }, + "redis_pubsub_client_output_buffer_limit": { + "description": "Set output buffer limit for pub / sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan.", + "maximum": 512, + "minimum": 32, + "type": "integer" + }, + "redis_ssl": { + "description": "Require SSL to access Redis", + "type": "boolean" + }, + "redis_timeout": { + "description": "Redis idle connection timeout in seconds", + "maximum": 31536000, + "minimum": 0, + "type": "integer" + }, + "redis_version": { + "description": "Redis major version", + "enum": [ + "7.0" + ], + "type": "string" + }, + "service_log": { + "description": "Store logs for the service so that they are available in the HTTP API and console.", + "type": "boolean" + }, + "service_to_fork_from": { + "description": "Name of another service to fork from. This has effect only when a new service is being created.", + "maxLength": 64, + "pattern": "^[a-z][-a-z0-9]{0,63}$|^$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "static_ips": { + "description": "Use static public IP addresses", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + } + }, + "required": [ + "plan", + "project" + ], + "type": "object", + "x-kubernetes-validations": [ + { + "message": "connInfoSecretTargetDisabled can only be set during resource creation.", + "rule": "has(oldSelf.connInfoSecretTargetDisabled) == has(self.connInfoSecretTargetDisabled)" + } + ], + "additionalProperties": false + }, + "status": { + "description": "ServiceStatus defines the observed state of service", + "properties": { + "conditions": { + "description": "Conditions represent the latest available observations of a service state", + "items": { + "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}", + "properties": { + "lastTransitionTime": { + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis 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", + "type": "string" + }, + "message": { + "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", + "maxLength": 32768, + "type": "string" + }, + "observedGeneration": { + "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "reason": { + "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", + "type": "string" + }, + "status": { + "description": "status of the condition, one of True, False, Unknown.", + "enum": [ + "True", + "False", + "Unknown" + ], + "type": "string" + }, + "type": { + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", + "type": "string" + } + }, + "required": [ + "lastTransitionTime", + "message", + "reason", + "status", + "type" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + }, + "state": { + "description": "Service state", + "type": "string" + } + }, + "type": "object", + "additionalProperties": false + } + }, + "type": "object" +} diff --git a/aiven.io/serviceintegration_v1alpha1.json b/aiven.io/serviceintegration_v1alpha1.json new file mode 100644 index 00000000..be3b3b37 --- /dev/null +++ b/aiven.io/serviceintegration_v1alpha1.json @@ -0,0 +1,896 @@ +{ + "description": "ServiceIntegration is the Schema for the serviceintegrations API", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "type": "object" + }, + "spec": { + "description": "ServiceIntegrationSpec defines the desired state of ServiceIntegration", + "properties": { + "authSecretRef": { + "description": "Authentication reference to Aiven token in a secret", + "properties": { + "key": { + "minLength": 1, + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key", + "name" + ], + "type": "object", + "additionalProperties": false + }, + "clickhouseKafka": { + "description": "Clickhouse Kafka configuration values", + "properties": { + "tables": { + "description": "Tables to create", + "items": { + "description": "Table to create", + "properties": { + "auto_offset_reset": { + "description": "Action to take when there is no initial offset in offset store or the desired offset is out of range", + "enum": [ + "smallest", + "earliest", + "beginning", + "largest", + "latest", + "end" + ], + "type": "string" + }, + "columns": { + "description": "Table columns", + "items": { + "description": "Table column", + "properties": { + "name": { + "description": "Column name", + "maxLength": 40, + "minLength": 1, + "type": "string" + }, + "type": { + "description": "Column type", + "maxLength": 1000, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name", + "type" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 100, + "type": "array" + }, + "data_format": { + "description": "Message data format", + "enum": [ + "Avro", + "CSV", + "JSONAsString", + "JSONCompactEachRow", + "JSONCompactStringsEachRow", + "JSONEachRow", + "JSONStringsEachRow", + "MsgPack", + "TSKV", + "TSV", + "TabSeparated", + "RawBLOB", + "AvroConfluent", + "Parquet" + ], + "type": "string" + }, + "date_time_input_format": { + "description": "Method to read DateTime from text input formats", + "enum": [ + "basic", + "best_effort", + "best_effort_us" + ], + "type": "string" + }, + "group_name": { + "description": "Kafka consumers group", + "maxLength": 249, + "minLength": 1, + "type": "string" + }, + "handle_error_mode": { + "description": "How to handle errors for Kafka engine", + "enum": [ + "default", + "stream" + ], + "type": "string" + }, + "max_block_size": { + "description": "Number of row collected by poll(s) for flushing data from Kafka", + "maximum": 1000000000, + "minimum": 0, + "type": "integer" + }, + "max_rows_per_message": { + "description": "The maximum number of rows produced in one kafka message for row-based formats", + "maximum": 1000000000, + "minimum": 1, + "type": "integer" + }, + "name": { + "description": "Name of the table", + "maxLength": 40, + "minLength": 1, + "type": "string" + }, + "num_consumers": { + "description": "The number of consumers per table per replica", + "maximum": 10, + "minimum": 1, + "type": "integer" + }, + "poll_max_batch_size": { + "description": "Maximum amount of messages to be polled in a single Kafka poll", + "maximum": 1000000000, + "minimum": 0, + "type": "integer" + }, + "skip_broken_messages": { + "description": "Skip at least this number of broken messages from Kafka topic per block", + "maximum": 1000000000, + "minimum": 0, + "type": "integer" + }, + "topics": { + "description": "Kafka topics", + "items": { + "description": "Kafka topic", + "properties": { + "name": { + "description": "Name of the topic", + "maxLength": 249, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 100, + "type": "array" + } + }, + "required": [ + "columns", + "data_format", + "group_name", + "name", + "topics" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 100, + "type": "array" + } + }, + "type": "object", + "additionalProperties": false + }, + "clickhousePostgresql": { + "description": "Clickhouse PostgreSQL configuration values", + "properties": { + "databases": { + "description": "Databases to expose", + "items": { + "description": "Database to expose", + "properties": { + "database": { + "description": "PostgreSQL database to expose", + "maxLength": 63, + "minLength": 1, + "type": "string" + }, + "schema": { + "description": "PostgreSQL schema to expose", + "maxLength": 63, + "minLength": 1, + "type": "string" + } + }, + "type": "object", + "additionalProperties": false + }, + "maxItems": 10, + "type": "array" + } + }, + "type": "object", + "additionalProperties": false + }, + "datadog": { + "description": "Datadog specific user configuration options", + "properties": { + "datadog_dbm_enabled": { + "description": "Enable Datadog Database Monitoring", + "type": "boolean" + }, + "datadog_pgbouncer_enabled": { + "description": "Enable Datadog PgBouncer Metric Tracking", + "type": "boolean" + }, + "datadog_tags": { + "description": "Custom tags provided by user", + "items": { + "description": "Datadog tag defined by user", + "properties": { + "comment": { + "description": "Optional tag explanation", + "maxLength": 1024, + "type": "string" + }, + "tag": { + "description": "Tag format and usage are described here: https://docs.datadoghq.com/getting_started/tagging. Tags with prefix 'aiven-' are reserved for Aiven.", + "maxLength": 200, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "tag" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 32, + "type": "array" + }, + "exclude_consumer_groups": { + "description": "List of custom metrics", + "items": { + "type": "string" + }, + "maxItems": 1024, + "type": "array" + }, + "exclude_topics": { + "description": "List of topics to exclude", + "items": { + "type": "string" + }, + "maxItems": 1024, + "type": "array" + }, + "include_consumer_groups": { + "description": "List of custom metrics", + "items": { + "type": "string" + }, + "maxItems": 1024, + "type": "array" + }, + "include_topics": { + "description": "List of topics to include", + "items": { + "type": "string" + }, + "maxItems": 1024, + "type": "array" + }, + "kafka_custom_metrics": { + "description": "List of custom metrics", + "items": { + "type": "string" + }, + "maxItems": 1024, + "type": "array" + }, + "max_jmx_metrics": { + "description": "Maximum number of JMX metrics to send", + "maximum": 100000, + "minimum": 10, + "type": "integer" + }, + "mirrormaker_custom_metrics": { + "description": "List of custom metrics", + "items": { + "type": "string" + }, + "maxItems": 1024, + "type": "array" + }, + "opensearch": { + "description": "Datadog Opensearch Options", + "properties": { + "cluster_stats_enabled": { + "description": "Enable Datadog Opensearch Cluster Monitoring", + "type": "boolean" + }, + "index_stats_enabled": { + "description": "Enable Datadog Opensearch Index Monitoring", + "type": "boolean" + }, + "pending_task_stats_enabled": { + "description": "Enable Datadog Opensearch Pending Task Monitoring", + "type": "boolean" + }, + "pshard_stats_enabled": { + "description": "Enable Datadog Opensearch Primary Shard Monitoring", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + }, + "redis": { + "description": "Datadog Redis Options", + "properties": { + "command_stats_enabled": { + "description": "Enable command_stats option in the agent's configuration", + "type": "boolean" + } + }, + "type": "object", + "additionalProperties": false + } + }, + "type": "object", + "additionalProperties": false + }, + "destinationEndpointId": { + "description": "Destination endpoint for the integration (if any)", + "maxLength": 36, + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "destinationProjectName": { + "description": "Destination project for the integration (if any)", + "maxLength": 63, + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "destinationServiceName": { + "description": "Destination service for the integration (if any)", + "maxLength": 64, + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "externalAWSCloudwatchMetrics": { + "description": "External AWS CloudWatch Metrics integration Logs configuration values", + "properties": { + "dropped_metrics": { + "description": "Metrics to not send to AWS CloudWatch (takes precedence over extra_metrics)", + "items": { + "description": "Metric name and subfield", + "properties": { + "field": { + "description": "Identifier of a value in the metric", + "maxLength": 1000, + "type": "string" + }, + "metric": { + "description": "Identifier of the metric", + "maxLength": 1000, + "type": "string" + } + }, + "required": [ + "field", + "metric" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 1024, + "type": "array" + }, + "extra_metrics": { + "description": "Metrics to allow through to AWS CloudWatch (in addition to default metrics)", + "items": { + "description": "Metric name and subfield", + "properties": { + "field": { + "description": "Identifier of a value in the metric", + "maxLength": 1000, + "type": "string" + }, + "metric": { + "description": "Identifier of the metric", + "maxLength": 1000, + "type": "string" + } + }, + "required": [ + "field", + "metric" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 1024, + "type": "array" + } + }, + "type": "object", + "additionalProperties": false + }, + "integrationType": { + "description": "Type of the service integration accepted by Aiven API. Some values may not be supported by the operator", + "enum": [ + "alertmanager", + "autoscaler", + "caching", + "cassandra_cross_service_cluster", + "clickhouse_kafka", + "clickhouse_postgresql", + "dashboard", + "datadog", + "datasource", + "external_aws_cloudwatch_logs", + "external_aws_cloudwatch_metrics", + "external_elasticsearch_logs", + "external_google_cloud_logging", + "external_opensearch_logs", + "flink", + "flink_external_kafka", + "flink_external_postgresql", + "internal_connectivity", + "jolokia", + "kafka_connect", + "kafka_logs", + "kafka_mirrormaker", + "logs", + "m3aggregator", + "m3coordinator", + "metrics", + "opensearch_cross_cluster_replication", + "opensearch_cross_cluster_search", + "prometheus", + "read_replica", + "rsyslog", + "schema_registry_proxy", + "stresstester", + "thanosquery", + "thanosstore", + "vmalert" + ], + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "kafkaConnect": { + "description": "Kafka Connect service configuration values", + "properties": { + "kafka_connect": { + "description": "Kafka Connect service configuration values", + "properties": { + "config_storage_topic": { + "description": "The name of the topic where connector and task configuration data are stored.This must be the same for all workers with the same group_id.", + "maxLength": 249, + "type": "string" + }, + "group_id": { + "description": "A unique string that identifies the Connect cluster group this worker belongs to.", + "maxLength": 249, + "type": "string" + }, + "offset_storage_topic": { + "description": "The name of the topic where connector and task configuration offsets are stored.This must be the same for all workers with the same group_id.", + "maxLength": 249, + "type": "string" + }, + "status_storage_topic": { + "description": "The name of the topic where connector and task configuration status updates are stored.This must be the same for all workers with the same group_id.", + "maxLength": 249, + "type": "string" + } + }, + "type": "object", + "additionalProperties": false + } + }, + "type": "object", + "additionalProperties": false + }, + "kafkaLogs": { + "description": "Kafka logs configuration values", + "properties": { + "kafka_topic": { + "description": "Topic name", + "maxLength": 249, + "minLength": 1, + "type": "string" + }, + "selected_log_fields": { + "description": "The list of logging fields that will be sent to the integration logging service. The MESSAGE and timestamp fields are always sent.", + "items": { + "type": "string" + }, + "maxItems": 5, + "type": "array" + } + }, + "required": [ + "kafka_topic" + ], + "type": "object", + "additionalProperties": false + }, + "kafkaMirrormaker": { + "description": "Kafka MirrorMaker configuration values", + "properties": { + "cluster_alias": { + "description": "The alias under which the Kafka cluster is known to MirrorMaker. Can contain the following symbols: ASCII alphanumerics, '.', '_', and '-'.", + "maxLength": 128, + "pattern": "^[a-zA-Z0-9_.-]+$", + "type": "string" + }, + "kafka_mirrormaker": { + "description": "Kafka MirrorMaker configuration values", + "properties": { + "consumer_auto_offset_reset": { + "description": "Set where consumer starts to consume data. Value `earliest`: Start replication from the earliest offset. Value `latest`: Start replication from the latest offset. Default is `earliest`.", + "enum": [ + "earliest", + "latest" + ], + "type": "string" + }, + "consumer_fetch_min_bytes": { + "description": "The minimum amount of data the server should return for a fetch request", + "maximum": 5242880, + "minimum": 1, + "type": "integer" + }, + "consumer_max_poll_records": { + "description": "Set consumer max.poll.records. The default is 500.", + "maximum": 20000, + "minimum": 100, + "type": "integer" + }, + "producer_batch_size": { + "description": "The batch size in bytes producer will attempt to collect before publishing to broker.", + "maximum": 5242880, + "minimum": 0, + "type": "integer" + }, + "producer_buffer_memory": { + "description": "The amount of bytes producer can use for buffering data before publishing to broker.", + "maximum": 134217728, + "minimum": 5242880, + "type": "integer" + }, + "producer_compression_type": { + "description": "Specify the default compression type for producers. This configuration accepts the standard compression codecs ('gzip', 'snappy', 'lz4', 'zstd'). It additionally accepts 'none' which is the default and equivalent to no compression.", + "enum": [ + "gzip", + "snappy", + "lz4", + "zstd", + "none" + ], + "type": "string" + }, + "producer_linger_ms": { + "description": "The linger time (ms) for waiting new data to arrive for publishing.", + "maximum": 5000, + "minimum": 0, + "type": "integer" + }, + "producer_max_request_size": { + "description": "The maximum request size in bytes.", + "maximum": 268435456, + "minimum": 0, + "type": "integer" + } + }, + "type": "object", + "additionalProperties": false + } + }, + "type": "object", + "additionalProperties": false + }, + "logs": { + "description": "Logs configuration values", + "properties": { + "elasticsearch_index_days_max": { + "description": "Elasticsearch index retention limit", + "maximum": 10000, + "minimum": 1, + "type": "integer" + }, + "elasticsearch_index_prefix": { + "description": "Elasticsearch index prefix", + "maxLength": 1024, + "minLength": 1, + "type": "string" + }, + "selected_log_fields": { + "description": "The list of logging fields that will be sent to the integration logging service. The MESSAGE and timestamp fields are always sent.", + "items": { + "type": "string" + }, + "maxItems": 5, + "type": "array" + } + }, + "type": "object", + "additionalProperties": false + }, + "metrics": { + "description": "Metrics configuration values", + "properties": { + "database": { + "description": "Name of the database where to store metric datapoints. Only affects PostgreSQL destinations. Defaults to 'metrics'. Note that this must be the same for all metrics integrations that write data to the same PostgreSQL service.", + "maxLength": 40, + "pattern": "^[_A-Za-z0-9][-_A-Za-z0-9]{0,39}$", + "type": "string" + }, + "retention_days": { + "description": "Number of days to keep old metrics. Only affects PostgreSQL destinations. Set to 0 for no automatic cleanup. Defaults to 30 days.", + "maximum": 10000, + "minimum": 0, + "type": "integer" + }, + "ro_username": { + "description": "Name of a user that can be used to read metrics. This will be used for Grafana integration (if enabled) to prevent Grafana users from making undesired changes. Only affects PostgreSQL destinations. Defaults to 'metrics_reader'. Note that this must be the same for all metrics integrations that write data to the same PostgreSQL service.", + "maxLength": 40, + "pattern": "^[_A-Za-z0-9][-._A-Za-z0-9]{0,39}$", + "type": "string" + }, + "source_mysql": { + "description": "Configuration options for metrics where source service is MySQL", + "properties": { + "telegraf": { + "description": "Configuration options for Telegraf MySQL input plugin", + "properties": { + "gather_event_waits": { + "description": "Gather metrics from PERFORMANCE_SCHEMA.EVENT_WAITS", + "type": "boolean" + }, + "gather_file_events_stats": { + "description": "gather metrics from PERFORMANCE_SCHEMA.FILE_SUMMARY_BY_EVENT_NAME", + "type": "boolean" + }, + "gather_index_io_waits": { + "description": "Gather metrics from PERFORMANCE_SCHEMA.TABLE_IO_WAITS_SUMMARY_BY_INDEX_USAGE", + "type": "boolean" + }, + "gather_info_schema_auto_inc": { + "description": "Gather auto_increment columns and max values from information schema", + "type": "boolean" + }, + "gather_innodb_metrics": { + "description": "Gather metrics from INFORMATION_SCHEMA.INNODB_METRICS", + "type": "boolean" + }, + "gather_perf_events_statements": { + "description": "Gather metrics from PERFORMANCE_SCHEMA.EVENTS_STATEMENTS_SUMMARY_BY_DIGEST", + "type": "boolean" + }, + "gather_process_list": { + "description": "Gather thread state counts from INFORMATION_SCHEMA.PROCESSLIST", + "type": "boolean" + }, + "gather_slave_status": { + "description": "Gather metrics from SHOW SLAVE STATUS command output", + "type": "boolean" + }, + "gather_table_io_waits": { + "description": "Gather metrics from PERFORMANCE_SCHEMA.TABLE_IO_WAITS_SUMMARY_BY_TABLE", + "type": "boolean" + }, + "gather_table_lock_waits": { + "description": "Gather metrics from PERFORMANCE_SCHEMA.TABLE_LOCK_WAITS", + "type": "boolean" + }, + "gather_table_schema": { + "description": "Gather metrics from INFORMATION_SCHEMA.TABLES", + "type": "boolean" + }, + "perf_events_statements_digest_text_limit": { + "description": "Truncates digest text from perf_events_statements into this many characters", + "maximum": 2048, + "minimum": 1, + "type": "integer" + }, + "perf_events_statements_limit": { + "description": "Limits metrics from perf_events_statements", + "maximum": 4000, + "minimum": 1, + "type": "integer" + }, + "perf_events_statements_time_limit": { + "description": "Only include perf_events_statements whose last seen is less than this many seconds", + "maximum": 2592000, + "minimum": 1, + "type": "integer" + } + }, + "type": "object", + "additionalProperties": false + } + }, + "type": "object", + "additionalProperties": false + }, + "username": { + "description": "Name of the user used to write metrics. Only affects PostgreSQL destinations. Defaults to 'metrics_writer'. Note that this must be the same for all metrics integrations that write data to the same PostgreSQL service.", + "maxLength": 40, + "pattern": "^[_A-Za-z0-9][-._A-Za-z0-9]{0,39}$", + "type": "string" + } + }, + "type": "object", + "additionalProperties": false + }, + "project": { + "description": "Identifies the project this resource belongs to", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "sourceEndpointID": { + "description": "Source endpoint for the integration (if any)", + "maxLength": 36, + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "sourceProjectName": { + "description": "Source project for the integration (if any)", + "maxLength": 63, + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "sourceServiceName": { + "description": "Source service for the integration (if any)", + "maxLength": 64, + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + } + }, + "required": [ + "integrationType", + "project" + ], + "type": "object", + "additionalProperties": false + }, + "status": { + "description": "ServiceIntegrationStatus defines the observed state of ServiceIntegration", + "properties": { + "conditions": { + "description": "Conditions represent the latest available observations of an ServiceIntegration state", + "items": { + "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}", + "properties": { + "lastTransitionTime": { + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis 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", + "type": "string" + }, + "message": { + "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", + "maxLength": 32768, + "type": "string" + }, + "observedGeneration": { + "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "reason": { + "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", + "type": "string" + }, + "status": { + "description": "status of the condition, one of True, False, Unknown.", + "enum": [ + "True", + "False", + "Unknown" + ], + "type": "string" + }, + "type": { + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", + "type": "string" + } + }, + "required": [ + "lastTransitionTime", + "message", + "reason", + "status", + "type" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + }, + "id": { + "description": "Service integration ID", + "type": "string" + } + }, + "required": [ + "conditions", + "id" + ], + "type": "object", + "additionalProperties": false + } + }, + "type": "object" +} diff --git a/aiven.io/serviceintegrationendpoint_v1alpha1.json b/aiven.io/serviceintegrationendpoint_v1alpha1.json new file mode 100644 index 00000000..ae886602 --- /dev/null +++ b/aiven.io/serviceintegrationendpoint_v1alpha1.json @@ -0,0 +1,727 @@ +{ + "description": "ServiceIntegrationEndpoint is the Schema for the serviceintegrationendpoints API", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "type": "object" + }, + "spec": { + "description": "ServiceIntegrationEndpointSpec defines the desired state of ServiceIntegrationEndpoint", + "properties": { + "authSecretRef": { + "description": "Authentication reference to Aiven token in a secret", + "properties": { + "key": { + "minLength": 1, + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key", + "name" + ], + "type": "object", + "additionalProperties": false + }, + "datadog": { + "description": "Datadog configuration values", + "properties": { + "datadog_api_key": { + "description": "Datadog API key", + "maxLength": 256, + "minLength": 1, + "pattern": "^[A-Za-z0-9]{1,256}$", + "type": "string" + }, + "datadog_tags": { + "description": "Custom tags provided by user", + "items": { + "description": "Datadog tag defined by user", + "properties": { + "comment": { + "description": "Optional tag explanation", + "maxLength": 1024, + "type": "string" + }, + "tag": { + "description": "Tag format and usage are described here: https://docs.datadoghq.com/getting_started/tagging. Tags with prefix 'aiven-' are reserved for Aiven.", + "maxLength": 200, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "tag" + ], + "type": "object", + "additionalProperties": false + }, + "maxItems": 32, + "type": "array" + }, + "disable_consumer_stats": { + "description": "Disable consumer group metrics", + "type": "boolean" + }, + "kafka_consumer_check_instances": { + "description": "Number of separate instances to fetch kafka consumer statistics with", + "maximum": 100, + "minimum": 1, + "type": "integer" + }, + "kafka_consumer_stats_timeout": { + "description": "Number of seconds that datadog will wait to get consumer statistics from brokers", + "maximum": 300, + "minimum": 2, + "type": "integer" + }, + "max_partition_contexts": { + "description": "Maximum number of partition contexts to send", + "maximum": 200000, + "minimum": 200, + "type": "integer" + }, + "site": { + "description": "Datadog intake site. Defaults to datadoghq.com", + "enum": [ + "datadoghq.com", + "datadoghq.eu", + "us3.datadoghq.com", + "us5.datadoghq.com", + "ddog-gov.com", + "ap1.datadoghq.com" + ], + "type": "string" + } + }, + "required": [ + "datadog_api_key" + ], + "type": "object", + "additionalProperties": false + }, + "endpointName": { + "description": "Source endpoint for the integration (if any)", + "maxLength": 36, + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "endpointType": { + "description": "Type of the service integration endpoint", + "enum": [ + "autoscaler", + "datadog", + "external_aws_cloudwatch_logs", + "external_aws_cloudwatch_metrics", + "external_aws_s3", + "external_clickhouse", + "external_elasticsearch_logs", + "external_google_cloud_bigquery", + "external_google_cloud_logging", + "external_kafka", + "external_mysql", + "external_opensearch_logs", + "external_postgresql", + "external_redis", + "external_schema_registry", + "external_sumologic_logs", + "jolokia", + "prometheus", + "rsyslog" + ], + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "externalAWSCloudwatchLogs": { + "description": "ExternalAwsCloudwatchLogs configuration values", + "properties": { + "access_key": { + "description": "AWS access key. Required permissions are logs:CreateLogGroup, logs:CreateLogStream, logs:PutLogEvents and logs:DescribeLogStreams", + "maxLength": 4096, + "type": "string" + }, + "log_group_name": { + "description": "AWS CloudWatch log group name", + "maxLength": 512, + "minLength": 1, + "pattern": "^[\\.\\-_/#A-Za-z0-9]+$", + "type": "string" + }, + "region": { + "description": "AWS region", + "maxLength": 32, + "type": "string" + }, + "secret_key": { + "description": "AWS secret key", + "maxLength": 4096, + "type": "string" + } + }, + "required": [ + "access_key", + "region", + "secret_key" + ], + "type": "object", + "additionalProperties": false + }, + "externalAWSCloudwatchMetrics": { + "description": "ExternalAwsCloudwatchMetrics configuration values", + "properties": { + "access_key": { + "description": "AWS access key. Required permissions are cloudwatch:PutMetricData", + "maxLength": 4096, + "type": "string" + }, + "namespace": { + "description": "AWS CloudWatch Metrics Namespace", + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "region": { + "description": "AWS region", + "maxLength": 32, + "type": "string" + }, + "secret_key": { + "description": "AWS secret key", + "maxLength": 4096, + "type": "string" + } + }, + "required": [ + "access_key", + "namespace", + "region", + "secret_key" + ], + "type": "object", + "additionalProperties": false + }, + "externalElasticsearchLogs": { + "description": "ExternalElasticsearchLogs configuration values", + "properties": { + "ca": { + "description": "PEM encoded CA certificate", + "maxLength": 16384, + "type": "string" + }, + "index_days_max": { + "description": "Maximum number of days of logs to keep", + "maximum": 10000, + "minimum": 1, + "type": "integer" + }, + "index_prefix": { + "description": "Elasticsearch index prefix", + "maxLength": 1000, + "minLength": 1, + "pattern": "^[a-z0-9][a-z0-9-_.]+$", + "type": "string" + }, + "timeout": { + "description": "Elasticsearch request timeout limit", + "maximum": 120, + "minimum": 10, + "type": "number" + }, + "url": { + "description": "Elasticsearch connection URL", + "maxLength": 2048, + "minLength": 12, + "type": "string" + } + }, + "required": [ + "index_prefix", + "url" + ], + "type": "object", + "additionalProperties": false + }, + "externalGoogleCloudBigquery": { + "description": "ExternalGoogleCloudBigquery configuration values", + "properties": { + "project_id": { + "description": "GCP project id.", + "maxLength": 30, + "minLength": 6, + "type": "string" + }, + "service_account_credentials": { + "description": "This is a JSON object with the fields documented in https://cloud.google.com/iam/docs/creating-managing-service-account-keys .", + "maxLength": 4096, + "type": "string" + } + }, + "required": [ + "project_id", + "service_account_credentials" + ], + "type": "object", + "additionalProperties": false + }, + "externalGoogleCloudLogging": { + "description": "ExternalGoogleCloudLogging configuration values", + "properties": { + "log_id": { + "description": "Google Cloud Logging log id", + "maxLength": 512, + "type": "string" + }, + "project_id": { + "description": "GCP project id.", + "maxLength": 30, + "minLength": 6, + "type": "string" + }, + "service_account_credentials": { + "description": "This is a JSON object with the fields documented in https://cloud.google.com/iam/docs/creating-managing-service-account-keys .", + "maxLength": 4096, + "type": "string" + } + }, + "required": [ + "log_id", + "project_id", + "service_account_credentials" + ], + "type": "object", + "additionalProperties": false + }, + "externalKafka": { + "description": "ExternalKafka configuration values", + "properties": { + "bootstrap_servers": { + "description": "Bootstrap servers", + "maxLength": 256, + "minLength": 3, + "type": "string" + }, + "sasl_mechanism": { + "description": "SASL mechanism used for connections to the Kafka server.", + "enum": [ + "PLAIN", + "SCRAM-SHA-256", + "SCRAM-SHA-512" + ], + "type": "string" + }, + "sasl_plain_password": { + "description": "Password for SASL PLAIN mechanism in the Kafka server.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "sasl_plain_username": { + "description": "Username for SASL PLAIN mechanism in the Kafka server.", + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "security_protocol": { + "description": "Security protocol", + "enum": [ + "PLAINTEXT", + "SSL", + "SASL_PLAINTEXT", + "SASL_SSL" + ], + "type": "string" + }, + "ssl_ca_cert": { + "description": "PEM-encoded CA certificate", + "maxLength": 16384, + "type": "string" + }, + "ssl_client_cert": { + "description": "PEM-encoded client certificate", + "maxLength": 16384, + "type": "string" + }, + "ssl_client_key": { + "description": "PEM-encoded client key", + "maxLength": 16384, + "type": "string" + }, + "ssl_endpoint_identification_algorithm": { + "description": "The endpoint identification algorithm to validate server hostname using server certificate.", + "enum": [ + "https" + ], + "type": "string" + } + }, + "required": [ + "bootstrap_servers", + "security_protocol" + ], + "type": "object", + "additionalProperties": false + }, + "externalOpensearchLogs": { + "description": "ExternalOpensearchLogs configuration values", + "properties": { + "ca": { + "description": "PEM encoded CA certificate", + "maxLength": 16384, + "type": "string" + }, + "index_days_max": { + "description": "Maximum number of days of logs to keep", + "maximum": 10000, + "minimum": 1, + "type": "integer" + }, + "index_prefix": { + "description": "OpenSearch index prefix", + "maxLength": 1000, + "minLength": 1, + "pattern": "^[a-z0-9][a-z0-9-_.]+$", + "type": "string" + }, + "timeout": { + "description": "OpenSearch request timeout limit", + "maximum": 120, + "minimum": 10, + "type": "number" + }, + "url": { + "description": "OpenSearch connection URL", + "maxLength": 2048, + "minLength": 12, + "type": "string" + } + }, + "required": [ + "index_prefix", + "url" + ], + "type": "object", + "additionalProperties": false + }, + "externalPostgresql": { + "description": "ExternalPostgresql configuration values", + "properties": { + "default_database": { + "description": "Default database", + "maxLength": 63, + "pattern": "^[_A-Za-z0-9][-_A-Za-z0-9]{0,62}$", + "type": "string" + }, + "host": { + "description": "Hostname or IP address of the server", + "maxLength": 255, + "type": "string" + }, + "password": { + "description": "Password", + "maxLength": 256, + "type": "string" + }, + "port": { + "description": "Port number of the server", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "ssl_client_certificate": { + "description": "Client certificate", + "maxLength": 16384, + "type": "string" + }, + "ssl_client_key": { + "description": "Client key", + "maxLength": 16384, + "type": "string" + }, + "ssl_mode": { + "description": "SSL mode to use for the connection. Please note that Aiven requires TLS for all connections to external PostgreSQL services.", + "enum": [ + "require", + "verify-ca", + "verify-full" + ], + "type": "string" + }, + "ssl_root_cert": { + "description": "SSL Root Cert", + "maxLength": 16384, + "type": "string" + }, + "username": { + "description": "User name", + "maxLength": 256, + "type": "string" + } + }, + "required": [ + "host", + "port", + "username" + ], + "type": "object", + "additionalProperties": false + }, + "externalSchemaRegistry": { + "description": "ExternalSchemaRegistry configuration values", + "properties": { + "authentication": { + "description": "Authentication method", + "enum": [ + "none", + "basic" + ], + "type": "string" + }, + "basic_auth_password": { + "description": "Basic authentication password", + "maxLength": 256, + "type": "string" + }, + "basic_auth_username": { + "description": "Basic authentication user name", + "maxLength": 256, + "type": "string" + }, + "url": { + "description": "Schema Registry URL", + "maxLength": 2048, + "type": "string" + } + }, + "required": [ + "authentication", + "url" + ], + "type": "object", + "additionalProperties": false + }, + "jolokia": { + "description": "Jolokia configuration values", + "properties": { + "basic_auth_password": { + "description": "Jolokia basic authentication password", + "maxLength": 64, + "minLength": 8, + "type": "string" + }, + "basic_auth_username": { + "description": "Jolokia basic authentication username", + "maxLength": 32, + "minLength": 5, + "pattern": "^[a-z0-9\\-@_]{5,32}$", + "type": "string" + } + }, + "type": "object", + "additionalProperties": false + }, + "project": { + "description": "Identifies the project this resource belongs to", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "prometheus": { + "description": "Prometheus configuration values", + "properties": { + "basic_auth_password": { + "description": "Prometheus basic authentication password", + "maxLength": 64, + "minLength": 8, + "type": "string" + }, + "basic_auth_username": { + "description": "Prometheus basic authentication username", + "maxLength": 32, + "minLength": 5, + "pattern": "^[a-z0-9\\-@_]{5,32}$", + "type": "string" + } + }, + "type": "object", + "additionalProperties": false + }, + "rsyslog": { + "description": "Rsyslog configuration values", + "properties": { + "ca": { + "description": "PEM encoded CA certificate", + "maxLength": 16384, + "type": "string" + }, + "cert": { + "description": "PEM encoded client certificate", + "maxLength": 16384, + "type": "string" + }, + "format": { + "description": "Message format", + "enum": [ + "rfc5424", + "rfc3164", + "custom" + ], + "type": "string" + }, + "key": { + "description": "PEM encoded client key", + "maxLength": 16384, + "type": "string" + }, + "logline": { + "description": "Custom syslog message format", + "maxLength": 512, + "minLength": 1, + "pattern": "^[ -~\\t]+$", + "type": "string" + }, + "max_message_size": { + "description": "Rsyslog max message size", + "maximum": 2147483647, + "minimum": 2048, + "type": "integer" + }, + "port": { + "description": "Rsyslog server port", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, + "sd": { + "description": "Structured data block for log message", + "maxLength": 1024, + "type": "string" + }, + "server": { + "description": "Rsyslog server IP address or hostname", + "maxLength": 255, + "minLength": 4, + "type": "string" + }, + "tls": { + "description": "Require TLS", + "type": "boolean" + } + }, + "required": [ + "format", + "port", + "server", + "tls" + ], + "type": "object", + "additionalProperties": false + } + }, + "required": [ + "endpointType", + "project" + ], + "type": "object", + "additionalProperties": false + }, + "status": { + "description": "ServiceIntegrationEndpointStatus defines the observed state of ServiceIntegrationEndpoint", + "properties": { + "conditions": { + "description": "Conditions represent the latest available observations of an ServiceIntegrationEndpoint state", + "items": { + "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}", + "properties": { + "lastTransitionTime": { + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis 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", + "type": "string" + }, + "message": { + "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", + "maxLength": 32768, + "type": "string" + }, + "observedGeneration": { + "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "reason": { + "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", + "type": "string" + }, + "status": { + "description": "status of the condition, one of True, False, Unknown.", + "enum": [ + "True", + "False", + "Unknown" + ], + "type": "string" + }, + "type": { + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", + "type": "string" + } + }, + "required": [ + "lastTransitionTime", + "message", + "reason", + "status", + "type" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + }, + "id": { + "description": "Service integration ID", + "type": "string" + } + }, + "required": [ + "conditions", + "id" + ], + "type": "object", + "additionalProperties": false + } + }, + "type": "object" +} diff --git a/aiven.io/serviceuser_v1alpha1.json b/aiven.io/serviceuser_v1alpha1.json new file mode 100644 index 00000000..b1957de2 --- /dev/null +++ b/aiven.io/serviceuser_v1alpha1.json @@ -0,0 +1,205 @@ +{ + "description": "ServiceUser is the Schema for the serviceusers API.\nInfo \"Exposes secret keys\": `SERVICEUSER_HOST`, `SERVICEUSER_PORT`, `SERVICEUSER_USERNAME`, `SERVICEUSER_PASSWORD`, `SERVICEUSER_CA_CERT`, `SERVICEUSER_ACCESS_CERT`, `SERVICEUSER_ACCESS_KEY`", + "properties": { + "apiVersion": { + "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", + "type": "string" + }, + "kind": { + "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", + "type": "string" + }, + "metadata": { + "type": "object" + }, + "spec": { + "description": "ServiceUserSpec defines the desired state of ServiceUser", + "properties": { + "authSecretRef": { + "description": "Authentication reference to Aiven token in a secret", + "properties": { + "key": { + "minLength": 1, + "type": "string" + }, + "name": { + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key", + "name" + ], + "type": "object", + "additionalProperties": false + }, + "authentication": { + "description": "Authentication details", + "enum": [ + "caching_sha2_password", + "mysql_native_password" + ], + "type": "string" + }, + "connInfoSecretTarget": { + "description": "Secret configuration.", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Annotations added to the secret", + "type": "object", + "x-kubernetes-preserve-unknown-fields": true + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels added to the secret", + "type": "object", + "x-kubernetes-preserve-unknown-fields": true + }, + "name": { + "description": "Name of the secret resource to be created. By default, it is equal to the resource name", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "prefix": { + "description": "Prefix for the secret's keys.\nAdded \"as is\" without any transformations.\nBy default, is equal to the kind name in uppercase + underscore, e.g. `KAFKA_`, `REDIS_`, etc.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "additionalProperties": false + }, + "connInfoSecretTargetDisabled": { + "description": "When true, the secret containing connection information will not be created, defaults to false. This field cannot be changed after resource creation.", + "type": "boolean", + "x-kubernetes-validations": [ + { + "message": "connInfoSecretTargetDisabled is immutable.", + "rule": "self == oldSelf" + } + ] + }, + "project": { + "description": "Identifies the project this resource belongs to", + "maxLength": 63, + "pattern": "^[a-zA-Z0-9_-]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + }, + "serviceName": { + "description": "Specifies the name of the service that this resource belongs to", + "maxLength": 63, + "pattern": "^[a-z][-a-z0-9]+$", + "type": "string", + "x-kubernetes-validations": [ + { + "message": "Value is immutable", + "rule": "self == oldSelf" + } + ] + } + }, + "required": [ + "project", + "serviceName" + ], + "type": "object", + "x-kubernetes-validations": [ + { + "message": "connInfoSecretTargetDisabled can only be set during resource creation.", + "rule": "has(oldSelf.connInfoSecretTargetDisabled) == has(self.connInfoSecretTargetDisabled)" + } + ], + "additionalProperties": false + }, + "status": { + "description": "ServiceUserStatus defines the observed state of ServiceUser", + "properties": { + "conditions": { + "description": "Conditions represent the latest available observations of an ServiceUser state", + "items": { + "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}", + "properties": { + "lastTransitionTime": { + "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis 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", + "type": "string" + }, + "message": { + "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", + "maxLength": 32768, + "type": "string" + }, + "observedGeneration": { + "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", + "format": "int64", + "minimum": 0, + "type": "integer" + }, + "reason": { + "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", + "type": "string" + }, + "status": { + "description": "status of the condition, one of True, False, Unknown.", + "enum": [ + "True", + "False", + "Unknown" + ], + "type": "string" + }, + "type": { + "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", + "maxLength": 316, + "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", + "type": "string" + } + }, + "required": [ + "lastTransitionTime", + "message", + "reason", + "status", + "type" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array" + }, + "type": { + "description": "Type of the user account", + "type": "string" + } + }, + "required": [ + "conditions" + ], + "type": "object", + "additionalProperties": false + } + }, + "type": "object" +}