fluxconfig_v1alpha1.json

{
  "description": "FluxConfig is the Schema for the fluxconfigs API and defines the configurations of the Flux GitOps Toolkit and Git repository it links to.",
  "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": "FluxConfigSpec defines the desired state of FluxConfig.",
      "properties": {
        "branch": {
          "default": "main",
          "description": "Git branch. Defaults to main.",
          "type": "string"
        },
        "clusterConfigPath": {
          "description": "ClusterConfigPath relative to the repository root, when specified the cluster sync will be scoped to this path.",
          "type": "string"
        },
        "git": {
          "description": "Used to specify Git provider that will be used to host the git files",
          "properties": {
            "repositoryUrl": {
              "description": "Repository URL for the repository to be used with flux. Can be either an SSH or HTTPS url.",
              "type": "string"
            },
            "sshKeyAlgorithm": {
              "description": "SSH public key algorithm for the private key specified (rsa, ecdsa, ed25519) (default ecdsa)",
              "type": "string"
            }
          },
          "required": [
            "repositoryUrl"
          ],
          "type": "object",
          "additionalProperties": false
        },
        "github": {
          "description": "Used to specify Github provider to host the Git repo and host the git files",
          "properties": {
            "owner": {
              "description": "Owner is the user or organization name of the Git provider.",
              "type": "string"
            },
            "personal": {
              "description": "if true, the owner is assumed to be a Git user; otherwise an org.",
              "type": "boolean"
            },
            "repository": {
              "description": "Repository name.",
              "type": "string"
            }
          },
          "required": [
            "owner",
            "repository"
          ],
          "type": "object",
          "additionalProperties": false
        },
        "systemNamespace": {
          "description": "SystemNamespace scope for this operation. Defaults to flux-system",
          "type": "string"
        }
      },
      "type": "object",
      "additionalProperties": false
    },
    "status": {
      "description": "FluxConfigStatus defines the observed state of FluxConfig.",
      "type": "object"
    }
  },
  "type": "object"
}