clickhousegrant_v1alpha1.json

{
  "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"
}