superstream_v1alpha1.json

{
  "description": "SuperStream is the Schema for the queues API",
  "properties": {
    "apiVersion": {
      "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",
      "type": "string"
    },
    "kind": {
      "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",
      "type": "string"
    },
    "metadata": {
      "type": "object"
    },
    "spec": {
      "description": "SuperStreamSpec defines the desired state of SuperStream",
      "properties": {
        "name": {
          "description": "Name of the queue; required property.",
          "type": "string"
        },
        "partitions": {
          "default": 3,
          "description": "Number of partitions to create within this super stream. Defaults to '3'.",
          "type": "integer"
        },
        "rabbitmqClusterReference": {
          "description": "Reference to the RabbitmqCluster that the SuperStream will be created in. Required property.",
          "properties": {
            "connectionSecret": {
              "description": "Secret contains the http management uri for the RabbitMQ cluster. The Secret must contain the key `uri`, `username` and `password` or operator will error. Have to set either name or connectionSecret, but not both.",
              "properties": {
                "name": {
                  "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?",
                  "type": "string"
                }
              },
              "type": "object",
              "x-kubernetes-map-type": "atomic",
              "additionalProperties": false
            },
            "name": {
              "description": "The name of the RabbitMQ cluster to reference. Have to set either name or connectionSecret, but not both.",
              "type": "string"
            },
            "namespace": {
              "description": "The namespace of the RabbitMQ cluster to reference. Defaults to the namespace of the requested resource if omitted.",
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "routingKeys": {
          "description": "Routing keys to use for each of the partitions in the SuperStream If unset, the routing keys for the partitions will be set to the index of the partitions",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "vhost": {
          "default": "/",
          "description": "Default to vhost '/'; cannot be updated",
          "type": "string"
        }
      },
      "required": [
        "name",
        "rabbitmqClusterReference"
      ],
      "type": "object",
      "additionalProperties": false
    },
    "status": {
      "description": "SuperStreamStatus defines the observed state of SuperStream",
      "properties": {
        "conditions": {
          "items": {
            "properties": {
              "lastTransitionTime": {
                "description": "The last time this Condition status changed.",
                "format": "date-time",
                "type": "string"
              },
              "message": {
                "description": "Full text reason for current status of the condition.",
                "type": "string"
              },
              "reason": {
                "description": "One word, camel-case reason for current status of the condition.",
                "type": "string"
              },
              "status": {
                "description": "True, False, or Unknown",
                "type": "string"
              },
              "type": {
                "description": "Type indicates the scope of the custom resource status addressed by the condition.",
                "type": "string"
              }
            },
            "required": [
              "status",
              "type"
            ],
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "observedGeneration": {
          "description": "observedGeneration is the most recent successful generation observed for this SuperStream. It corresponds to the SuperStream's generation, which is updated on mutation by the API Server.",
          "format": "int64",
          "type": "integer"
        },
        "partitions": {
          "description": "Partitions are a list of the stream queue names which form the partitions of this SuperStream.",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "type": "object",
      "additionalProperties": false
    }
  },
  "type": "object"
}