kafkatopic_v1beta1.json

{
  "type": "object",
  "properties": {
    "apiVersion": {
      "type": "string",
      "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources"
    },
    "kind": {
      "type": "string",
      "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
    },
    "metadata": {
      "type": "object"
    },
    "spec": {
      "type": "object",
      "properties": {
        "topicName": {
          "type": "string",
          "description": "The name of the topic. When absent this will default to the metadata.name of the topic. It is recommended to not set this unless the topic name is not a valid Kubernetes resource name."
        },
        "partitions": {
          "type": "integer",
          "minimum": 1,
          "description": "The number of partitions the topic should have. This cannot be decreased after topic creation. It can be increased after topic creation, but it is important to understand the consequences that has, especially for topics with semantic partitioning. When absent this will default to the broker configuration for `num.partitions`."
        },
        "replicas": {
          "type": "integer",
          "minimum": 1,
          "maximum": 32767,
          "description": "The number of replicas the topic should have. When absent this will default to the broker configuration for `default.replication.factor`."
        },
        "config": {
          "x-kubernetes-preserve-unknown-fields": true,
          "type": "object",
          "description": "The topic configuration."
        }
      },
      "description": "The specification of the topic.",
      "additionalProperties": false
    },
    "status": {
      "type": "object",
      "properties": {
        "conditions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "description": "The unique identifier of a condition, used to distinguish between other conditions in the resource."
              },
              "status": {
                "type": "string",
                "description": "The status of the condition, either True, False or Unknown."
              },
              "lastTransitionTime": {
                "type": "string",
                "description": "Last time the condition of a type changed from one status to another. The required format is 'yyyy-MM-ddTHH:mm:ssZ', in the UTC time zone."
              },
              "reason": {
                "type": "string",
                "description": "The reason for the condition's last transition (a single word in CamelCase)."
              },
              "message": {
                "type": "string",
                "description": "Human-readable message indicating details about the condition's last transition."
              }
            },
            "additionalProperties": false
          },
          "description": "List of status conditions."
        },
        "observedGeneration": {
          "type": "integer",
          "description": "The generation of the CRD that was last reconciled by the operator."
        },
        "topicName": {
          "type": "string",
          "description": "Topic name."
        },
        "topicId": {
          "type": "string",
          "description": "The topic's id. For a KafkaTopic with the ready condition, this will change only if the topic gets deleted and recreated with the same name."
        },
        "replicasChange": {
          "type": "object",
          "properties": {
            "targetReplicas": {
              "type": "integer",
              "description": "The target replicas value requested by the user. This may be different from .spec.replicas when a change is ongoing."
            },
            "state": {
              "type": "string",
              "enum": [
                "pending",
                "ongoing"
              ],
              "description": "Current state of the replicas change operation. This can be `pending`, when the change has been requested, or `ongoing`, when the change has been successfully submitted to Cruise Control."
            },
            "message": {
              "type": "string",
              "description": "Message for the user related to the replicas change request. This may contain transient error messages that would disappear on periodic reconciliations."
            },
            "sessionId": {
              "type": "string",
              "description": "The session identifier for replicas change requests pertaining to this KafkaTopic resource. This is used by the Topic Operator to track the status of `ongoing` replicas change operations."
            }
          },
          "description": "Replication factor change status.",
          "additionalProperties": false
        }
      },
      "description": "The status of the topic.",
      "additionalProperties": false
    }
  }
}