workspace.gitpod.io_workspaces.yaml

# Copyright (c) 2025 Gitpod GmbH. All rights reserved.
# Licensed under the GNU Affero General Public License (AGPL).
# See License.AGPL.txt in the project root for license information.

---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  annotations:
    controller-gen.kubebuilder.io/version: v0.16.5
  name: workspaces.workspace.gitpod.io
spec:
  group: workspace.gitpod.io
  names:
    kind: Workspace
    listKind: WorkspaceList
    plural: workspaces
    shortNames:
    - ws
    singular: workspace
  scope: Namespaced
  versions:
  - additionalPrinterColumns:
    - jsonPath: .spec.ownership.workspaceID
      name: Workspace
      priority: 10
      type: string
    - jsonPath: .spec.class
      name: Class
      type: string
    - jsonPath: .spec.type
      name: Type
      type: string
    - jsonPath: .status.runtime.nodeName
      name: Node
      type: string
    - jsonPath: .spec.ownership.owner
      name: Owner
      type: string
    - jsonPath: .spec.ownership.team
      name: Team
      type: string
    - jsonPath: .status.phase
      name: Phase
      type: string
    - jsonPath: .metadata.creationTimestamp
      name: Age
      type: date
    name: v1
    schema:
      openAPIV3Schema:
        description: Workspace is the Schema for the workspaces 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: WorkspaceSpec defines the desired state of Workspace
            properties:
              admission:
                properties:
                  level:
                    default: Owner
                    enum:
                    - Owner
                    - Everyone
                    type: string
                required:
                - level
                type: object
              class:
                type: string
              git:
                properties:
                  email:
                    type: string
                  username:
                    type: string
                required:
                - email
                - username
                type: object
              image:
                properties:
                  ide:
                    properties:
                      refs:
                        items:
                          type: string
                        type: array
                      supervisor:
                        type: string
                      web:
                        type: string
                    required:
                    - supervisor
                    - web
                    type: object
                  workspace:
                    properties:
                      ref:
                        type: string
                    type: object
                required:
                - ide
                - workspace
                type: object
              initializer:
                format: byte
                type: string
              ownership:
                properties:
                  owner:
                    type: string
                  team:
                    type: string
                  tenant:
                    type: string
                  workspaceID:
                    type: string
                required:
                - owner
                - workspaceID
                type: object
              ports:
                items:
                  properties:
                    port:
                      format: int32
                      type: integer
                    protocol:
                      default: Http
                      enum:
                      - Http
                      - Https
                      type: string
                    visibility:
                      default: Owner
                      enum:
                      - Owner
                      - Everyone
                      type: string
                  required:
                  - port
                  - protocol
                  - visibility
                  type: object
                minItems: 0
                type: array
              sshGatewayCAPublicKey:
                type: string
              sshPublicKeys:
                items:
                  type: string
                type: array
              storageQuota:
                description: the XFS quota to enforce on the workspace's /workspace
                  folder
                type: integer
              sysEnvVars:
                items:
                  description: EnvVar represents an environment variable present in
                    a Container.
                  properties:
                    name:
                      description: Name of the environment variable. Must be a C_IDENTIFIER.
                      type: string
                    value:
                      description: |-
                        Variable references $(VAR_NAME) are expanded
                        using the previously defined environment variables in the container and
                        any service environment variables. If a variable cannot be resolved,
                        the reference in the input string will be unchanged. Double $$ are reduced
                        to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
                        "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
                        Escaped references will never be expanded, regardless of whether the variable
                        exists or not.
                        Defaults to "".
                      type: string
                    valueFrom:
                      description: Source for the environment variable's value. Cannot
                        be used if value is not empty.
                      properties:
                        configMapKeyRef:
                          description: Selects a key of a ConfigMap.
                          properties:
                            key:
                              description: The key to select.
                              type: string
                            name:
                              default: ""
                              description: |-
                                Name of the referent.
                                This field is effectively required, but due to backwards compatibility is
                                allowed to be empty. Instances of this type with an empty value here are
                                almost certainly wrong.
                                More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
                              type: string
                            optional:
                              description: Specify whether the ConfigMap or its key
                                must be defined
                              type: boolean
                          required:
                          - key
                          type: object
                          x-kubernetes-map-type: atomic
                        fieldRef:
                          description: |-
                            Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`,
                            spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
                          properties:
                            apiVersion:
                              description: Version of the schema the FieldPath is
                                written in terms of, defaults to "v1".
                              type: string
                            fieldPath:
                              description: Path of the field to select in the specified
                                API version.
                              type: string
                          required:
                          - fieldPath
                          type: object
                          x-kubernetes-map-type: atomic
                        resourceFieldRef:
                          description: |-
                            Selects a resource of the container: only resources limits and requests
                            (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
                          properties:
                            containerName:
                              description: 'Container name: required for volumes,
                                optional for env vars'
                              type: string
                            divisor:
                              anyOf:
                              - type: integer
                              - type: string
                              description: Specifies the output format of the exposed
                                resources, defaults to "1"
                              pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
                              x-kubernetes-int-or-string: true
                            resource:
                              description: 'Required: resource to select'
                              type: string
                          required:
                          - resource
                          type: object
                          x-kubernetes-map-type: atomic
                        secretKeyRef:
                          description: Selects a key of a secret in the pod's namespace
                          properties:
                            key:
                              description: The key of the secret to select from.  Must
                                be a valid secret key.
                              type: string
                            name:
                              default: ""
                              description: |-
                                Name of the referent.
                                This field is effectively required, but due to backwards compatibility is
                                allowed to be empty. Instances of this type with an empty value here are
                                almost certainly wrong.
                                More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
                              type: string
                            optional:
                              description: Specify whether the Secret or its key must
                                be defined
                              type: boolean
                          required:
                          - key
                          type: object
                          x-kubernetes-map-type: atomic
                      type: object
                  required:
                  - name
                  type: object
                type: array
              timeout:
                properties:
                  closed:
                    pattern: ^([0-9]+(\.[0-9]+)?(ms|s|m|h)?)+$
                    type: string
                  maximumLifetime:
                    pattern: ^([0-9]+(\.[0-9]+)?(ms|s|m|h)?)+$
                    type: string
                  time:
                    pattern: ^([0-9]+(\.[0-9]+)?(ms|s|m|h))+$
                    type: string
                type: object
              type:
                enum:
                - Regular
                - Prebuild
                - ImageBuild
                type: string
              userEnvVars:
                items:
                  description: EnvVar represents an environment variable present in
                    a Container.
                  properties:
                    name:
                      description: Name of the environment variable. Must be a C_IDENTIFIER.
                      type: string
                    value:
                      description: |-
                        Variable references $(VAR_NAME) are expanded
                        using the previously defined environment variables in the container and
                        any service environment variables. If a variable cannot be resolved,
                        the reference in the input string will be unchanged. Double $$ are reduced
                        to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
                        "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
                        Escaped references will never be expanded, regardless of whether the variable
                        exists or not.
                        Defaults to "".
                      type: string
                    valueFrom:
                      description: Source for the environment variable's value. Cannot
                        be used if value is not empty.
                      properties:
                        configMapKeyRef:
                          description: Selects a key of a ConfigMap.
                          properties:
                            key:
                              description: The key to select.
                              type: string
                            name:
                              default: ""
                              description: |-
                                Name of the referent.
                                This field is effectively required, but due to backwards compatibility is
                                allowed to be empty. Instances of this type with an empty value here are
                                almost certainly wrong.
                                More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
                              type: string
                            optional:
                              description: Specify whether the ConfigMap or its key
                                must be defined
                              type: boolean
                          required:
                          - key
                          type: object
                          x-kubernetes-map-type: atomic
                        fieldRef:
                          description: |-
                            Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`,
                            spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
                          properties:
                            apiVersion:
                              description: Version of the schema the FieldPath is
                                written in terms of, defaults to "v1".
                              type: string
                            fieldPath:
                              description: Path of the field to select in the specified
                                API version.
                              type: string
                          required:
                          - fieldPath
                          type: object
                          x-kubernetes-map-type: atomic
                        resourceFieldRef:
                          description: |-
                            Selects a resource of the container: only resources limits and requests
                            (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
                          properties:
                            containerName:
                              description: 'Container name: required for volumes,
                                optional for env vars'
                              type: string
                            divisor:
                              anyOf:
                              - type: integer
                              - type: string
                              description: Specifies the output format of the exposed
                                resources, defaults to "1"
                              pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
                              x-kubernetes-int-or-string: true
                            resource:
                              description: 'Required: resource to select'
                              type: string
                          required:
                          - resource
                          type: object
                          x-kubernetes-map-type: atomic
                        secretKeyRef:
                          description: Selects a key of a secret in the pod's namespace
                          properties:
                            key:
                              description: The key of the secret to select from.  Must
                                be a valid secret key.
                              type: string
                            name:
                              default: ""
                              description: |-
                                Name of the referent.
                                This field is effectively required, but due to backwards compatibility is
                                allowed to be empty. Instances of this type with an empty value here are
                                almost certainly wrong.
                                More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
                              type: string
                            optional:
                              description: Specify whether the Secret or its key must
                                be defined
                              type: boolean
                          required:
                          - key
                          type: object
                          x-kubernetes-map-type: atomic
                      type: object
                  required:
                  - name
                  type: object
                type: array
              workspaceLocation:
                type: string
            required:
            - admission
            - class
            - image
            - initializer
            - ownership
            - ports
            - type
            - workspaceLocation
            type: object
          status:
            description: WorkspaceStatus defines the observed state of Workspace
            properties:
              conditions:
                items:
                  description: Condition contains details for one aspect of the current
                    state of this API Resource.
                  properties:
                    lastTransitionTime:
                      description: |-
                        lastTransitionTime is the last time the condition transitioned from one status to another.
                        This 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.
                        This may be an empty string.
                      maxLength: 32768
                      type: string
                    observedGeneration:
                      description: |-
                        observedGeneration represents the .metadata.generation that the condition was set based upon.
                        For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
                        with 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.
                        Producers of specific condition types may define expected values and meanings for this field,
                        and whether the values are considered a guaranteed API.
                        The value should be a CamelCase string.
                        This 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.
                      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
                type: array
              git:
                properties:
                  branch:
                    description: branch is branch we're currently on
                    type: string
                  latestCommit:
                    description: latest_commit is the most recent commit on the current
                      branch
                    type: string
                  totalUncommitedFiles:
                    description: the total number of uncommited files
                    format: int64
                    type: integer
                  totalUnpushedCommits:
                    description: the total number of unpushed changes
                    format: int64
                    type: integer
                  totalUntrackedFiles:
                    description: the total number of untracked files
                    format: int64
                    type: integer
                  uncommitedFiles:
                    description: uncommited_files is the number of uncommitted files,
                      possibly truncated
                    items:
                      type: string
                    type: array
                  unpushedCommits:
                    description: unpushed_commits is the number of unpushed changes
                      in the workspace, possibly truncated
                    items:
                      type: string
                    type: array
                  untrackedFiles:
                    description: untracked_files is the number of untracked files
                      in the workspace, possibly truncated
                    items:
                      type: string
                    type: array
                type: object
              imageInfo:
                properties:
                  totalSize:
                    format: int64
                    type: integer
                  workspaceImageRef:
                    type: string
                  workspaceImageSize:
                    format: int64
                    type: integer
                required:
                - totalSize
                type: object
              initializerMetrics:
                properties:
                  backup:
                    description: Backup contains metrics for the backup initializer
                      step
                    properties:
                      duration:
                        type: string
                      size:
                        format: int64
                        type: integer
                    type: object
                  composite:
                    description: Composite contains metrics for the composite initializer
                      step
                    properties:
                      duration:
                        type: string
                      size:
                        format: int64
                        type: integer
                    type: object
                  fileDownload:
                    description: FileDownload contains metrics for the file download
                      initializer step
                    properties:
                      duration:
                        type: string
                      size:
                        format: int64
                        type: integer
                    type: object
                  git:
                    description: Git contains metrics for the git initializer step
                    properties:
                      duration:
                        type: string
                      size:
                        format: int64
                        type: integer
                    type: object
                  prebuild:
                    description: Prebuild contains metrics for the prebuild initializer
                      step
                    properties:
                      duration:
                        type: string
                      size:
                        format: int64
                        type: integer
                    type: object
                  snapshot:
                    description: |-
                      Snapshot contains metrics for the snapshot initializer step
                      This used for workspaces started from snapshots.
                    properties:
                      duration:
                        type: string
                      size:
                        format: int64
                        type: integer
                    type: object
                type: object
              lastActivity:
                format: date-time
                type: string
              ownerToken:
                type: string
              phase:
                default: Unknown
                enum:
                - Unknown
                - Pending
                - Imagebuild
                - Creating
                - Initializing
                - Running
                - Stopping
                - Stopped
                type: string
              podDeletionTime:
                format: date-time
                type: string
              podRecreated:
                type: integer
              podStarts:
                type: integer
              podStoppingTime:
                format: date-time
                type: string
              runtime:
                properties:
                  hostIP:
                    type: string
                  nodeName:
                    type: string
                  podIP:
                    type: string
                  podName:
                    type: string
                type: object
              snapshot:
                description: Snapshot contains a snapshot URL if a snapshot was produced
                  prior to shutting the workspace down. This condition is only used
                  for headless workspaces.
                type: string
              storage:
                properties:
                  attachedDevice:
                    type: string
                  mountPath:
                    type: string
                  volumeName:
                    type: string
                required:
                - attachedDevice
                - mountPath
                - volumeName
                type: object
              url:
                type: string
            required:
            - podStarts
            type: object
        type: object
    served: true
    storage: true
    subresources:
      status: {}