diff --git a/README.md b/README.md index b778e3162..b48de3336 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ From these Go sources, several files are generated: - A Kubernetes Custom Resource Definition(CRD) with an embedded OpenApi schema, - json schemas (in the [schemas](schemas) folder) generated from the above CRD, to specify the syntax of: - the DevWorkspace CRD itself; - - the DevWorkspaceTemplate CRD (a workspace content, without runtime information); + - the DevWorkspaceTemplate CRD (a devworkspace content, without runtime information); - the Devfile 2.0.0 format, which is generated from the `DevWorkspace` API. Generated files are created by a build script (see section [How to build](#how-to-build)). @@ -45,7 +45,7 @@ In order to test existing or new Devfile 2.0 or DevWorkspace sample files in a s [![Contribute](https://www.eclipse.org/che/contribute.svg)](https://che.openshift.io/f/?url=https://github.com/devfile/api) -As soon as the workspace is opened, you should be able to: +As soon as the devworkspace is opened, you should be able to: - open the `yaml` files in the following folders: - `samples/` - `devfile-support/samples` diff --git a/crds/workspace.devfile.io_devworkspaces.v1beta1.yaml b/crds/workspace.devfile.io_devworkspaces.v1beta1.yaml index 9f9ba2404..6ea6c4e3a 100644 --- a/crds/workspace.devfile.io_devworkspaces.v1beta1.yaml +++ b/crds/workspace.devfile.io_devworkspaces.v1beta1.yaml @@ -21,16 +21,16 @@ spec: version: v1alpha1 versions: - additionalPrinterColumns: - - JSONPath: .status.workspaceId - description: The workspace's unique id - name: Workspace ID + - JSONPath: .status.devWorkspaceId + description: The devworkspace's unique id + name: DevWorkspace ID type: string - JSONPath: .status.phase - description: The current workspace startup phase + description: The current devworkspace startup phase name: Phase type: string - JSONPath: .status.ideUrl - description: Url endpoint for accessing workspace + description: Url endpoint for accessing devworkspace name: URL type: string name: v1alpha1 @@ -58,11 +58,11 @@ spec: started: type: boolean template: - description: Structure of the workspace. This is also the specification - of a workspace template. + description: Structure of the devworkspace. This is also the specification + of a devworkspace template. properties: commands: - description: Predefined, ready-to-use, workspace-related commands + description: Predefined, ready-to-use, devworkspace-related commands items: oneOf: - required: @@ -80,14 +80,14 @@ spec: properties: apply: description: "Command that consists in applying a given - component definition, typically bound to a workspace event. - \n For example, when an `apply` command is bound to a - `preStart` event, and references a `container` component, + component definition, typically bound to a devworkspace + event. \n For example, when an `apply` command is bound + to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in - the workspace POD, unless the component has its `dedicatedPod` + the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`. \n When no `apply` command exist for a given component, it is assumed the component will - be applied at workspace start by default." + be applied at devworkspace start by default." properties: attributes: additionalProperties: @@ -130,7 +130,7 @@ spec: - id type: object commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -442,7 +442,7 @@ spec: type: object type: array components: - description: List of the workspace components, such as editor + description: List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components items: oneOf: @@ -470,7 +470,7 @@ spec: - Custom type: string container: - description: Allows adding and configuring workspace-related + description: Allows adding and configuring devworkspace-related containers properties: args: @@ -516,12 +516,12 @@ spec: network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by K8S + of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside the main - workspace POD, on a local address. \n Default + devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -644,10 +644,10 @@ spec: - name type: object kubernetes: - description: Allows importing into the workspace the Kubernetes - resources defined in a given manifest. For example this - allows reusing the Kubernetes definitions used to deploy - some runtime components in production. + description: Allows importing into the devworkspace the + Kubernetes resources defined in a given manifest. For + example this allows reusing the Kubernetes definitions + used to deploy some runtime components in production. oneOf: - required: - uri @@ -673,12 +673,12 @@ spec: network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by K8S + of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside the main - workspace POD, on a local address. \n Default + devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -741,10 +741,10 @@ spec: - name type: object openshift: - description: Allows importing into the workspace the OpenShift - resources defined in a given manifest. For example this - allows reusing the OpenShift definitions used to deploy - some runtime components in production. + description: Allows importing into the devworkspace the + OpenShift resources defined in a given manifest. For example + this allows reusing the OpenShift definitions used to + deploy some runtime components in production. oneOf: - required: - uri @@ -770,12 +770,12 @@ spec: network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by K8S + of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside the main - workspace POD, on a local address. \n Default + devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -873,15 +873,15 @@ spec: apply: description: "Command that consists in applying a given component definition, typically bound - to a workspace event. \n For example, when an - `apply` command is bound to a `preStart` event, - and references a `container` component, it will - start the container as a K8S initContainer in - the workspace POD, unless the component has - its `dedicatedPod` field set to `true`. \n When - no `apply` command exist for a given component, - it is assumed the component will be applied - at workspace start by default." + to a devworkspace event. \n For example, when + an `apply` command is bound to a `preStart` + event, and references a `container` component, + it will start the container as a K8S initContainer + in the devworkspace POD, unless the component + has its `dedicatedPod` field set to `true`. + \n When no `apply` command exist for a given + component, it is assumed the component will + be applied at devworkspace start by default." properties: attributes: additionalProperties: @@ -927,7 +927,7 @@ spec: - id type: object commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -1331,13 +1331,13 @@ spec: typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed - internally outside of the main workspace + internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only - be accessible inside the main workspace + be accessible inside the main devworkspace POD, on a local address. \n Default value is `public`" enum: @@ -1474,13 +1474,13 @@ spec: typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed - internally outside of the main workspace + internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only - be accessible inside the main workspace + be accessible inside the main devworkspace POD, on a local address. \n Default value is `public`" enum: @@ -1579,13 +1579,13 @@ spec: typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed - internally outside of the main workspace + internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only - be accessible inside the main workspace + be accessible inside the main devworkspace POD, on a local address. \n Default value is `public`" enum: @@ -1736,7 +1736,7 @@ spec: properties: postStart: description: Names of commands that should be executed after - the workspace is completely started. In the case of Che-Theia, + the devworkspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user @@ -1746,27 +1746,27 @@ spec: type: array postStop: description: Names of commands that should be executed after - stopping the workspace. + stopping the devworkspace. items: type: string type: array preStart: description: Names of commands that should be executed before - the workspace start. Kubernetes-wise, these commands would - typically be executed in init containers of the workspace + the devdevworkspace start. Kubernetes-wise, these commands + would typically be executed in init containers of the devworkspace POD. items: type: string type: array preStop: description: Names of commands that should be executed before - stopping the workspace. + stopping the devworkspace. items: type: string type: array type: object parent: - description: Parent workspace template + description: Parent devworkspace template oneOf: - required: - uri @@ -1796,15 +1796,15 @@ spec: properties: apply: description: "Command that consists in applying a given - component definition, typically bound to a workspace + component definition, typically bound to a devworkspace event. \n For example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer - in the workspace POD, unless the component has its - `dedicatedPod` field set to `true`. \n When no `apply` - command exist for a given component, it is assumed - the component will be applied at workspace start by - default." + in the devworkspace POD, unless the component has + its `dedicatedPod` field set to `true`. \n When no + `apply` command exist for a given component, it is + assumed the component will be applied at devworkspace + start by default." properties: attributes: additionalProperties: @@ -1849,7 +1849,7 @@ spec: - id type: object commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -2200,7 +2200,7 @@ spec: - Custom type: string container: - description: Allows adding and configuring workspace-related + description: Allows adding and configuring devworkspace-related containers properties: args: @@ -2247,12 +2247,12 @@ spec: a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside of the main - workspace POD, typically by K8S services, + devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local address. + the main devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -2380,8 +2380,8 @@ spec: - name type: object kubernetes: - description: Allows importing into the workspace the - Kubernetes resources defined in a given manifest. + description: Allows importing into the devworkspace + the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production. oneOf: @@ -2410,12 +2410,12 @@ spec: a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside of the main - workspace POD, typically by K8S services, + devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local address. + the main devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -2480,9 +2480,9 @@ spec: - name type: object openshift: - description: Allows importing into the workspace the - OpenShift resources defined in a given manifest. For - example this allows reusing the OpenShift definitions + description: Allows importing into the devworkspace + the OpenShift resources defined in a given manifest. + For example this allows reusing the OpenShift definitions used to deploy some runtime components in production. oneOf: - required: @@ -2510,12 +2510,12 @@ spec: a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside of the main - workspace POD, typically by K8S services, + devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local address. + the main devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -2616,15 +2616,15 @@ spec: apply: description: "Command that consists in applying a given component definition, typically - bound to a workspace event. \n For example, + bound to a devworkspace event. \n For example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer - in the workspace POD, unless the component + in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`. \n When no `apply` command exist for a given component, it is assumed the component will - be applied at workspace start by default." + be applied at devworkspace start by default." properties: attributes: additionalProperties: @@ -2670,7 +2670,7 @@ spec: - id type: object commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -3085,15 +3085,16 @@ spec: through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally - outside of the main workspace + outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local - address. \n Default value is `public`" + the main devworkspace POD, on + a local address. \n Default value + is `public`" enum: - public - internal @@ -3235,15 +3236,16 @@ spec: through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally - outside of the main workspace + outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local - address. \n Default value is `public`" + the main devworkspace POD, on + a local address. \n Default value + is `public`" enum: - public - internal @@ -3347,15 +3349,16 @@ spec: through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally - outside of the main workspace + outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local - address. \n Default value is `public`" + the main devworkspace POD, on + a local address. \n Default value + is `public`" enum: - public - internal @@ -3792,8 +3795,8 @@ spec: type: string type: object projects: - description: Projects worked on in the workspace, containing names - and sources locations + description: Projects worked on in the devworkspace, containing + names and sources locations items: oneOf: - required: @@ -4053,8 +4056,8 @@ spec: description: Conditions represent the latest available observations of an object's state items: - description: WorkspaceCondition contains details for the current - condition of this workspace. + description: DevWorkspaceCondition contains details for the current + condition of this devworkspace. properties: lastTransitionTime: description: Last time the condition transitioned from one status @@ -4081,6 +4084,9 @@ spec: - type type: object type: array + devWorkspaceId: + description: Id of the devworkspace + type: string ideUrl: description: URL at which the Worksace Editor can be joined type: string @@ -4090,26 +4096,23 @@ spec: type: string phase: type: string - workspaceId: - description: Id of the workspace - type: string required: - - workspaceId + - devWorkspaceId type: object type: object served: true storage: false - additionalPrinterColumns: - - JSONPath: .status.workspaceId - description: The workspace's unique id - name: Workspace ID + - JSONPath: .status.devWorkspaceId + description: The devworkspace's unique id + name: DevWorkspace ID type: string - JSONPath: .status.phase - description: The current workspace startup phase + description: The current devworkspace startup phase name: Phase type: string - JSONPath: .status.message - description: Additional information about the workspace + description: Additional information about the devworkspace name: Info type: string name: v1alpha2 @@ -4137,11 +4140,11 @@ spec: started: type: boolean template: - description: Structure of the workspace. This is also the specification - of a workspace template. + description: Structure of the devworkspace. This is also the specification + of a devworkspace template. properties: commands: - description: Predefined, ready-to-use, workspace-related commands + description: Predefined, ready-to-use, devworkspace-related commands items: oneOf: - required: @@ -4155,14 +4158,14 @@ spec: properties: apply: description: "Command that consists in applying a given - component definition, typically bound to a workspace event. - \n For example, when an `apply` command is bound to a - `preStart` event, and references a `container` component, + component definition, typically bound to a devworkspace + event. \n For example, when an `apply` command is bound + to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in - the workspace POD, unless the component has its `dedicatedPod` + the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`. \n When no `apply` command exist for a given component, it is assumed the component will - be applied at workspace start by default." + be applied at devworkspace start by default." properties: component: description: Describes component that will be applied @@ -4199,7 +4202,7 @@ spec: type: object x-kubernetes-preserve-unknown-fields: true commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -4375,7 +4378,7 @@ spec: type: object type: array components: - description: List of the workspace components, such as editor + description: List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components items: oneOf: @@ -4408,7 +4411,7 @@ spec: - Custom type: string container: - description: Allows adding and configuring workspace-related + description: Allows adding and configuring devworkspace-related containers properties: args: @@ -4457,12 +4460,12 @@ spec: network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by K8S + of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside the main - workspace POD, on a local address. \n Default + devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -4600,10 +4603,10 @@ spec: - embeddedResource type: object kubernetes: - description: Allows importing into the workspace the Kubernetes - resources defined in a given manifest. For example this - allows reusing the Kubernetes definitions used to deploy - some runtime components in production. + description: Allows importing into the devworkspace the + Kubernetes resources defined in a given manifest. For + example this allows reusing the Kubernetes definitions + used to deploy some runtime components in production. oneOf: - required: - uri @@ -4628,12 +4631,12 @@ spec: network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by K8S + of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside the main - workspace POD, on a local address. \n Default + devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -4709,10 +4712,10 @@ spec: pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the workspace the OpenShift - resources defined in a given manifest. For example this - allows reusing the OpenShift definitions used to deploy - some runtime components in production. + description: Allows importing into the devworkspace the + OpenShift resources defined in a given manifest. For example + this allows reusing the OpenShift definitions used to + deploy some runtime components in production. oneOf: - required: - uri @@ -4737,12 +4740,12 @@ spec: network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by K8S + of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside the main - workspace POD, on a local address. \n Default + devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -4839,15 +4842,15 @@ spec: apply: description: "Command that consists in applying a given component definition, typically bound - to a workspace event. \n For example, when an - `apply` command is bound to a `preStart` event, - and references a `container` component, it will - start the container as a K8S initContainer in - the workspace POD, unless the component has - its `dedicatedPod` field set to `true`. \n When - no `apply` command exist for a given component, - it is assumed the component will be applied - at workspace start by default." + to a devworkspace event. \n For example, when + an `apply` command is bound to a `preStart` + event, and references a `container` component, + it will start the container as a K8S initContainer + in the devworkspace POD, unless the component + has its `dedicatedPod` field set to `true`. + \n When no `apply` command exist for a given + component, it is assumed the component will + be applied at devworkspace start by default." properties: component: description: Describes component that will @@ -4883,7 +4886,7 @@ spec: type: object x-kubernetes-preserve-unknown-fields: true commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -5042,7 +5045,7 @@ spec: - Volume type: string container: - description: Allows adding and configuring workspace-related + description: Allows adding and configuring devworkspace-related containers properties: args: @@ -5094,13 +5097,13 @@ spec: typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed - internally outside of the main workspace + internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only - be accessible inside the main workspace + be accessible inside the main devworkspace POD, on a local address. \n Default value is `public`" enum: @@ -5224,7 +5227,7 @@ spec: type: array type: object kubernetes: - description: Allows importing into the workspace + description: Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime @@ -5255,13 +5258,13 @@ spec: typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed - internally outside of the main workspace + internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only - be accessible inside the main workspace + be accessible inside the main devworkspace POD, on a local address. \n Default value is `public`" enum: @@ -5344,7 +5347,7 @@ spec: pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the workspace + description: Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components @@ -5375,13 +5378,13 @@ spec: typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed - internally outside of the main workspace + internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only - be accessible inside the main workspace + be accessible inside the main devworkspace POD, on a local address. \n Default value is `public`" enum: @@ -5522,7 +5525,7 @@ spec: properties: postStart: description: IDs of commands that should be executed after - the workspace is completely started. In the case of Che-Theia, + the devworkspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user @@ -5532,27 +5535,27 @@ spec: type: array postStop: description: IDs of commands that should be executed after - stopping the workspace. + stopping the devworkspace. items: type: string type: array preStart: description: IDs of commands that should be executed before - the workspace start. Kubernetes-wise, these commands would - typically be executed in init containers of the workspace + the devworkspace start. Kubernetes-wise, these commands + would typically be executed in init containers of the devworkspace POD. items: type: string type: array preStop: description: IDs of commands that should be executed before - stopping the workspace. + stopping the devworkspace. items: type: string type: array type: object parent: - description: Parent workspace template + description: Parent devworkspace template oneOf: - required: - uri @@ -5576,15 +5579,15 @@ spec: properties: apply: description: "Command that consists in applying a given - component definition, typically bound to a workspace + component definition, typically bound to a devworkspace event. \n For example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer - in the workspace POD, unless the component has its - `dedicatedPod` field set to `true`. \n When no `apply` - command exist for a given component, it is assumed - the component will be applied at workspace start by - default." + in the devworkspace POD, unless the component has + its `dedicatedPod` field set to `true`. \n When no + `apply` command exist for a given component, it is + assumed the component will be applied at devworkspace + start by default." properties: component: description: Describes component that will be applied @@ -5619,7 +5622,7 @@ spec: type: object x-kubernetes-preserve-unknown-fields: true commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -5778,7 +5781,7 @@ spec: - Plugin type: string container: - description: Allows adding and configuring workspace-related + description: Allows adding and configuring devworkspace-related containers properties: args: @@ -5828,12 +5831,12 @@ spec: a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside of the main - workspace POD, typically by K8S services, + devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local address. + the main devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -5951,8 +5954,8 @@ spec: type: array type: object kubernetes: - description: Allows importing into the workspace the - Kubernetes resources defined in a given manifest. + description: Allows importing into the devworkspace + the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production. oneOf: @@ -5980,12 +5983,12 @@ spec: a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside of the main - workspace POD, typically by K8S services, + devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local address. + the main devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -6062,9 +6065,9 @@ spec: pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the workspace the - OpenShift resources defined in a given manifest. For - example this allows reusing the OpenShift definitions + description: Allows importing into the devworkspace + the OpenShift resources defined in a given manifest. + For example this allows reusing the OpenShift definitions used to deploy some runtime components in production. oneOf: - required: @@ -6091,12 +6094,12 @@ spec: a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside of the main - workspace POD, typically by K8S services, + devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local address. + the main devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -6196,15 +6199,15 @@ spec: apply: description: "Command that consists in applying a given component definition, typically - bound to a workspace event. \n For example, + bound to a devworkspace event. \n For example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer - in the workspace POD, unless the component + in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`. \n When no `apply` command exist for a given component, it is assumed the component will - be applied at workspace start by default." + be applied at devworkspace start by default." properties: component: description: Describes component that @@ -6240,7 +6243,7 @@ spec: type: object x-kubernetes-preserve-unknown-fields: true commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -6405,7 +6408,7 @@ spec: type: string container: description: Allows adding and configuring - workspace-related containers + devworkspace-related containers properties: args: description: "The arguments to supply @@ -6459,15 +6462,16 @@ spec: through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally - outside of the main workspace + outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local - address. \n Default value is `public`" + the main devworkspace POD, on + a local address. \n Default value + is `public`" enum: - public - internal @@ -6597,7 +6601,7 @@ spec: type: array type: object kubernetes: - description: Allows importing into the workspace + description: Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy @@ -6629,15 +6633,16 @@ spec: through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally - outside of the main workspace + outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local - address. \n Default value is `public`" + the main devworkspace POD, on + a local address. \n Default value + is `public`" enum: - public - internal @@ -6723,7 +6728,7 @@ spec: pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the workspace + description: Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy @@ -6755,15 +6760,16 @@ spec: through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally - outside of the main workspace + outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local - address. \n Default value is `public`" + the main devworkspace POD, on + a local address. \n Default value + is `public`" enum: - public - internal @@ -7147,8 +7153,8 @@ spec: type: string type: object projects: - description: Projects worked on in the workspace, containing names - and sources locations + description: Projects worked on in the devworkspace, containing + names and sources locations items: oneOf: - required: @@ -7410,8 +7416,8 @@ spec: description: Conditions represent the latest available observations of an object's state items: - description: WorkspaceCondition contains details for the current - condition of this workspace. + description: DevWorkspaceCondition contains details for the current + condition of this devworkspace. properties: lastTransitionTime: description: Last time the condition transitioned from one status @@ -7438,8 +7444,11 @@ spec: - type type: object type: array + devWorkspaceId: + description: Id of the DevWorkspace + type: string ideUrl: - description: URL at which the Worksace Editor can be joined + description: URL at which the DevWorkspace Editor can be joined type: string message: description: Message is a short user-readable message giving additional @@ -7447,11 +7456,8 @@ spec: type: string phase: type: string - workspaceId: - description: Id of the workspace - type: string required: - - workspaceId + - devWorkspaceId type: object type: object served: true diff --git a/crds/workspace.devfile.io_devworkspaces.yaml b/crds/workspace.devfile.io_devworkspaces.yaml index 6144da16d..af9c46702 100644 --- a/crds/workspace.devfile.io_devworkspaces.yaml +++ b/crds/workspace.devfile.io_devworkspaces.yaml @@ -17,15 +17,15 @@ spec: scope: Namespaced versions: - additionalPrinterColumns: - - description: The workspace's unique id - jsonPath: .status.workspaceId - name: Workspace ID + - description: The devworkspace's unique id + jsonPath: .status.devWorkspaceId + name: DevWorkspace ID type: string - - description: The current workspace startup phase + - description: The current devworkspace startup phase jsonPath: .status.phase name: Phase type: string - - description: Url endpoint for accessing workspace + - description: Url endpoint for accessing devworkspace jsonPath: .status.ideUrl name: URL type: string @@ -54,11 +54,11 @@ spec: started: type: boolean template: - description: Structure of the workspace. This is also the specification - of a workspace template. + description: Structure of the devworkspace. This is also the specification + of a devworkspace template. properties: commands: - description: Predefined, ready-to-use, workspace-related commands + description: Predefined, ready-to-use, devworkspace-related commands items: oneOf: - required: @@ -76,14 +76,14 @@ spec: properties: apply: description: "Command that consists in applying a given - component definition, typically bound to a workspace event. - \n For example, when an `apply` command is bound to a - `preStart` event, and references a `container` component, + component definition, typically bound to a devworkspace + event. \n For example, when an `apply` command is bound + to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in - the workspace POD, unless the component has its `dedicatedPod` + the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`. \n When no `apply` command exist for a given component, it is assumed the component will - be applied at workspace start by default." + be applied at devworkspace start by default." properties: attributes: additionalProperties: @@ -126,7 +126,7 @@ spec: - id type: object commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -438,7 +438,7 @@ spec: type: object type: array components: - description: List of the workspace components, such as editor + description: List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components items: oneOf: @@ -466,7 +466,7 @@ spec: - Custom type: string container: - description: Allows adding and configuring workspace-related + description: Allows adding and configuring devworkspace-related containers properties: args: @@ -512,12 +512,12 @@ spec: network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by K8S + of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside the main - workspace POD, on a local address. \n Default + devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -640,10 +640,10 @@ spec: - name type: object kubernetes: - description: Allows importing into the workspace the Kubernetes - resources defined in a given manifest. For example this - allows reusing the Kubernetes definitions used to deploy - some runtime components in production. + description: Allows importing into the devworkspace the + Kubernetes resources defined in a given manifest. For + example this allows reusing the Kubernetes definitions + used to deploy some runtime components in production. oneOf: - required: - uri @@ -669,12 +669,12 @@ spec: network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by K8S + of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside the main - workspace POD, on a local address. \n Default + devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -737,10 +737,10 @@ spec: - name type: object openshift: - description: Allows importing into the workspace the OpenShift - resources defined in a given manifest. For example this - allows reusing the OpenShift definitions used to deploy - some runtime components in production. + description: Allows importing into the devworkspace the + OpenShift resources defined in a given manifest. For example + this allows reusing the OpenShift definitions used to + deploy some runtime components in production. oneOf: - required: - uri @@ -766,12 +766,12 @@ spec: network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by K8S + of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside the main - workspace POD, on a local address. \n Default + devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -869,15 +869,15 @@ spec: apply: description: "Command that consists in applying a given component definition, typically bound - to a workspace event. \n For example, when an - `apply` command is bound to a `preStart` event, - and references a `container` component, it will - start the container as a K8S initContainer in - the workspace POD, unless the component has - its `dedicatedPod` field set to `true`. \n When - no `apply` command exist for a given component, - it is assumed the component will be applied - at workspace start by default." + to a devworkspace event. \n For example, when + an `apply` command is bound to a `preStart` + event, and references a `container` component, + it will start the container as a K8S initContainer + in the devworkspace POD, unless the component + has its `dedicatedPod` field set to `true`. + \n When no `apply` command exist for a given + component, it is assumed the component will + be applied at devworkspace start by default." properties: attributes: additionalProperties: @@ -923,7 +923,7 @@ spec: - id type: object commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -1327,13 +1327,13 @@ spec: typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed - internally outside of the main workspace + internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only - be accessible inside the main workspace + be accessible inside the main devworkspace POD, on a local address. \n Default value is `public`" enum: @@ -1470,13 +1470,13 @@ spec: typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed - internally outside of the main workspace + internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only - be accessible inside the main workspace + be accessible inside the main devworkspace POD, on a local address. \n Default value is `public`" enum: @@ -1575,13 +1575,13 @@ spec: typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed - internally outside of the main workspace + internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only - be accessible inside the main workspace + be accessible inside the main devworkspace POD, on a local address. \n Default value is `public`" enum: @@ -1732,7 +1732,7 @@ spec: properties: postStart: description: Names of commands that should be executed after - the workspace is completely started. In the case of Che-Theia, + the devworkspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user @@ -1742,27 +1742,27 @@ spec: type: array postStop: description: Names of commands that should be executed after - stopping the workspace. + stopping the devworkspace. items: type: string type: array preStart: description: Names of commands that should be executed before - the workspace start. Kubernetes-wise, these commands would - typically be executed in init containers of the workspace + the devdevworkspace start. Kubernetes-wise, these commands + would typically be executed in init containers of the devworkspace POD. items: type: string type: array preStop: description: Names of commands that should be executed before - stopping the workspace. + stopping the devworkspace. items: type: string type: array type: object parent: - description: Parent workspace template + description: Parent devworkspace template oneOf: - required: - uri @@ -1792,15 +1792,15 @@ spec: properties: apply: description: "Command that consists in applying a given - component definition, typically bound to a workspace + component definition, typically bound to a devworkspace event. \n For example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer - in the workspace POD, unless the component has its - `dedicatedPod` field set to `true`. \n When no `apply` - command exist for a given component, it is assumed - the component will be applied at workspace start by - default." + in the devworkspace POD, unless the component has + its `dedicatedPod` field set to `true`. \n When no + `apply` command exist for a given component, it is + assumed the component will be applied at devworkspace + start by default." properties: attributes: additionalProperties: @@ -1845,7 +1845,7 @@ spec: - id type: object commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -2196,7 +2196,7 @@ spec: - Custom type: string container: - description: Allows adding and configuring workspace-related + description: Allows adding and configuring devworkspace-related containers properties: args: @@ -2243,12 +2243,12 @@ spec: a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside of the main - workspace POD, typically by K8S services, + devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local address. + the main devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -2376,8 +2376,8 @@ spec: - name type: object kubernetes: - description: Allows importing into the workspace the - Kubernetes resources defined in a given manifest. + description: Allows importing into the devworkspace + the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production. oneOf: @@ -2406,12 +2406,12 @@ spec: a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside of the main - workspace POD, typically by K8S services, + devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local address. + the main devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -2476,9 +2476,9 @@ spec: - name type: object openshift: - description: Allows importing into the workspace the - OpenShift resources defined in a given manifest. For - example this allows reusing the OpenShift definitions + description: Allows importing into the devworkspace + the OpenShift resources defined in a given manifest. + For example this allows reusing the OpenShift definitions used to deploy some runtime components in production. oneOf: - required: @@ -2506,12 +2506,12 @@ spec: a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside of the main - workspace POD, typically by K8S services, + devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local address. + the main devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -2612,15 +2612,15 @@ spec: apply: description: "Command that consists in applying a given component definition, typically - bound to a workspace event. \n For example, + bound to a devworkspace event. \n For example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer - in the workspace POD, unless the component + in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`. \n When no `apply` command exist for a given component, it is assumed the component will - be applied at workspace start by default." + be applied at devworkspace start by default." properties: attributes: additionalProperties: @@ -2666,7 +2666,7 @@ spec: - id type: object commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -3081,15 +3081,16 @@ spec: through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally - outside of the main workspace + outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local - address. \n Default value is `public`" + the main devworkspace POD, on + a local address. \n Default value + is `public`" enum: - public - internal @@ -3231,15 +3232,16 @@ spec: through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally - outside of the main workspace + outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local - address. \n Default value is `public`" + the main devworkspace POD, on + a local address. \n Default value + is `public`" enum: - public - internal @@ -3343,15 +3345,16 @@ spec: through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally - outside of the main workspace + outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local - address. \n Default value is `public`" + the main devworkspace POD, on + a local address. \n Default value + is `public`" enum: - public - internal @@ -3788,8 +3791,8 @@ spec: type: string type: object projects: - description: Projects worked on in the workspace, containing names - and sources locations + description: Projects worked on in the devworkspace, containing + names and sources locations items: oneOf: - required: @@ -4049,8 +4052,8 @@ spec: description: Conditions represent the latest available observations of an object's state items: - description: WorkspaceCondition contains details for the current - condition of this workspace. + description: DevWorkspaceCondition contains details for the current + condition of this devworkspace. properties: lastTransitionTime: description: Last time the condition transitioned from one status @@ -4077,6 +4080,9 @@ spec: - type type: object type: array + devWorkspaceId: + description: Id of the devworkspace + type: string ideUrl: description: URL at which the Worksace Editor can be joined type: string @@ -4086,11 +4092,8 @@ spec: type: string phase: type: string - workspaceId: - description: Id of the workspace - type: string required: - - workspaceId + - devWorkspaceId type: object type: object served: true @@ -4098,15 +4101,15 @@ spec: subresources: status: {} - additionalPrinterColumns: - - description: The workspace's unique id - jsonPath: .status.workspaceId - name: Workspace ID + - description: The devworkspace's unique id + jsonPath: .status.devWorkspaceId + name: DevWorkspace ID type: string - - description: The current workspace startup phase + - description: The current devworkspace startup phase jsonPath: .status.phase name: Phase type: string - - description: Additional information about the workspace + - description: Additional information about the devworkspace jsonPath: .status.message name: Info type: string @@ -4135,11 +4138,11 @@ spec: started: type: boolean template: - description: Structure of the workspace. This is also the specification - of a workspace template. + description: Structure of the devworkspace. This is also the specification + of a devworkspace template. properties: commands: - description: Predefined, ready-to-use, workspace-related commands + description: Predefined, ready-to-use, devworkspace-related commands items: oneOf: - required: @@ -4153,14 +4156,14 @@ spec: properties: apply: description: "Command that consists in applying a given - component definition, typically bound to a workspace event. - \n For example, when an `apply` command is bound to a - `preStart` event, and references a `container` component, + component definition, typically bound to a devworkspace + event. \n For example, when an `apply` command is bound + to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in - the workspace POD, unless the component has its `dedicatedPod` + the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`. \n When no `apply` command exist for a given component, it is assumed the component will - be applied at workspace start by default." + be applied at devworkspace start by default." properties: component: description: Describes component that will be applied @@ -4197,7 +4200,7 @@ spec: type: object x-kubernetes-preserve-unknown-fields: true commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -4373,7 +4376,7 @@ spec: type: object type: array components: - description: List of the workspace components, such as editor + description: List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components items: oneOf: @@ -4406,7 +4409,7 @@ spec: - Custom type: string container: - description: Allows adding and configuring workspace-related + description: Allows adding and configuring devworkspace-related containers properties: args: @@ -4456,12 +4459,12 @@ spec: network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by K8S + of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside the main - workspace POD, on a local address. \n Default + devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -4601,10 +4604,10 @@ spec: - embeddedResource type: object kubernetes: - description: Allows importing into the workspace the Kubernetes - resources defined in a given manifest. For example this - allows reusing the Kubernetes definitions used to deploy - some runtime components in production. + description: Allows importing into the devworkspace the + Kubernetes resources defined in a given manifest. For + example this allows reusing the Kubernetes definitions + used to deploy some runtime components in production. oneOf: - required: - uri @@ -4630,12 +4633,12 @@ spec: network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by K8S + of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside the main - workspace POD, on a local address. \n Default + devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -4712,10 +4715,10 @@ spec: pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the workspace the OpenShift - resources defined in a given manifest. For example this - allows reusing the OpenShift definitions used to deploy - some runtime components in production. + description: Allows importing into the devworkspace the + OpenShift resources defined in a given manifest. For example + this allows reusing the OpenShift definitions used to + deploy some runtime components in production. oneOf: - required: - uri @@ -4741,12 +4744,12 @@ spec: network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by K8S + of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside the main - workspace POD, on a local address. \n Default + devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -4844,15 +4847,15 @@ spec: apply: description: "Command that consists in applying a given component definition, typically bound - to a workspace event. \n For example, when an - `apply` command is bound to a `preStart` event, - and references a `container` component, it will - start the container as a K8S initContainer in - the workspace POD, unless the component has - its `dedicatedPod` field set to `true`. \n When - no `apply` command exist for a given component, - it is assumed the component will be applied - at workspace start by default." + to a devworkspace event. \n For example, when + an `apply` command is bound to a `preStart` + event, and references a `container` component, + it will start the container as a K8S initContainer + in the devworkspace POD, unless the component + has its `dedicatedPod` field set to `true`. + \n When no `apply` command exist for a given + component, it is assumed the component will + be applied at devworkspace start by default." properties: component: description: Describes component that will @@ -4888,7 +4891,7 @@ spec: type: object x-kubernetes-preserve-unknown-fields: true commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -5047,7 +5050,7 @@ spec: - Volume type: string container: - description: Allows adding and configuring workspace-related + description: Allows adding and configuring devworkspace-related containers properties: args: @@ -5099,13 +5102,13 @@ spec: typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed - internally outside of the main workspace + internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only - be accessible inside the main workspace + be accessible inside the main devworkspace POD, on a local address. \n Default value is `public`" enum: @@ -5229,7 +5232,7 @@ spec: type: array type: object kubernetes: - description: Allows importing into the workspace + description: Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime @@ -5260,13 +5263,13 @@ spec: typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed - internally outside of the main workspace + internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only - be accessible inside the main workspace + be accessible inside the main devworkspace POD, on a local address. \n Default value is `public`" enum: @@ -5349,7 +5352,7 @@ spec: pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the workspace + description: Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components @@ -5380,13 +5383,13 @@ spec: typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed - internally outside of the main workspace + internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only - be accessible inside the main workspace + be accessible inside the main devworkspace POD, on a local address. \n Default value is `public`" enum: @@ -5527,7 +5530,7 @@ spec: properties: postStart: description: IDs of commands that should be executed after - the workspace is completely started. In the case of Che-Theia, + the devworkspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user @@ -5537,27 +5540,27 @@ spec: type: array postStop: description: IDs of commands that should be executed after - stopping the workspace. + stopping the devworkspace. items: type: string type: array preStart: description: IDs of commands that should be executed before - the workspace start. Kubernetes-wise, these commands would - typically be executed in init containers of the workspace + the devworkspace start. Kubernetes-wise, these commands + would typically be executed in init containers of the devworkspace POD. items: type: string type: array preStop: description: IDs of commands that should be executed before - stopping the workspace. + stopping the devworkspace. items: type: string type: array type: object parent: - description: Parent workspace template + description: Parent devworkspace template oneOf: - required: - uri @@ -5581,15 +5584,15 @@ spec: properties: apply: description: "Command that consists in applying a given - component definition, typically bound to a workspace + component definition, typically bound to a devworkspace event. \n For example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer - in the workspace POD, unless the component has its - `dedicatedPod` field set to `true`. \n When no `apply` - command exist for a given component, it is assumed - the component will be applied at workspace start by - default." + in the devworkspace POD, unless the component has + its `dedicatedPod` field set to `true`. \n When no + `apply` command exist for a given component, it is + assumed the component will be applied at devworkspace + start by default." properties: component: description: Describes component that will be applied @@ -5624,7 +5627,7 @@ spec: type: object x-kubernetes-preserve-unknown-fields: true commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -5783,7 +5786,7 @@ spec: - Plugin type: string container: - description: Allows adding and configuring workspace-related + description: Allows adding and configuring devworkspace-related containers properties: args: @@ -5833,12 +5836,12 @@ spec: a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside of the main - workspace POD, typically by K8S services, + devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local address. + the main devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -5956,8 +5959,8 @@ spec: type: array type: object kubernetes: - description: Allows importing into the workspace the - Kubernetes resources defined in a given manifest. + description: Allows importing into the devworkspace + the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production. oneOf: @@ -5985,12 +5988,12 @@ spec: a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside of the main - workspace POD, typically by K8S services, + devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local address. + the main devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -6067,9 +6070,9 @@ spec: pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the workspace the - OpenShift resources defined in a given manifest. For - example this allows reusing the OpenShift definitions + description: Allows importing into the devworkspace + the OpenShift resources defined in a given manifest. + For example this allows reusing the OpenShift definitions used to deploy some runtime components in production. oneOf: - required: @@ -6096,12 +6099,12 @@ spec: a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside of the main - workspace POD, typically by K8S services, + devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local address. + the main devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -6201,15 +6204,15 @@ spec: apply: description: "Command that consists in applying a given component definition, typically - bound to a workspace event. \n For example, + bound to a devworkspace event. \n For example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer - in the workspace POD, unless the component + in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`. \n When no `apply` command exist for a given component, it is assumed the component will - be applied at workspace start by default." + be applied at devworkspace start by default." properties: component: description: Describes component that @@ -6245,7 +6248,7 @@ spec: type: object x-kubernetes-preserve-unknown-fields: true commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -6410,7 +6413,7 @@ spec: type: string container: description: Allows adding and configuring - workspace-related containers + devworkspace-related containers properties: args: description: "The arguments to supply @@ -6464,15 +6467,16 @@ spec: through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally - outside of the main workspace + outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local - address. \n Default value is `public`" + the main devworkspace POD, on + a local address. \n Default value + is `public`" enum: - public - internal @@ -6602,7 +6606,7 @@ spec: type: array type: object kubernetes: - description: Allows importing into the workspace + description: Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy @@ -6634,15 +6638,16 @@ spec: through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally - outside of the main workspace + outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local - address. \n Default value is `public`" + the main devworkspace POD, on + a local address. \n Default value + is `public`" enum: - public - internal @@ -6728,7 +6733,7 @@ spec: pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the workspace + description: Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy @@ -6760,15 +6765,16 @@ spec: through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally - outside of the main workspace + outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local - address. \n Default value is `public`" + the main devworkspace POD, on + a local address. \n Default value + is `public`" enum: - public - internal @@ -7152,8 +7158,8 @@ spec: type: string type: object projects: - description: Projects worked on in the workspace, containing names - and sources locations + description: Projects worked on in the devworkspace, containing + names and sources locations items: oneOf: - required: @@ -7415,8 +7421,8 @@ spec: description: Conditions represent the latest available observations of an object's state items: - description: WorkspaceCondition contains details for the current - condition of this workspace. + description: DevWorkspaceCondition contains details for the current + condition of this devworkspace. properties: lastTransitionTime: description: Last time the condition transitioned from one status @@ -7443,8 +7449,11 @@ spec: - type type: object type: array + devWorkspaceId: + description: Id of the DevWorkspace + type: string ideUrl: - description: URL at which the Worksace Editor can be joined + description: URL at which the DevWorkspace Editor can be joined type: string message: description: Message is a short user-readable message giving additional @@ -7452,11 +7461,8 @@ spec: type: string phase: type: string - workspaceId: - description: Id of the workspace - type: string required: - - workspaceId + - devWorkspaceId type: object type: object served: true diff --git a/crds/workspace.devfile.io_devworkspacetemplates.v1beta1.yaml b/crds/workspace.devfile.io_devworkspacetemplates.v1beta1.yaml index 795c223f0..8b124c9fd 100644 --- a/crds/workspace.devfile.io_devworkspacetemplates.v1beta1.yaml +++ b/crds/workspace.devfile.io_devworkspacetemplates.v1beta1.yaml @@ -37,11 +37,11 @@ spec: metadata: type: object spec: - description: Structure of the workspace. This is also the specification - of a workspace template. + description: Structure of the devworkspace. This is also the specification + of a devworkspace template. properties: commands: - description: Predefined, ready-to-use, workspace-related commands + description: Predefined, ready-to-use, devworkspace-related commands items: oneOf: - required: @@ -59,13 +59,14 @@ spec: properties: apply: description: "Command that consists in applying a given component - definition, typically bound to a workspace event. \n For example, - when an `apply` command is bound to a `preStart` event, and - references a `container` component, it will start the container - as a K8S initContainer in the workspace POD, unless the component - has its `dedicatedPod` field set to `true`. \n When no `apply` - command exist for a given component, it is assumed the component - will be applied at workspace start by default." + definition, typically bound to a devworkspace event. \n For + example, when an `apply` command is bound to a `preStart` + event, and references a `container` component, it will start + the container as a K8S initContainer in the devworkspace POD, + unless the component has its `dedicatedPod` field set to `true`. + \n When no `apply` command exist for a given component, it + is assumed the component will be applied at devworkspace start + by default." properties: attributes: additionalProperties: @@ -107,7 +108,7 @@ spec: - id type: object commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -410,7 +411,7 @@ spec: type: object type: array components: - description: List of the workspace components, such as editor and + description: List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components items: oneOf: @@ -438,7 +439,7 @@ spec: - Custom type: string container: - description: Allows adding and configuring workspace-related + description: Allows adding and configuring devworkspace-related containers properties: args: @@ -480,13 +481,13 @@ spec: the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will - be exposed internally outside of the main workspace + be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local address. \n Default - value is `public`" + the main devworkspace POD, on a local address. \n + Default value is `public`" enum: - public - internal @@ -606,7 +607,7 @@ spec: - name type: object kubernetes: - description: Allows importing into the workspace the Kubernetes + description: Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production. @@ -633,13 +634,13 @@ spec: the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will - be exposed internally outside of the main workspace + be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local address. \n Default - value is `public`" + the main devworkspace POD, on a local address. \n + Default value is `public`" enum: - public - internal @@ -699,7 +700,7 @@ spec: - name type: object openshift: - description: Allows importing into the workspace the OpenShift + description: Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production. @@ -726,13 +727,13 @@ spec: the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will - be exposed internally outside of the main workspace + be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local address. \n Default - value is `public`" + the main devworkspace POD, on a local address. \n + Default value is `public`" enum: - public - internal @@ -827,14 +828,14 @@ spec: apply: description: "Command that consists in applying a given component definition, typically bound to a - workspace event. \n For example, when an `apply` + devworkspace event. \n For example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container - as a K8S initContainer in the workspace POD, unless - the component has its `dedicatedPod` field set to - `true`. \n When no `apply` command exist for a given - component, it is assumed the component will be applied - at workspace start by default." + as a K8S initContainer in the devworkspace POD, + unless the component has its `dedicatedPod` field + set to `true`. \n When no `apply` command exist + for a given component, it is assumed the component + will be applied at devworkspace start by default." properties: attributes: additionalProperties: @@ -880,7 +881,7 @@ spec: - id type: object commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -1276,13 +1277,13 @@ spec: through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by - K8S services, to be consumed by other + of the main devworkspace POD, typically + by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible - inside the main workspace POD, on a local - address. \n Default value is `public`" + inside the main devworkspace POD, on a + local address. \n Default value is `public`" enum: - public - internal @@ -1413,13 +1414,13 @@ spec: through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by - K8S services, to be consumed by other + of the main devworkspace POD, typically + by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible - inside the main workspace POD, on a local - address. \n Default value is `public`" + inside the main devworkspace POD, on a + local address. \n Default value is `public`" enum: - public - internal @@ -1513,13 +1514,13 @@ spec: through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by - K8S services, to be consumed by other + of the main devworkspace POD, typically + by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible - inside the main workspace POD, on a local - address. \n Default value is `public`" + inside the main devworkspace POD, on a + local address. \n Default value is `public`" enum: - public - internal @@ -1665,8 +1666,8 @@ spec: properties: postStart: description: Names of commands that should be executed after the - workspace is completely started. In the case of Che-Theia, these - commands should be executed after all plugins and extensions + devworkspace is completely started. In the case of Che-Theia, + these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser. @@ -1675,26 +1676,27 @@ spec: type: array postStop: description: Names of commands that should be executed after stopping - the workspace. + the devworkspace. items: type: string type: array preStart: description: Names of commands that should be executed before - the workspace start. Kubernetes-wise, these commands would typically - be executed in init containers of the workspace POD. + the devdevworkspace start. Kubernetes-wise, these commands would + typically be executed in init containers of the devworkspace + POD. items: type: string type: array preStop: description: Names of commands that should be executed before - stopping the workspace. + stopping the devworkspace. items: type: string type: array type: object parent: - description: Parent workspace template + description: Parent devworkspace template oneOf: - required: - uri @@ -1723,14 +1725,14 @@ spec: properties: apply: description: "Command that consists in applying a given - component definition, typically bound to a workspace event. - \n For example, when an `apply` command is bound to a - `preStart` event, and references a `container` component, + component definition, typically bound to a devworkspace + event. \n For example, when an `apply` command is bound + to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in - the workspace POD, unless the component has its `dedicatedPod` + the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`. \n When no `apply` command exist for a given component, it is assumed the component will - be applied at workspace start by default." + be applied at devworkspace start by default." properties: attributes: additionalProperties: @@ -1773,7 +1775,7 @@ spec: - id type: object commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -2113,7 +2115,7 @@ spec: - Custom type: string container: - description: Allows adding and configuring workspace-related + description: Allows adding and configuring devworkspace-related containers properties: args: @@ -2159,12 +2161,12 @@ spec: network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by K8S + of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside the main - workspace POD, on a local address. \n Default + devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -2287,10 +2289,10 @@ spec: - name type: object kubernetes: - description: Allows importing into the workspace the Kubernetes - resources defined in a given manifest. For example this - allows reusing the Kubernetes definitions used to deploy - some runtime components in production. + description: Allows importing into the devworkspace the + Kubernetes resources defined in a given manifest. For + example this allows reusing the Kubernetes definitions + used to deploy some runtime components in production. oneOf: - required: - uri @@ -2316,12 +2318,12 @@ spec: network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by K8S + of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside the main - workspace POD, on a local address. \n Default + devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -2384,10 +2386,10 @@ spec: - name type: object openshift: - description: Allows importing into the workspace the OpenShift - resources defined in a given manifest. For example this - allows reusing the OpenShift definitions used to deploy - some runtime components in production. + description: Allows importing into the devworkspace the + OpenShift resources defined in a given manifest. For example + this allows reusing the OpenShift definitions used to + deploy some runtime components in production. oneOf: - required: - uri @@ -2413,12 +2415,12 @@ spec: network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by K8S + of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside the main - workspace POD, on a local address. \n Default + devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -2516,15 +2518,15 @@ spec: apply: description: "Command that consists in applying a given component definition, typically bound - to a workspace event. \n For example, when an - `apply` command is bound to a `preStart` event, - and references a `container` component, it will - start the container as a K8S initContainer in - the workspace POD, unless the component has - its `dedicatedPod` field set to `true`. \n When - no `apply` command exist for a given component, - it is assumed the component will be applied - at workspace start by default." + to a devworkspace event. \n For example, when + an `apply` command is bound to a `preStart` + event, and references a `container` component, + it will start the container as a K8S initContainer + in the devworkspace POD, unless the component + has its `dedicatedPod` field set to `true`. + \n When no `apply` command exist for a given + component, it is assumed the component will + be applied at devworkspace start by default." properties: attributes: additionalProperties: @@ -2570,7 +2572,7 @@ spec: - id type: object commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -2974,13 +2976,13 @@ spec: typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed - internally outside of the main workspace + internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only - be accessible inside the main workspace + be accessible inside the main devworkspace POD, on a local address. \n Default value is `public`" enum: @@ -3117,13 +3119,13 @@ spec: typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed - internally outside of the main workspace + internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only - be accessible inside the main workspace + be accessible inside the main devworkspace POD, on a local address. \n Default value is `public`" enum: @@ -3222,13 +3224,13 @@ spec: typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed - internally outside of the main workspace + internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only - be accessible inside the main workspace + be accessible inside the main devworkspace POD, on a local address. \n Default value is `public`" enum: @@ -3652,7 +3654,7 @@ spec: type: string type: object projects: - description: Projects worked on in the workspace, containing names + description: Projects worked on in the devworkspace, containing names and sources locations items: oneOf: @@ -3911,11 +3913,11 @@ spec: metadata: type: object spec: - description: Structure of the workspace. This is also the specification - of a workspace template. + description: Structure of the devworkspace. This is also the specification + of a devworkspace template. properties: commands: - description: Predefined, ready-to-use, workspace-related commands + description: Predefined, ready-to-use, devworkspace-related commands items: oneOf: - required: @@ -3929,13 +3931,14 @@ spec: properties: apply: description: "Command that consists in applying a given component - definition, typically bound to a workspace event. \n For example, - when an `apply` command is bound to a `preStart` event, and - references a `container` component, it will start the container - as a K8S initContainer in the workspace POD, unless the component - has its `dedicatedPod` field set to `true`. \n When no `apply` - command exist for a given component, it is assumed the component - will be applied at workspace start by default." + definition, typically bound to a devworkspace event. \n For + example, when an `apply` command is bound to a `preStart` + event, and references a `container` component, it will start + the container as a K8S initContainer in the devworkspace POD, + unless the component has its `dedicatedPod` field set to `true`. + \n When no `apply` command exist for a given component, it + is assumed the component will be applied at devworkspace start + by default." properties: component: description: Describes component that will be applied @@ -3971,7 +3974,7 @@ spec: type: object x-kubernetes-preserve-unknown-fields: true commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -4138,7 +4141,7 @@ spec: type: object type: array components: - description: List of the workspace components, such as editor and + description: List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components items: oneOf: @@ -4171,7 +4174,7 @@ spec: - Custom type: string container: - description: Allows adding and configuring workspace-related + description: Allows adding and configuring devworkspace-related containers properties: args: @@ -4216,13 +4219,13 @@ spec: the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will - be exposed internally outside of the main workspace + be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local address. \n Default - value is `public`" + the main devworkspace POD, on a local address. \n + Default value is `public`" enum: - public - internal @@ -4356,7 +4359,7 @@ spec: - embeddedResource type: object kubernetes: - description: Allows importing into the workspace the Kubernetes + description: Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production. @@ -4382,13 +4385,13 @@ spec: the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will - be exposed internally outside of the main workspace + be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local address. \n Default - value is `public`" + the main devworkspace POD, on a local address. \n + Default value is `public`" enum: - public - internal @@ -4461,7 +4464,7 @@ spec: pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the workspace the OpenShift + description: Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production. @@ -4487,13 +4490,13 @@ spec: the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will - be exposed internally outside of the main workspace + be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local address. \n Default - value is `public`" + the main devworkspace POD, on a local address. \n + Default value is `public`" enum: - public - internal @@ -4587,14 +4590,14 @@ spec: apply: description: "Command that consists in applying a given component definition, typically bound to a - workspace event. \n For example, when an `apply` + devworkspace event. \n For example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container - as a K8S initContainer in the workspace POD, unless - the component has its `dedicatedPod` field set to - `true`. \n When no `apply` command exist for a given - component, it is assumed the component will be applied - at workspace start by default." + as a K8S initContainer in the devworkspace POD, + unless the component has its `dedicatedPod` field + set to `true`. \n When no `apply` command exist + for a given component, it is assumed the component + will be applied at devworkspace start by default." properties: component: description: Describes component that will be @@ -4630,7 +4633,7 @@ spec: type: object x-kubernetes-preserve-unknown-fields: true commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -4787,7 +4790,7 @@ spec: - Volume type: string container: - description: Allows adding and configuring workspace-related + description: Allows adding and configuring devworkspace-related containers properties: args: @@ -4837,13 +4840,13 @@ spec: through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by - K8S services, to be consumed by other + of the main devworkspace POD, typically + by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible - inside the main workspace POD, on a local - address. \n Default value is `public`" + inside the main devworkspace POD, on a + local address. \n Default value is `public`" enum: - public - internal @@ -4962,8 +4965,8 @@ spec: type: array type: object kubernetes: - description: Allows importing into the workspace the - Kubernetes resources defined in a given manifest. + description: Allows importing into the devworkspace + the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production. oneOf: @@ -4991,13 +4994,13 @@ spec: through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by - K8S services, to be consumed by other + of the main devworkspace POD, typically + by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible - inside the main workspace POD, on a local - address. \n Default value is `public`" + inside the main devworkspace POD, on a + local address. \n Default value is `public`" enum: - public - internal @@ -5075,8 +5078,8 @@ spec: pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the workspace the - OpenShift resources defined in a given manifest. + description: Allows importing into the devworkspace + the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production. oneOf: @@ -5104,13 +5107,13 @@ spec: through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by - K8S services, to be consumed by other + of the main devworkspace POD, typically + by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible - inside the main workspace POD, on a local - address. \n Default value is `public`" + inside the main devworkspace POD, on a + local address. \n Default value is `public`" enum: - public - internal @@ -5245,8 +5248,8 @@ spec: properties: postStart: description: IDs of commands that should be executed after the - workspace is completely started. In the case of Che-Theia, these - commands should be executed after all plugins and extensions + devworkspace is completely started. In the case of Che-Theia, + these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser. @@ -5255,26 +5258,26 @@ spec: type: array postStop: description: IDs of commands that should be executed after stopping - the workspace. + the devworkspace. items: type: string type: array preStart: description: IDs of commands that should be executed before the - workspace start. Kubernetes-wise, these commands would typically - be executed in init containers of the workspace POD. + devworkspace start. Kubernetes-wise, these commands would typically + be executed in init containers of the devworkspace POD. items: type: string type: array preStop: description: IDs of commands that should be executed before stopping - the workspace. + the devworkspace. items: type: string type: array type: object parent: - description: Parent workspace template + description: Parent devworkspace template oneOf: - required: - uri @@ -5298,14 +5301,14 @@ spec: properties: apply: description: "Command that consists in applying a given - component definition, typically bound to a workspace event. - \n For example, when an `apply` command is bound to a - `preStart` event, and references a `container` component, + component definition, typically bound to a devworkspace + event. \n For example, when an `apply` command is bound + to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in - the workspace POD, unless the component has its `dedicatedPod` + the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`. \n When no `apply` command exist for a given component, it is assumed the component will - be applied at workspace start by default." + be applied at devworkspace start by default." properties: component: description: Describes component that will be applied @@ -5338,7 +5341,7 @@ spec: type: object x-kubernetes-preserve-unknown-fields: true commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -5492,7 +5495,7 @@ spec: - Plugin type: string container: - description: Allows adding and configuring workspace-related + description: Allows adding and configuring devworkspace-related containers properties: args: @@ -5541,12 +5544,12 @@ spec: network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by K8S + of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside the main - workspace POD, on a local address. \n Default + devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -5659,10 +5662,10 @@ spec: type: array type: object kubernetes: - description: Allows importing into the workspace the Kubernetes - resources defined in a given manifest. For example this - allows reusing the Kubernetes definitions used to deploy - some runtime components in production. + description: Allows importing into the devworkspace the + Kubernetes resources defined in a given manifest. For + example this allows reusing the Kubernetes definitions + used to deploy some runtime components in production. oneOf: - required: - uri @@ -5687,12 +5690,12 @@ spec: network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by K8S + of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside the main - workspace POD, on a local address. \n Default + devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -5767,10 +5770,10 @@ spec: pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the workspace the OpenShift - resources defined in a given manifest. For example this - allows reusing the OpenShift definitions used to deploy - some runtime components in production. + description: Allows importing into the devworkspace the + OpenShift resources defined in a given manifest. For example + this allows reusing the OpenShift definitions used to + deploy some runtime components in production. oneOf: - required: - uri @@ -5795,12 +5798,12 @@ spec: network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by K8S + of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside the main - workspace POD, on a local address. \n Default + devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -5896,15 +5899,15 @@ spec: apply: description: "Command that consists in applying a given component definition, typically bound - to a workspace event. \n For example, when an - `apply` command is bound to a `preStart` event, - and references a `container` component, it will - start the container as a K8S initContainer in - the workspace POD, unless the component has - its `dedicatedPod` field set to `true`. \n When - no `apply` command exist for a given component, - it is assumed the component will be applied - at workspace start by default." + to a devworkspace event. \n For example, when + an `apply` command is bound to a `preStart` + event, and references a `container` component, + it will start the container as a K8S initContainer + in the devworkspace POD, unless the component + has its `dedicatedPod` field set to `true`. + \n When no `apply` command exist for a given + component, it is assumed the component will + be applied at devworkspace start by default." properties: component: description: Describes component that will @@ -5940,7 +5943,7 @@ spec: type: object x-kubernetes-preserve-unknown-fields: true commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -6099,7 +6102,7 @@ spec: - Volume type: string container: - description: Allows adding and configuring workspace-related + description: Allows adding and configuring devworkspace-related containers properties: args: @@ -6151,13 +6154,13 @@ spec: typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed - internally outside of the main workspace + internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only - be accessible inside the main workspace + be accessible inside the main devworkspace POD, on a local address. \n Default value is `public`" enum: @@ -6281,7 +6284,7 @@ spec: type: array type: object kubernetes: - description: Allows importing into the workspace + description: Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime @@ -6312,13 +6315,13 @@ spec: typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed - internally outside of the main workspace + internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only - be accessible inside the main workspace + be accessible inside the main devworkspace POD, on a local address. \n Default value is `public`" enum: @@ -6401,7 +6404,7 @@ spec: pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the workspace + description: Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components @@ -6432,13 +6435,13 @@ spec: typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed - internally outside of the main workspace + internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only - be accessible inside the main workspace + be accessible inside the main devworkspace POD, on a local address. \n Default value is `public`" enum: @@ -6814,7 +6817,7 @@ spec: type: string type: object projects: - description: Projects worked on in the workspace, containing names + description: Projects worked on in the devworkspace, containing names and sources locations items: oneOf: diff --git a/crds/workspace.devfile.io_devworkspacetemplates.yaml b/crds/workspace.devfile.io_devworkspacetemplates.yaml index e74789980..fc1b3ba21 100644 --- a/crds/workspace.devfile.io_devworkspacetemplates.yaml +++ b/crds/workspace.devfile.io_devworkspacetemplates.yaml @@ -35,11 +35,11 @@ spec: metadata: type: object spec: - description: Structure of the workspace. This is also the specification - of a workspace template. + description: Structure of the devworkspace. This is also the specification + of a devworkspace template. properties: commands: - description: Predefined, ready-to-use, workspace-related commands + description: Predefined, ready-to-use, devworkspace-related commands items: oneOf: - required: @@ -57,13 +57,14 @@ spec: properties: apply: description: "Command that consists in applying a given component - definition, typically bound to a workspace event. \n For example, - when an `apply` command is bound to a `preStart` event, and - references a `container` component, it will start the container - as a K8S initContainer in the workspace POD, unless the component - has its `dedicatedPod` field set to `true`. \n When no `apply` - command exist for a given component, it is assumed the component - will be applied at workspace start by default." + definition, typically bound to a devworkspace event. \n For + example, when an `apply` command is bound to a `preStart` + event, and references a `container` component, it will start + the container as a K8S initContainer in the devworkspace POD, + unless the component has its `dedicatedPod` field set to `true`. + \n When no `apply` command exist for a given component, it + is assumed the component will be applied at devworkspace start + by default." properties: attributes: additionalProperties: @@ -105,7 +106,7 @@ spec: - id type: object commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -408,7 +409,7 @@ spec: type: object type: array components: - description: List of the workspace components, such as editor and + description: List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components items: oneOf: @@ -436,7 +437,7 @@ spec: - Custom type: string container: - description: Allows adding and configuring workspace-related + description: Allows adding and configuring devworkspace-related containers properties: args: @@ -478,13 +479,13 @@ spec: the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will - be exposed internally outside of the main workspace + be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local address. \n Default - value is `public`" + the main devworkspace POD, on a local address. \n + Default value is `public`" enum: - public - internal @@ -604,7 +605,7 @@ spec: - name type: object kubernetes: - description: Allows importing into the workspace the Kubernetes + description: Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production. @@ -631,13 +632,13 @@ spec: the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will - be exposed internally outside of the main workspace + be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local address. \n Default - value is `public`" + the main devworkspace POD, on a local address. \n + Default value is `public`" enum: - public - internal @@ -697,7 +698,7 @@ spec: - name type: object openshift: - description: Allows importing into the workspace the OpenShift + description: Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production. @@ -724,13 +725,13 @@ spec: the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will - be exposed internally outside of the main workspace + be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local address. \n Default - value is `public`" + the main devworkspace POD, on a local address. \n + Default value is `public`" enum: - public - internal @@ -825,14 +826,14 @@ spec: apply: description: "Command that consists in applying a given component definition, typically bound to a - workspace event. \n For example, when an `apply` + devworkspace event. \n For example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container - as a K8S initContainer in the workspace POD, unless - the component has its `dedicatedPod` field set to - `true`. \n When no `apply` command exist for a given - component, it is assumed the component will be applied - at workspace start by default." + as a K8S initContainer in the devworkspace POD, + unless the component has its `dedicatedPod` field + set to `true`. \n When no `apply` command exist + for a given component, it is assumed the component + will be applied at devworkspace start by default." properties: attributes: additionalProperties: @@ -878,7 +879,7 @@ spec: - id type: object commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -1274,13 +1275,13 @@ spec: through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by - K8S services, to be consumed by other + of the main devworkspace POD, typically + by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible - inside the main workspace POD, on a local - address. \n Default value is `public`" + inside the main devworkspace POD, on a + local address. \n Default value is `public`" enum: - public - internal @@ -1411,13 +1412,13 @@ spec: through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by - K8S services, to be consumed by other + of the main devworkspace POD, typically + by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible - inside the main workspace POD, on a local - address. \n Default value is `public`" + inside the main devworkspace POD, on a + local address. \n Default value is `public`" enum: - public - internal @@ -1511,13 +1512,13 @@ spec: through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by - K8S services, to be consumed by other + of the main devworkspace POD, typically + by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible - inside the main workspace POD, on a local - address. \n Default value is `public`" + inside the main devworkspace POD, on a + local address. \n Default value is `public`" enum: - public - internal @@ -1663,8 +1664,8 @@ spec: properties: postStart: description: Names of commands that should be executed after the - workspace is completely started. In the case of Che-Theia, these - commands should be executed after all plugins and extensions + devworkspace is completely started. In the case of Che-Theia, + these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser. @@ -1673,26 +1674,27 @@ spec: type: array postStop: description: Names of commands that should be executed after stopping - the workspace. + the devworkspace. items: type: string type: array preStart: description: Names of commands that should be executed before - the workspace start. Kubernetes-wise, these commands would typically - be executed in init containers of the workspace POD. + the devdevworkspace start. Kubernetes-wise, these commands would + typically be executed in init containers of the devworkspace + POD. items: type: string type: array preStop: description: Names of commands that should be executed before - stopping the workspace. + stopping the devworkspace. items: type: string type: array type: object parent: - description: Parent workspace template + description: Parent devworkspace template oneOf: - required: - uri @@ -1721,14 +1723,14 @@ spec: properties: apply: description: "Command that consists in applying a given - component definition, typically bound to a workspace event. - \n For example, when an `apply` command is bound to a - `preStart` event, and references a `container` component, + component definition, typically bound to a devworkspace + event. \n For example, when an `apply` command is bound + to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in - the workspace POD, unless the component has its `dedicatedPod` + the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`. \n When no `apply` command exist for a given component, it is assumed the component will - be applied at workspace start by default." + be applied at devworkspace start by default." properties: attributes: additionalProperties: @@ -1771,7 +1773,7 @@ spec: - id type: object commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -2111,7 +2113,7 @@ spec: - Custom type: string container: - description: Allows adding and configuring workspace-related + description: Allows adding and configuring devworkspace-related containers properties: args: @@ -2157,12 +2159,12 @@ spec: network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by K8S + of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside the main - workspace POD, on a local address. \n Default + devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -2285,10 +2287,10 @@ spec: - name type: object kubernetes: - description: Allows importing into the workspace the Kubernetes - resources defined in a given manifest. For example this - allows reusing the Kubernetes definitions used to deploy - some runtime components in production. + description: Allows importing into the devworkspace the + Kubernetes resources defined in a given manifest. For + example this allows reusing the Kubernetes definitions + used to deploy some runtime components in production. oneOf: - required: - uri @@ -2314,12 +2316,12 @@ spec: network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by K8S + of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside the main - workspace POD, on a local address. \n Default + devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -2382,10 +2384,10 @@ spec: - name type: object openshift: - description: Allows importing into the workspace the OpenShift - resources defined in a given manifest. For example this - allows reusing the OpenShift definitions used to deploy - some runtime components in production. + description: Allows importing into the devworkspace the + OpenShift resources defined in a given manifest. For example + this allows reusing the OpenShift definitions used to + deploy some runtime components in production. oneOf: - required: - uri @@ -2411,12 +2413,12 @@ spec: network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by K8S + of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside the main - workspace POD, on a local address. \n Default + devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -2514,15 +2516,15 @@ spec: apply: description: "Command that consists in applying a given component definition, typically bound - to a workspace event. \n For example, when an - `apply` command is bound to a `preStart` event, - and references a `container` component, it will - start the container as a K8S initContainer in - the workspace POD, unless the component has - its `dedicatedPod` field set to `true`. \n When - no `apply` command exist for a given component, - it is assumed the component will be applied - at workspace start by default." + to a devworkspace event. \n For example, when + an `apply` command is bound to a `preStart` + event, and references a `container` component, + it will start the container as a K8S initContainer + in the devworkspace POD, unless the component + has its `dedicatedPod` field set to `true`. + \n When no `apply` command exist for a given + component, it is assumed the component will + be applied at devworkspace start by default." properties: attributes: additionalProperties: @@ -2568,7 +2570,7 @@ spec: - id type: object commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -2972,13 +2974,13 @@ spec: typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed - internally outside of the main workspace + internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only - be accessible inside the main workspace + be accessible inside the main devworkspace POD, on a local address. \n Default value is `public`" enum: @@ -3115,13 +3117,13 @@ spec: typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed - internally outside of the main workspace + internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only - be accessible inside the main workspace + be accessible inside the main devworkspace POD, on a local address. \n Default value is `public`" enum: @@ -3220,13 +3222,13 @@ spec: typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed - internally outside of the main workspace + internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only - be accessible inside the main workspace + be accessible inside the main devworkspace POD, on a local address. \n Default value is `public`" enum: @@ -3650,7 +3652,7 @@ spec: type: string type: object projects: - description: Projects worked on in the workspace, containing names + description: Projects worked on in the devworkspace, containing names and sources locations items: oneOf: @@ -3909,11 +3911,11 @@ spec: metadata: type: object spec: - description: Structure of the workspace. This is also the specification - of a workspace template. + description: Structure of the devworkspace. This is also the specification + of a devworkspace template. properties: commands: - description: Predefined, ready-to-use, workspace-related commands + description: Predefined, ready-to-use, devworkspace-related commands items: oneOf: - required: @@ -3927,13 +3929,14 @@ spec: properties: apply: description: "Command that consists in applying a given component - definition, typically bound to a workspace event. \n For example, - when an `apply` command is bound to a `preStart` event, and - references a `container` component, it will start the container - as a K8S initContainer in the workspace POD, unless the component - has its `dedicatedPod` field set to `true`. \n When no `apply` - command exist for a given component, it is assumed the component - will be applied at workspace start by default." + definition, typically bound to a devworkspace event. \n For + example, when an `apply` command is bound to a `preStart` + event, and references a `container` component, it will start + the container as a K8S initContainer in the devworkspace POD, + unless the component has its `dedicatedPod` field set to `true`. + \n When no `apply` command exist for a given component, it + is assumed the component will be applied at devworkspace start + by default." properties: component: description: Describes component that will be applied @@ -3969,7 +3972,7 @@ spec: type: object x-kubernetes-preserve-unknown-fields: true commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -4136,7 +4139,7 @@ spec: type: object type: array components: - description: List of the workspace components, such as editor and + description: List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components items: oneOf: @@ -4169,7 +4172,7 @@ spec: - Custom type: string container: - description: Allows adding and configuring workspace-related + description: Allows adding and configuring devworkspace-related containers properties: args: @@ -4215,13 +4218,13 @@ spec: the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will - be exposed internally outside of the main workspace + be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local address. \n Default - value is `public`" + the main devworkspace POD, on a local address. \n + Default value is `public`" enum: - public - internal @@ -4357,7 +4360,7 @@ spec: - embeddedResource type: object kubernetes: - description: Allows importing into the workspace the Kubernetes + description: Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production. @@ -4384,13 +4387,13 @@ spec: the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will - be exposed internally outside of the main workspace + be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local address. \n Default - value is `public`" + the main devworkspace POD, on a local address. \n + Default value is `public`" enum: - public - internal @@ -4464,7 +4467,7 @@ spec: pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the workspace the OpenShift + description: Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production. @@ -4491,13 +4494,13 @@ spec: the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will - be exposed internally outside of the main workspace + be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside - the main workspace POD, on a local address. \n Default - value is `public`" + the main devworkspace POD, on a local address. \n + Default value is `public`" enum: - public - internal @@ -4592,14 +4595,14 @@ spec: apply: description: "Command that consists in applying a given component definition, typically bound to a - workspace event. \n For example, when an `apply` + devworkspace event. \n For example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container - as a K8S initContainer in the workspace POD, unless - the component has its `dedicatedPod` field set to - `true`. \n When no `apply` command exist for a given - component, it is assumed the component will be applied - at workspace start by default." + as a K8S initContainer in the devworkspace POD, + unless the component has its `dedicatedPod` field + set to `true`. \n When no `apply` command exist + for a given component, it is assumed the component + will be applied at devworkspace start by default." properties: component: description: Describes component that will be @@ -4635,7 +4638,7 @@ spec: type: object x-kubernetes-preserve-unknown-fields: true commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -4792,7 +4795,7 @@ spec: - Volume type: string container: - description: Allows adding and configuring workspace-related + description: Allows adding and configuring devworkspace-related containers properties: args: @@ -4842,13 +4845,13 @@ spec: through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by - K8S services, to be consumed by other + of the main devworkspace POD, typically + by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible - inside the main workspace POD, on a local - address. \n Default value is `public`" + inside the main devworkspace POD, on a + local address. \n Default value is `public`" enum: - public - internal @@ -4967,8 +4970,8 @@ spec: type: array type: object kubernetes: - description: Allows importing into the workspace the - Kubernetes resources defined in a given manifest. + description: Allows importing into the devworkspace + the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production. oneOf: @@ -4996,13 +4999,13 @@ spec: through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by - K8S services, to be consumed by other + of the main devworkspace POD, typically + by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible - inside the main workspace POD, on a local - address. \n Default value is `public`" + inside the main devworkspace POD, on a + local address. \n Default value is `public`" enum: - public - internal @@ -5080,8 +5083,8 @@ spec: pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the workspace the - OpenShift resources defined in a given manifest. + description: Allows importing into the devworkspace + the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production. oneOf: @@ -5109,13 +5112,13 @@ spec: through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by - K8S services, to be consumed by other + of the main devworkspace POD, typically + by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible - inside the main workspace POD, on a local - address. \n Default value is `public`" + inside the main devworkspace POD, on a + local address. \n Default value is `public`" enum: - public - internal @@ -5250,8 +5253,8 @@ spec: properties: postStart: description: IDs of commands that should be executed after the - workspace is completely started. In the case of Che-Theia, these - commands should be executed after all plugins and extensions + devworkspace is completely started. In the case of Che-Theia, + these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser. @@ -5260,26 +5263,26 @@ spec: type: array postStop: description: IDs of commands that should be executed after stopping - the workspace. + the devworkspace. items: type: string type: array preStart: description: IDs of commands that should be executed before the - workspace start. Kubernetes-wise, these commands would typically - be executed in init containers of the workspace POD. + devworkspace start. Kubernetes-wise, these commands would typically + be executed in init containers of the devworkspace POD. items: type: string type: array preStop: description: IDs of commands that should be executed before stopping - the workspace. + the devworkspace. items: type: string type: array type: object parent: - description: Parent workspace template + description: Parent devworkspace template oneOf: - required: - uri @@ -5303,14 +5306,14 @@ spec: properties: apply: description: "Command that consists in applying a given - component definition, typically bound to a workspace event. - \n For example, when an `apply` command is bound to a - `preStart` event, and references a `container` component, + component definition, typically bound to a devworkspace + event. \n For example, when an `apply` command is bound + to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in - the workspace POD, unless the component has its `dedicatedPod` + the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`. \n When no `apply` command exist for a given component, it is assumed the component will - be applied at workspace start by default." + be applied at devworkspace start by default." properties: component: description: Describes component that will be applied @@ -5343,7 +5346,7 @@ spec: type: object x-kubernetes-preserve-unknown-fields: true commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -5497,7 +5500,7 @@ spec: - Plugin type: string container: - description: Allows adding and configuring workspace-related + description: Allows adding and configuring devworkspace-related containers properties: args: @@ -5546,12 +5549,12 @@ spec: network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by K8S + of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside the main - workspace POD, on a local address. \n Default + devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -5664,10 +5667,10 @@ spec: type: array type: object kubernetes: - description: Allows importing into the workspace the Kubernetes - resources defined in a given manifest. For example this - allows reusing the Kubernetes definitions used to deploy - some runtime components in production. + description: Allows importing into the devworkspace the + Kubernetes resources defined in a given manifest. For + example this allows reusing the Kubernetes definitions + used to deploy some runtime components in production. oneOf: - required: - uri @@ -5692,12 +5695,12 @@ spec: network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by K8S + of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside the main - workspace POD, on a local address. \n Default + devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -5772,10 +5775,10 @@ spec: pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the workspace the OpenShift - resources defined in a given manifest. For example this - allows reusing the OpenShift definitions used to deploy - some runtime components in production. + description: Allows importing into the devworkspace the + OpenShift resources defined in a given manifest. For example + this allows reusing the OpenShift definitions used to + deploy some runtime components in production. oneOf: - required: - uri @@ -5800,12 +5803,12 @@ spec: network, typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed internally outside - of the main workspace POD, typically by K8S + of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only be accessible inside the main - workspace POD, on a local address. \n Default + devworkspace POD, on a local address. \n Default value is `public`" enum: - public @@ -5901,15 +5904,15 @@ spec: apply: description: "Command that consists in applying a given component definition, typically bound - to a workspace event. \n For example, when an - `apply` command is bound to a `preStart` event, - and references a `container` component, it will - start the container as a K8S initContainer in - the workspace POD, unless the component has - its `dedicatedPod` field set to `true`. \n When - no `apply` command exist for a given component, - it is assumed the component will be applied - at workspace start by default." + to a devworkspace event. \n For example, when + an `apply` command is bound to a `preStart` + event, and references a `container` component, + it will start the container as a K8S initContainer + in the devworkspace POD, unless the component + has its `dedicatedPod` field set to `true`. + \n When no `apply` command exist for a given + component, it is assumed the component will + be applied at devworkspace start by default." properties: component: description: Describes component that will @@ -5945,7 +5948,7 @@ spec: type: object x-kubernetes-preserve-unknown-fields: true commandType: - description: Type of workspace command + description: Type of devworkspace command enum: - Exec - Apply @@ -6104,7 +6107,7 @@ spec: - Volume type: string container: - description: Allows adding and configuring workspace-related + description: Allows adding and configuring devworkspace-related containers properties: args: @@ -6156,13 +6159,13 @@ spec: typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed - internally outside of the main workspace + internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only - be accessible inside the main workspace + be accessible inside the main devworkspace POD, on a local address. \n Default value is `public`" enum: @@ -6286,7 +6289,7 @@ spec: type: array type: object kubernetes: - description: Allows importing into the workspace + description: Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime @@ -6317,13 +6320,13 @@ spec: typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed - internally outside of the main workspace + internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only - be accessible inside the main workspace + be accessible inside the main devworkspace POD, on a local address. \n Default value is `public`" enum: @@ -6406,7 +6409,7 @@ spec: pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ type: string openshift: - description: Allows importing into the workspace + description: Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components @@ -6437,13 +6440,13 @@ spec: typically through a K8S ingress or an OpenShift route. \n - `internal` means that the endpoint will be exposed - internally outside of the main workspace + internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network. \n - `none` means that the endpoint will not be exposed and will only - be accessible inside the main workspace + be accessible inside the main devworkspace POD, on a local address. \n Default value is `public`" enum: @@ -6819,7 +6822,7 @@ spec: type: string type: object projects: - description: Projects worked on in the workspace, containing names + description: Projects worked on in the devworkspace, containing names and sources locations items: oneOf: diff --git a/generator/main.go b/generator/main.go index d4c2a77d3..ff247ee1b 100644 --- a/generator/main.go +++ b/generator/main.go @@ -110,7 +110,7 @@ func main() { cmd := &cobra.Command{ Use: "generator", - Short: "Generates various types of files from the `workspaces` K8S API source code.", + Short: "Generates various types of files from the `devworkspace` K8S API source code.", Long: "Generates additional GO source files (for devfile overriding, union support, deep-copy), K8S CRD YAML files and Json Schemas from the from the `workspaces` K8S API source code.", Example: ` # Generate Plugin Overrides based on the workspaces/v1alpha2 K8S API diff --git a/pkg/apis/workspaces/v1alpha1/WorkspacePodContribution.go b/pkg/apis/workspaces/v1alpha1/WorkspacePodContribution.go index 6f001a86e..81ac8b396 100644 --- a/pkg/apis/workspaces/v1alpha1/WorkspacePodContribution.go +++ b/pkg/apis/workspaces/v1alpha1/WorkspacePodContribution.go @@ -4,7 +4,7 @@ import ( corev1 "k8s.io/api/core/v1" ) -type WorkspacePodContributions struct { +type DevWorkspacePodContributions struct { // +optional // +patchMergeKey=name // +patchStrategy=merge,retainKeys @@ -15,7 +15,7 @@ type WorkspacePodContributions struct { // +patchMergeKey=name // +patchStrategy=merge Containers []corev1.Container `json:"containers" patchStrategy:"merge" patchMergeKey:"name" protobuf:"bytes,2,rep,name=containers"` - // ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by the workspace Pod. + // ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by the devworkspace Pod. // If specified, these secrets will be passed to individual puller implementations for them to use. For example, // in the case of docker, only DockerConfig type secrets are honored. // More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod @@ -23,7 +23,7 @@ type WorkspacePodContributions struct { // +patchMergeKey=name // +patchStrategy=merge ImagePullSecrets []corev1.LocalObjectReference `json:"imagePullSecrets,omitempty" patchStrategy:"merge" patchMergeKey:"name" protobuf:"bytes,15,rep,name=imagePullSecrets"` - // List of workspace-wide environment variables to set in all containers of the workspace POD. + // List of devworkspace-wide environment variables to set in all containers of the devworkspace POD. // +optional // +patchMergeKey=name // +patchStrategy=merge diff --git a/pkg/apis/workspaces/v1alpha1/commands.go b/pkg/apis/workspaces/v1alpha1/commands.go index c767c78e2..e434afbb0 100644 --- a/pkg/apis/workspaces/v1alpha1/commands.go +++ b/pkg/apis/workspaces/v1alpha1/commands.go @@ -62,7 +62,7 @@ type LabeledCommand struct { // +k8s:openapi-gen=true // +union type Command struct { - // Type of workspace command + // Type of devworkspace command // +unionDiscriminator // +optional CommandType CommandType `json:"commandType,omitempty"` @@ -72,15 +72,15 @@ type Command struct { Exec *ExecCommand `json:"exec,omitempty"` // Command that consists in applying a given component definition, - // typically bound to a workspace event. + // typically bound to a devworkspace event. // // For example, when an `apply` command is bound to a `preStart` event, // and references a `container` component, it will start the container as a - // K8S initContainer in the workspace POD, unless the component has its + // K8S initContainer in the devworkspace POD, unless the component has its // `dedicatedPod` field set to `true`. // // When no `apply` command exist for a given component, - // it is assumed the component will be applied at workspace start + // it is assumed the component will be applied at devworkspace start // by default. // +optional Apply *ApplyCommand `json:"apply,omitempty"` diff --git a/pkg/apis/workspaces/v1alpha1/components.go b/pkg/apis/workspaces/v1alpha1/components.go index f4c603d8b..f7f7bad7c 100644 --- a/pkg/apis/workspaces/v1alpha1/components.go +++ b/pkg/apis/workspaces/v1alpha1/components.go @@ -16,8 +16,8 @@ const ( CustomComponentType ComponentType = "Custom" ) -// Workspace component: Anything that will bring additional features / tooling / behaviour / context -// to the workspace, in order to make working in it easier. +// DevWorkspace component: Anything that will bring additional features / tooling / behaviour / context +// to the devworkspace, in order to make working in it easier. type BaseComponent struct { } @@ -30,7 +30,7 @@ type Component struct { // +optional ComponentType ComponentType `json:"componentType,omitempty"` - // Allows adding and configuring workspace-related containers + // Allows adding and configuring devworkspace-related containers // +optional Container *ContainerComponent `json:"container,omitempty"` @@ -48,14 +48,14 @@ type Component struct { // +optional Plugin *PluginComponent `json:"plugin,omitempty"` - // Allows importing into the workspace the Kubernetes resources + // Allows importing into the devworkspace the Kubernetes resources // defined in a given manifest. For example this allows reusing the Kubernetes // definitions used to deploy some runtime components in production. // // +optional Kubernetes *KubernetesComponent `json:"kubernetes,omitempty"` - // Allows importing into the workspace the OpenShift resources + // Allows importing into the devworkspace the OpenShift resources // defined in a given manifest. For example this allows reusing the OpenShift // definitions used to deploy some runtime components in production. // diff --git a/pkg/apis/workspaces/v1alpha1/containerComponent.go b/pkg/apis/workspaces/v1alpha1/containerComponent.go index ea7dc4287..e699ed117 100644 --- a/pkg/apis/workspaces/v1alpha1/containerComponent.go +++ b/pkg/apis/workspaces/v1alpha1/containerComponent.go @@ -1,6 +1,6 @@ package v1alpha1 -// Component that allows the developer to add a configured container into his workspace +// Component that allows the developer to add a configured container into his devworkspace type ContainerComponent struct { BaseComponent `json:",inline"` Container `json:",inline"` diff --git a/pkg/apis/workspaces/v1alpha1/conversion.go b/pkg/apis/workspaces/v1alpha1/conversion.go index 330200df9..dd3a021db 100644 --- a/pkg/apis/workspaces/v1alpha1/conversion.go +++ b/pkg/apis/workspaces/v1alpha1/conversion.go @@ -6,9 +6,9 @@ import ( func convertDevWorkspaceTo_v1alpha2(src *DevWorkspace, dest *v1alpha2.DevWorkspace) error { dest.ObjectMeta = src.ObjectMeta - dest.Status.WorkspaceId = src.Status.WorkspaceId + dest.Status.DevWorkspaceId = src.Status.DevWorkspaceId dest.Status.IdeUrl = src.Status.IdeUrl - dest.Status.Phase = v1alpha2.WorkspacePhase(src.Status.Phase) + dest.Status.Phase = v1alpha2.DevWorkspacePhase(src.Status.Phase) dest.Status.Message = src.Status.Message convertConditionsTo_v1alpha2(src, dest) dest.Spec.RoutingClass = src.Spec.RoutingClass @@ -19,9 +19,9 @@ func convertDevWorkspaceTo_v1alpha2(src *DevWorkspace, dest *v1alpha2.DevWorkspa func convertDevWorkspaceFrom_v1alpha2(src *v1alpha2.DevWorkspace, dest *DevWorkspace) error { dest.ObjectMeta = src.ObjectMeta - dest.Status.WorkspaceId = src.Status.WorkspaceId + dest.Status.DevWorkspaceId = src.Status.DevWorkspaceId dest.Status.IdeUrl = src.Status.IdeUrl - dest.Status.Phase = WorkspacePhase(src.Status.Phase) + dest.Status.Phase = DevWorkspacePhase(src.Status.Phase) dest.Status.Message = src.Status.Message convertConditionsFrom_v1alpha2(src, dest) dest.Spec.RoutingClass = src.Spec.RoutingClass @@ -142,24 +142,24 @@ func convertDevWorkspaceTemplateSpecFrom_v1alpha2(src *v1alpha2.DevWorkspaceTemp func convertConditionsTo_v1alpha2(src *DevWorkspace, dest *v1alpha2.DevWorkspace) { for _, srcCondition := range src.Status.Conditions { - dstCondition := v1alpha2.WorkspaceCondition{} + dstCondition := v1alpha2.DevWorkspaceCondition{} dstCondition.Status = srcCondition.Status dstCondition.LastTransitionTime = srcCondition.LastTransitionTime dstCondition.Message = srcCondition.Message dstCondition.Reason = srcCondition.Reason - dstCondition.Type = v1alpha2.WorkspaceConditionType(srcCondition.Type) + dstCondition.Type = v1alpha2.DevWorkspaceConditionType(srcCondition.Type) dest.Status.Conditions = append(dest.Status.Conditions, dstCondition) } } func convertConditionsFrom_v1alpha2(src *v1alpha2.DevWorkspace, dest *DevWorkspace) { for _, srcCondition := range src.Status.Conditions { - dstCondition := WorkspaceCondition{} + dstCondition := DevWorkspaceCondition{} dstCondition.Status = srcCondition.Status dstCondition.LastTransitionTime = srcCondition.LastTransitionTime dstCondition.Message = srcCondition.Message dstCondition.Reason = srcCondition.Reason - dstCondition.Type = WorkspaceConditionType(srcCondition.Type) + dstCondition.Type = DevWorkspaceConditionType(srcCondition.Type) dest.Status.Conditions = append(dest.Status.Conditions, dstCondition) } } diff --git a/pkg/apis/workspaces/v1alpha1/conversion_test.go b/pkg/apis/workspaces/v1alpha1/conversion_test.go index 6a1b4f0d3..36ba09ed9 100644 --- a/pkg/apis/workspaces/v1alpha1/conversion_test.go +++ b/pkg/apis/workspaces/v1alpha1/conversion_test.go @@ -13,13 +13,13 @@ import ( const fuzzIterations = 500 const fuzzNilChance = 0.2 -var devWorkspaceFuzzFunc = func(workspace *DevWorkspace, c fuzz.Continue) { - c.Fuzz(&workspace.Status) - c.Fuzz(&workspace.Spec) +var devWorkspaceFuzzFunc = func(dw *DevWorkspace, c fuzz.Continue) { + c.Fuzz(&dw.Status) + c.Fuzz(&dw.Spec) } -var devWorkspaceTemplateFuzzFunc = func(workspace *DevWorkspaceTemplate, c fuzz.Continue) { - c.Fuzz(&workspace.Spec) +var devWorkspaceTemplateFuzzFunc = func(dwt *DevWorkspaceTemplate, c fuzz.Continue) { + c.Fuzz(&dwt.Spec) } var componentFuzzFunc = func(component *Component, c fuzz.Continue) { @@ -101,9 +101,9 @@ var parentFuzzFunc = func(parent *Parent, c fuzz.Continue) { } } -var conditionFuzzFunc = func(condition *WorkspaceCondition, c fuzz.Continue) { +var conditionFuzzFunc = func(condition *DevWorkspaceCondition, c fuzz.Continue) { condition.Reason = c.RandString() - condition.Type = WorkspaceConditionType(c.RandString()) + condition.Type = DevWorkspaceConditionType(c.RandString()) condition.Message = c.RandString() } diff --git a/pkg/apis/workspaces/v1alpha1/devworkspaceTemplateSpec.go b/pkg/apis/workspaces/v1alpha1/devworkspaceTemplateSpec.go index ac0c3ac5b..4283ac286 100644 --- a/pkg/apis/workspaces/v1alpha1/devworkspaceTemplateSpec.go +++ b/pkg/apis/workspaces/v1alpha1/devworkspaceTemplateSpec.go @@ -1,9 +1,9 @@ package v1alpha1 -// Structure of the workspace. This is also the specification of a workspace template. +// Structure of the devworkspace. This is also the specification of a devworkspace template. // +k8s:openapi-gen=true type DevWorkspaceTemplateSpec struct { - // Parent workspace template + // Parent devworkspace template // +optional Parent *Parent `json:"parent,omitempty"` @@ -11,7 +11,7 @@ type DevWorkspaceTemplateSpec struct { } type DevWorkspaceTemplateSpecContent struct { - // Predefined, ready-to-use, workspace-related commands + // Predefined, ready-to-use, devworkspace-related commands // +optional // Commands []Command `json:"commands,omitempty" patchStrategy:"merge" patchMergeKey:"id"` @@ -21,7 +21,7 @@ type DevWorkspaceTemplateSpecContent struct { // +optional Events *Events `json:"events,omitempty"` - // Projects worked on in the workspace, containing names and sources locations + // Projects worked on in the devworkspace, containing names and sources locations // +optional Projects []Project `json:"projects,omitempty" patchStrategy:"merge" patchMergeKey:"name"` @@ -29,7 +29,7 @@ type DevWorkspaceTemplateSpecContent struct { // +optional StarterProjects []StarterProject `json:"starterProjects,omitempty"` - // List of the workspace components, such as editor and plugins, + // List of the devworkspace components, such as editor and plugins, // user-provided containers, or other types of components // +optional Components []Component `json:"components,omitempty" patchStrategy:"merge" patchMergeKey:"name"` diff --git a/pkg/apis/workspaces/v1alpha1/devworkspace_types.go b/pkg/apis/workspaces/v1alpha1/devworkspace_types.go index 0d892808f..4fc365c6b 100644 --- a/pkg/apis/workspaces/v1alpha1/devworkspace_types.go +++ b/pkg/apis/workspaces/v1alpha1/devworkspace_types.go @@ -16,34 +16,34 @@ type DevWorkspaceSpec struct { // DevWorkspaceStatus defines the observed state of DevWorkspace // +k8s:openapi-gen=true type DevWorkspaceStatus struct { - // Id of the workspace - WorkspaceId string `json:"workspaceId"` + // Id of the devworkspace + DevWorkspaceId string `json:"devWorkspaceId"` // URL at which the Worksace Editor can be joined - IdeUrl string `json:"ideUrl,omitempty"` - Phase WorkspacePhase `json:"phase,omitempty"` + IdeUrl string `json:"ideUrl,omitempty"` + Phase DevWorkspacePhase `json:"phase,omitempty"` // Conditions represent the latest available observations of an object's state - Conditions []WorkspaceCondition `json:"conditions,omitempty"` + Conditions []DevWorkspaceCondition `json:"conditions,omitempty"` // Message is a short user-readable message giving additional information // about an object's state Message string `json:"message,omitempty"` } -type WorkspacePhase string +type DevWorkspacePhase string -// Valid workspace Statuses +// Valid devWorkspace Statuses const ( - WorkspaceStatusStarting WorkspacePhase = "Starting" - WorkspaceStatusRunning WorkspacePhase = "Running" - WorkspaceStatusStopped WorkspacePhase = "Stopped" - WorkspaceStatusStopping WorkspacePhase = "Stopping" - WorkspaceStatusFailed WorkspacePhase = "Failed" - WorkspaceStatusError WorkspacePhase = "Error" + DevWorkspaceStatusStarting DevWorkspacePhase = "Starting" + DevWorkspaceStatusRunning DevWorkspacePhase = "Running" + DevWorkspaceStatusStopped DevWorkspacePhase = "Stopped" + DevWorkspaceStatusStopping DevWorkspacePhase = "Stopping" + DevWorkspaceStatusFailed DevWorkspacePhase = "Failed" + DevWorkspaceStatusError DevWorkspacePhase = "Error" ) -// WorkspaceCondition contains details for the current condition of this workspace. -type WorkspaceCondition struct { +// DevWorkspaceCondition contains details for the current condition of this devworkspace. +type DevWorkspaceCondition struct { // Type is the type of the condition. - Type WorkspaceConditionType `json:"type"` + Type DevWorkspaceConditionType `json:"type"` // Phase is the status of the condition. // Can be True, False, Unknown. Status corev1.ConditionStatus `json:"status"` @@ -55,16 +55,16 @@ type WorkspaceCondition struct { Message string `json:"message,omitempty"` } -// Types of conditions reported by workspace -type WorkspaceConditionType string +// Types of conditions reported by devworkspace +type DevWorkspaceConditionType string const ( - WorkspaceComponentsReady WorkspaceConditionType = "ComponentsReady" - WorkspaceRoutingReady WorkspaceConditionType = "RoutingReady" - WorkspaceServiceAccountReady WorkspaceConditionType = "ServiceAccountReady" - WorkspaceReady WorkspaceConditionType = "Ready" - WorkspaceFailedStart WorkspaceConditionType = "FailedStart" - WorkspaceError WorkspaceConditionType = "Error" + DevWorkspaceComponentsReady DevWorkspaceConditionType = "ComponentsReady" + DevWorkspaceRoutingReady DevWorkspaceConditionType = "RoutingReady" + DevWorkspaceServiceAccountReady DevWorkspaceConditionType = "ServiceAccountReady" + DevWorkspaceReady DevWorkspaceConditionType = "Ready" + DevWorkspaceFailedStart DevWorkspaceConditionType = "FailedStart" + DevWorkspaceError DevWorkspaceConditionType = "Error" ) // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object @@ -73,9 +73,9 @@ const ( // +k8s:openapi-gen=true // +kubebuilder:subresource:status // +kubebuilder:resource:path=devworkspaces,scope=Namespaced -// +kubebuilder:printcolumn:name="Workspace ID",type="string",JSONPath=".status.workspaceId",description="The workspace's unique id" -// +kubebuilder:printcolumn:name="Phase",type="string",JSONPath=".status.phase",description="The current workspace startup phase" -// +kubebuilder:printcolumn:name="URL",type="string",JSONPath=".status.ideUrl",description="Url endpoint for accessing workspace" +// +kubebuilder:printcolumn:name="DevWorkspace ID",type="string",JSONPath=".status.devWorkspaceId",description="The devworkspace's unique id" +// +kubebuilder:printcolumn:name="Phase",type="string",JSONPath=".status.phase",description="The current devworkspace startup phase" +// +kubebuilder:printcolumn:name="URL",type="string",JSONPath=".status.ideUrl",description="Url endpoint for accessing devworkspace" type DevWorkspace struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` diff --git a/pkg/apis/workspaces/v1alpha1/endpoint.go b/pkg/apis/workspaces/v1alpha1/endpoint.go index affd725e0..e3eb23e17 100644 --- a/pkg/apis/workspaces/v1alpha1/endpoint.go +++ b/pkg/apis/workspaces/v1alpha1/endpoint.go @@ -33,12 +33,12 @@ const ( // Endpoint will be exposed on the public network, typically through // a K8S ingress or an OpenShift route PublicEndpointExposure EndpointExposure = "public" - // Endpoint will be exposed internally outside of the main workspace POD, + // Endpoint will be exposed internally outside of the main devworkspace POD, // typically by K8S services, to be consumed by other elements running // on the same cloud internal network. InternalEndpointExposure EndpointExposure = "internal" // Endpoint will not be exposed and will only be accessible - // inside the main workspace POD, on a local address. + // inside the main devworkspace POD, on a local address. NoneEndpointExposure EndpointExposure = "none" ) @@ -53,12 +53,12 @@ type Endpoint struct { // - `public` means that the endpoint will be exposed on the public network, typically through // a K8S ingress or an OpenShift route. // - // - `internal` means that the endpoint will be exposed internally outside of the main workspace POD, + // - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, // typically by K8S services, to be consumed by other elements running // on the same cloud internal network. // // - `none` means that the endpoint will not be exposed and will only be accessible - // inside the main workspace POD, on a local address. + // inside the main devworkspace POD, on a local address. // // Default value is `public` // +optional diff --git a/pkg/apis/workspaces/v1alpha1/events.go b/pkg/apis/workspaces/v1alpha1/events.go index 4897a4b2c..74b4ebd6b 100644 --- a/pkg/apis/workspaces/v1alpha1/events.go +++ b/pkg/apis/workspaces/v1alpha1/events.go @@ -1,26 +1,26 @@ package v1alpha1 type Events struct { - WorkspaceEvents `json:",inline"` + DevWorkspaceEvents `json:",inline"` } -type WorkspaceEvents struct { - // Names of commands that should be executed before the workspace start. - // Kubernetes-wise, these commands would typically be executed in init containers of the workspace POD. +type DevWorkspaceEvents struct { + // Names of commands that should be executed before the devdevworkspace start. + // Kubernetes-wise, these commands would typically be executed in init containers of the devworkspace POD. // +optional PreStart []string `json:"preStart,omitempty"` - // Names of commands that should be executed after the workspace is completely started. + // Names of commands that should be executed after the devworkspace is completely started. // In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. // This means that those commands are not triggered until the user opens the IDE in his browser. // +optional PostStart []string `json:"postStart,omitempty"` // +optional - // Names of commands that should be executed before stopping the workspace. + // Names of commands that should be executed before stopping the devworkspace. PreStop []string `json:"preStop,omitempty"` // +optional - // Names of commands that should be executed after stopping the workspace. + // Names of commands that should be executed after stopping the devworkspace. PostStop []string `json:"postStop,omitempty"` } diff --git a/pkg/apis/workspaces/v1alpha1/events_conversion.go b/pkg/apis/workspaces/v1alpha1/events_conversion.go index 4bef6227f..6f882309a 100644 --- a/pkg/apis/workspaces/v1alpha1/events_conversion.go +++ b/pkg/apis/workspaces/v1alpha1/events_conversion.go @@ -6,14 +6,14 @@ import ( func convertEventsTo_v1alpha2(src *Events, dest *v1alpha2.Events) error { if src != nil { - dest.WorkspaceEvents = v1alpha2.WorkspaceEvents(src.WorkspaceEvents) + dest.DevWorkspaceEvents = v1alpha2.DevWorkspaceEvents(src.DevWorkspaceEvents) } return nil } func convertEventsFrom_v1alpha2(src *v1alpha2.Events, dest *Events) error { if src != nil { - dest.WorkspaceEvents = WorkspaceEvents(src.WorkspaceEvents) + dest.DevWorkspaceEvents = DevWorkspaceEvents(src.DevWorkspaceEvents) } return nil } diff --git a/pkg/apis/workspaces/v1alpha1/kubernetesLikeComponent.go b/pkg/apis/workspaces/v1alpha1/kubernetesLikeComponent.go index b17863161..cee374726 100644 --- a/pkg/apis/workspaces/v1alpha1/kubernetesLikeComponent.go +++ b/pkg/apis/workspaces/v1alpha1/kubernetesLikeComponent.go @@ -40,12 +40,12 @@ type K8sLikeComponent struct { Endpoints []Endpoint `json:"endpoints,omitempty" patchStrategy:"merge" patchMergeKey:"name"` } -// Component that allows partly importing Kubernetes resources into the workspace POD +// Component that allows partly importing Kubernetes resources into the devworkspace POD type KubernetesComponent struct { K8sLikeComponent `json:",inline"` } -// Component that allows partly importing Openshift resources into the workspace POD +// Component that allows partly importing Openshift resources into the devworkspace POD type OpenshiftComponent struct { K8sLikeComponent `json:",inline"` } diff --git a/pkg/apis/workspaces/v1alpha1/volumeComponent.go b/pkg/apis/workspaces/v1alpha1/volumeComponent.go index 7815e1a10..0dfdd9c9a 100644 --- a/pkg/apis/workspaces/v1alpha1/volumeComponent.go +++ b/pkg/apis/workspaces/v1alpha1/volumeComponent.go @@ -1,6 +1,6 @@ package v1alpha1 -// Component that allows the developer to declare and configure a volume into his workspace +// Component that allows the developer to declare and configure a volume into their devworkspace type VolumeComponent struct { BaseComponent `json:",inline"` Volume `json:",inline"` diff --git a/pkg/apis/workspaces/v1alpha1/zz_generated.deepcopy.go b/pkg/apis/workspaces/v1alpha1/zz_generated.deepcopy.go index c530d3612..c6a4101b2 100644 --- a/pkg/apis/workspaces/v1alpha1/zz_generated.deepcopy.go +++ b/pkg/apis/workspaces/v1alpha1/zz_generated.deepcopy.go @@ -358,6 +358,57 @@ func (in *DevWorkspace) DeepCopyObject() runtime.Object { return nil } +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *DevWorkspaceCondition) DeepCopyInto(out *DevWorkspaceCondition) { + *out = *in + in.LastTransitionTime.DeepCopyInto(&out.LastTransitionTime) +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DevWorkspaceCondition. +func (in *DevWorkspaceCondition) DeepCopy() *DevWorkspaceCondition { + if in == nil { + return nil + } + out := new(DevWorkspaceCondition) + in.DeepCopyInto(out) + return out +} + +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *DevWorkspaceEvents) DeepCopyInto(out *DevWorkspaceEvents) { + *out = *in + if in.PreStart != nil { + in, out := &in.PreStart, &out.PreStart + *out = make([]string, len(*in)) + copy(*out, *in) + } + if in.PostStart != nil { + in, out := &in.PostStart, &out.PostStart + *out = make([]string, len(*in)) + copy(*out, *in) + } + if in.PreStop != nil { + in, out := &in.PreStop, &out.PreStop + *out = make([]string, len(*in)) + copy(*out, *in) + } + if in.PostStop != nil { + in, out := &in.PostStop, &out.PostStop + *out = make([]string, len(*in)) + copy(*out, *in) + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DevWorkspaceEvents. +func (in *DevWorkspaceEvents) DeepCopy() *DevWorkspaceEvents { + if in == nil { + return nil + } + out := new(DevWorkspaceEvents) + in.DeepCopyInto(out) + return out +} + // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *DevWorkspaceList) DeepCopyInto(out *DevWorkspaceList) { *out = *in @@ -390,6 +441,54 @@ func (in *DevWorkspaceList) DeepCopyObject() runtime.Object { return nil } +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *DevWorkspacePodContributions) DeepCopyInto(out *DevWorkspacePodContributions) { + *out = *in + if in.Volumes != nil { + in, out := &in.Volumes, &out.Volumes + *out = make([]v1.Volume, len(*in)) + for i := range *in { + (*in)[i].DeepCopyInto(&(*out)[i]) + } + } + if in.InitContainers != nil { + in, out := &in.InitContainers, &out.InitContainers + *out = make([]v1.Container, len(*in)) + for i := range *in { + (*in)[i].DeepCopyInto(&(*out)[i]) + } + } + if in.Containers != nil { + in, out := &in.Containers, &out.Containers + *out = make([]v1.Container, len(*in)) + for i := range *in { + (*in)[i].DeepCopyInto(&(*out)[i]) + } + } + if in.ImagePullSecrets != nil { + in, out := &in.ImagePullSecrets, &out.ImagePullSecrets + *out = make([]v1.LocalObjectReference, len(*in)) + copy(*out, *in) + } + if in.CommonEnv != nil { + in, out := &in.CommonEnv, &out.CommonEnv + *out = make([]v1.EnvVar, len(*in)) + for i := range *in { + (*in)[i].DeepCopyInto(&(*out)[i]) + } + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DevWorkspacePodContributions. +func (in *DevWorkspacePodContributions) DeepCopy() *DevWorkspacePodContributions { + if in == nil { + return nil + } + out := new(DevWorkspacePodContributions) + in.DeepCopyInto(out) + return out +} + // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *DevWorkspaceSpec) DeepCopyInto(out *DevWorkspaceSpec) { *out = *in @@ -411,7 +510,7 @@ func (in *DevWorkspaceStatus) DeepCopyInto(out *DevWorkspaceStatus) { *out = *in if in.Conditions != nil { in, out := &in.Conditions, &out.Conditions - *out = make([]WorkspaceCondition, len(*in)) + *out = make([]DevWorkspaceCondition, len(*in)) for i := range *in { (*in)[i].DeepCopyInto(&(*out)[i]) } @@ -595,7 +694,7 @@ func (in *EnvVar) DeepCopy() *EnvVar { // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *Events) DeepCopyInto(out *Events) { *out = *in - in.WorkspaceEvents.DeepCopyInto(&out.WorkspaceEvents) + in.DevWorkspaceEvents.DeepCopyInto(&out.DevWorkspaceEvents) } // DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Events. @@ -1150,105 +1249,6 @@ func (in *VscodeConfigurationCommandLocation) DeepCopy() *VscodeConfigurationCom return out } -// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. -func (in *WorkspaceCondition) DeepCopyInto(out *WorkspaceCondition) { - *out = *in - in.LastTransitionTime.DeepCopyInto(&out.LastTransitionTime) -} - -// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkspaceCondition. -func (in *WorkspaceCondition) DeepCopy() *WorkspaceCondition { - if in == nil { - return nil - } - out := new(WorkspaceCondition) - in.DeepCopyInto(out) - return out -} - -// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. -func (in *WorkspaceEvents) DeepCopyInto(out *WorkspaceEvents) { - *out = *in - if in.PreStart != nil { - in, out := &in.PreStart, &out.PreStart - *out = make([]string, len(*in)) - copy(*out, *in) - } - if in.PostStart != nil { - in, out := &in.PostStart, &out.PostStart - *out = make([]string, len(*in)) - copy(*out, *in) - } - if in.PreStop != nil { - in, out := &in.PreStop, &out.PreStop - *out = make([]string, len(*in)) - copy(*out, *in) - } - if in.PostStop != nil { - in, out := &in.PostStop, &out.PostStop - *out = make([]string, len(*in)) - copy(*out, *in) - } -} - -// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkspaceEvents. -func (in *WorkspaceEvents) DeepCopy() *WorkspaceEvents { - if in == nil { - return nil - } - out := new(WorkspaceEvents) - in.DeepCopyInto(out) - return out -} - -// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. -func (in *WorkspacePodContributions) DeepCopyInto(out *WorkspacePodContributions) { - *out = *in - if in.Volumes != nil { - in, out := &in.Volumes, &out.Volumes - *out = make([]v1.Volume, len(*in)) - for i := range *in { - (*in)[i].DeepCopyInto(&(*out)[i]) - } - } - if in.InitContainers != nil { - in, out := &in.InitContainers, &out.InitContainers - *out = make([]v1.Container, len(*in)) - for i := range *in { - (*in)[i].DeepCopyInto(&(*out)[i]) - } - } - if in.Containers != nil { - in, out := &in.Containers, &out.Containers - *out = make([]v1.Container, len(*in)) - for i := range *in { - (*in)[i].DeepCopyInto(&(*out)[i]) - } - } - if in.ImagePullSecrets != nil { - in, out := &in.ImagePullSecrets, &out.ImagePullSecrets - *out = make([]v1.LocalObjectReference, len(*in)) - copy(*out, *in) - } - if in.CommonEnv != nil { - in, out := &in.CommonEnv, &out.CommonEnv - *out = make([]v1.EnvVar, len(*in)) - for i := range *in { - (*in)[i].DeepCopyInto(&(*out)[i]) - } - } -} - -// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkspacePodContributions. -func (in *WorkspacePodContributions) DeepCopy() *WorkspacePodContributions { - if in == nil { - return nil - } - out := new(WorkspacePodContributions) - in.DeepCopyInto(out) - return out -} - // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *ZipProjectSource) DeepCopyInto(out *ZipProjectSource) { *out = *in diff --git a/pkg/apis/workspaces/v1alpha2/WorkspacePodContribution.go b/pkg/apis/workspaces/v1alpha2/WorkspacePodContribution.go index c85595ff4..6093ad8b5 100644 --- a/pkg/apis/workspaces/v1alpha2/WorkspacePodContribution.go +++ b/pkg/apis/workspaces/v1alpha2/WorkspacePodContribution.go @@ -4,7 +4,7 @@ import ( corev1 "k8s.io/api/core/v1" ) -type WorkspacePodContributions struct { +type DevWorkspacePodContributions struct { // +optional // +patchMergeKey=name // +patchStrategy=merge,retainKeys @@ -15,7 +15,7 @@ type WorkspacePodContributions struct { // +patchMergeKey=name // +patchStrategy=merge Containers []corev1.Container `json:"containers" patchStrategy:"merge" patchMergeKey:"name" protobuf:"bytes,2,rep,name=containers"` - // ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by the workspace Pod. + // ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by the devworkspace Pod. // If specified, these secrets will be passed to individual puller implementations for them to use. For example, // in the case of docker, only DockerConfig type secrets are honored. // More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod @@ -23,7 +23,7 @@ type WorkspacePodContributions struct { // +patchMergeKey=name // +patchStrategy=merge ImagePullSecrets []corev1.LocalObjectReference `json:"imagePullSecrets,omitempty" patchStrategy:"merge" patchMergeKey:"name" protobuf:"bytes,15,rep,name=imagePullSecrets"` - // List of workspace-wide environment variables to set in all containers of the workspace POD. + // List of devworkspace-wide environment variables to set in all containers of the devworkspace POD. // +optional // +patchMergeKey=name // +patchStrategy=merge diff --git a/pkg/apis/workspaces/v1alpha2/commands.go b/pkg/apis/workspaces/v1alpha2/commands.go index 7c2872c3c..0abf13eef 100644 --- a/pkg/apis/workspaces/v1alpha2/commands.go +++ b/pkg/apis/workspaces/v1alpha2/commands.go @@ -67,7 +67,7 @@ type Command struct { // +union type CommandUnion struct { - // Type of workspace command + // Type of devworkspace command // +unionDiscriminator // +optional CommandType CommandType `json:"commandType,omitempty"` @@ -77,15 +77,15 @@ type CommandUnion struct { Exec *ExecCommand `json:"exec,omitempty"` // Command that consists in applying a given component definition, - // typically bound to a workspace event. + // typically bound to a devworkspace event. // // For example, when an `apply` command is bound to a `preStart` event, // and references a `container` component, it will start the container as a - // K8S initContainer in the workspace POD, unless the component has its + // K8S initContainer in the devworkspace POD, unless the component has its // `dedicatedPod` field set to `true`. // // When no `apply` command exist for a given component, - // it is assumed the component will be applied at workspace start + // it is assumed the component will be applied at devworkspace start // by default. // +optional Apply *ApplyCommand `json:"apply,omitempty"` diff --git a/pkg/apis/workspaces/v1alpha2/components.go b/pkg/apis/workspaces/v1alpha2/components.go index 20b4b682b..519210729 100644 --- a/pkg/apis/workspaces/v1alpha2/components.go +++ b/pkg/apis/workspaces/v1alpha2/components.go @@ -19,8 +19,8 @@ const ( CustomComponentType ComponentType = "Custom" ) -// Workspace component: Anything that will bring additional features / tooling / behaviour / context -// to the workspace, in order to make working in it easier. +// DevWorkspace component: Anything that will bring additional features / tooling / behaviour / context +// to the devworkspace, in order to make working in it easier. type BaseComponent struct { } @@ -46,18 +46,18 @@ type ComponentUnion struct { // +optional ComponentType ComponentType `json:"componentType,omitempty"` - // Allows adding and configuring workspace-related containers + // Allows adding and configuring devworkspace-related containers // +optional Container *ContainerComponent `json:"container,omitempty"` - // Allows importing into the workspace the Kubernetes resources + // Allows importing into the devworkspace the Kubernetes resources // defined in a given manifest. For example this allows reusing the Kubernetes // definitions used to deploy some runtime components in production. // // +optional Kubernetes *KubernetesComponent `json:"kubernetes,omitempty"` - // Allows importing into the workspace the OpenShift resources + // Allows importing into the devworkspace the OpenShift resources // defined in a given manifest. For example this allows reusing the OpenShift // definitions used to deploy some runtime components in production. // diff --git a/pkg/apis/workspaces/v1alpha2/containerComponent.go b/pkg/apis/workspaces/v1alpha2/containerComponent.go index 8e7c7eb91..bec6b34e7 100644 --- a/pkg/apis/workspaces/v1alpha2/containerComponent.go +++ b/pkg/apis/workspaces/v1alpha2/containerComponent.go @@ -1,6 +1,6 @@ package v1alpha2 -// Component that allows the developer to add a configured container into his workspace +// Component that allows the developer to add a configured container into their devworkspace type ContainerComponent struct { BaseComponent `json:",inline"` Container `json:",inline"` diff --git a/pkg/apis/workspaces/v1alpha2/devfile.go b/pkg/apis/workspaces/v1alpha2/devfile.go index 2d4681521..9236b8464 100644 --- a/pkg/apis/workspaces/v1alpha2/devfile.go +++ b/pkg/apis/workspaces/v1alpha2/devfile.go @@ -4,7 +4,7 @@ import ( "github.com/devfile/api/v2/pkg/devfile" ) -// Devfile describes the structure of a cloud-native workspace and development environment. +// Devfile describes the structure of a cloud-native devworkspace and development environment. // +k8s:deepcopy-gen=false // +devfile:jsonschema:generate:omitCustomUnionMembers=true type Devfile struct { diff --git a/pkg/apis/workspaces/v1alpha2/devworkspaceTemplateSpec.go b/pkg/apis/workspaces/v1alpha2/devworkspaceTemplateSpec.go index 96d10a508..6511bcfa0 100644 --- a/pkg/apis/workspaces/v1alpha2/devworkspaceTemplateSpec.go +++ b/pkg/apis/workspaces/v1alpha2/devworkspaceTemplateSpec.go @@ -1,9 +1,9 @@ package v1alpha2 -// Structure of the workspace. This is also the specification of a workspace template. +// Structure of the devworkspace. This is also the specification of a devworkspace template. // +devfile:jsonschema:generate type DevWorkspaceTemplateSpec struct { - // Parent workspace template + // Parent devworkspace template // +optional Parent *Parent `json:"parent,omitempty"` @@ -12,7 +12,7 @@ type DevWorkspaceTemplateSpec struct { // +devfile:overrides:generate type DevWorkspaceTemplateSpecContent struct { - // List of the workspace components, such as editor and plugins, + // List of the devworkspace components, such as editor and plugins, // user-provided containers, or other types of components // +optional // +patchMergeKey=name @@ -21,7 +21,7 @@ type DevWorkspaceTemplateSpecContent struct { // +devfile:toplevellist Components []Component `json:"components,omitempty" patchStrategy:"merge" patchMergeKey:"name"` - // Projects worked on in the workspace, containing names and sources locations + // Projects worked on in the devworkspace, containing names and sources locations // +optional // +patchMergeKey=name // +patchStrategy=merge @@ -37,7 +37,7 @@ type DevWorkspaceTemplateSpecContent struct { // +devfile:toplevellist StarterProjects []StarterProject `json:"starterProjects,omitempty" patchStrategy:"merge" patchMergeKey:"name"` - // Predefined, ready-to-use, workspace-related commands + // Predefined, ready-to-use, devworkspace-related commands // +optional // +patchMergeKey=id // +patchStrategy=merge diff --git a/pkg/apis/workspaces/v1alpha2/devworkspace_types.go b/pkg/apis/workspaces/v1alpha2/devworkspace_types.go index 03055b8b6..c8411a02f 100644 --- a/pkg/apis/workspaces/v1alpha2/devworkspace_types.go +++ b/pkg/apis/workspaces/v1alpha2/devworkspace_types.go @@ -14,34 +14,34 @@ type DevWorkspaceSpec struct { // DevWorkspaceStatus defines the observed state of DevWorkspace type DevWorkspaceStatus struct { - // Id of the workspace - WorkspaceId string `json:"workspaceId"` - // URL at which the Worksace Editor can be joined - IdeUrl string `json:"ideUrl,omitempty"` - Phase WorkspacePhase `json:"phase,omitempty"` + // Id of the DevWorkspace + DevWorkspaceId string `json:"devWorkspaceId"` + // URL at which the DevWorkspace Editor can be joined + IdeUrl string `json:"ideUrl,omitempty"` + Phase DevWorkspacePhase `json:"phase,omitempty"` // Conditions represent the latest available observations of an object's state - Conditions []WorkspaceCondition `json:"conditions,omitempty"` + Conditions []DevWorkspaceCondition `json:"conditions,omitempty"` // Message is a short user-readable message giving additional information // about an object's state Message string `json:"message,omitempty"` } -type WorkspacePhase string +type DevWorkspacePhase string -// Valid workspace Statuses +// Valid devworkspace Statuses const ( - WorkspaceStatusStarting WorkspacePhase = "Starting" - WorkspaceStatusRunning WorkspacePhase = "Running" - WorkspaceStatusStopped WorkspacePhase = "Stopped" - WorkspaceStatusStopping WorkspacePhase = "Stopping" - WorkspaceStatusFailed WorkspacePhase = "Failed" - WorkspaceStatusError WorkspacePhase = "Error" + DevWorkspaceStatusStarting DevWorkspacePhase = "Starting" + DevWorkspaceStatusRunning DevWorkspacePhase = "Running" + DevWorkspaceStatusStopped DevWorkspacePhase = "Stopped" + DevWorkspaceStatusStopping DevWorkspacePhase = "Stopping" + DevWorkspaceStatusFailed DevWorkspacePhase = "Failed" + DevWorkspaceStatusError DevWorkspacePhase = "Error" ) -// WorkspaceCondition contains details for the current condition of this workspace. -type WorkspaceCondition struct { +// DevWorkspaceCondition contains details for the current condition of this devworkspace. +type DevWorkspaceCondition struct { // Type is the type of the condition. - Type WorkspaceConditionType `json:"type"` + Type DevWorkspaceConditionType `json:"type"` // Phase is the status of the condition. // Can be True, False, Unknown. Status corev1.ConditionStatus `json:"status"` @@ -53,16 +53,16 @@ type WorkspaceCondition struct { Message string `json:"message,omitempty"` } -// Types of conditions reported by workspace -type WorkspaceConditionType string +// Types of conditions reported by devworkspace +type DevWorkspaceConditionType string const ( - WorkspaceComponentsReady WorkspaceConditionType = "ComponentsReady" - WorkspaceRoutingReady WorkspaceConditionType = "RoutingReady" - WorkspaceServiceAccountReady WorkspaceConditionType = "ServiceAccountReady" - WorkspaceReady WorkspaceConditionType = "Ready" - WorkspaceFailedStart WorkspaceConditionType = "FailedStart" - WorkspaceError WorkspaceConditionType = "Error" + DevWorkspaceComponentsReady DevWorkspaceConditionType = "ComponentsReady" + DevWorkspaceRoutingReady DevWorkspaceConditionType = "RoutingReady" + DevWorkspaceServiceAccountReady DevWorkspaceConditionType = "ServiceAccountReady" + DevWorkspaceReady DevWorkspaceConditionType = "Ready" + DevWorkspaceFailedStart DevWorkspaceConditionType = "FailedStart" + DevWorkspaceError DevWorkspaceConditionType = "Error" ) // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object @@ -70,9 +70,9 @@ const ( // DevWorkspace is the Schema for the devworkspaces API // +kubebuilder:subresource:status // +kubebuilder:resource:path=devworkspaces,scope=Namespaced,shortName=dw -// +kubebuilder:printcolumn:name="Workspace ID",type="string",JSONPath=".status.workspaceId",description="The workspace's unique id" -// +kubebuilder:printcolumn:name="Phase",type="string",JSONPath=".status.phase",description="The current workspace startup phase" -// +kubebuilder:printcolumn:name="Info",type="string",JSONPath=".status.message",description="Additional information about the workspace" +// +kubebuilder:printcolumn:name="DevWorkspace ID",type="string",JSONPath=".status.devWorkspaceId",description="The devworkspace's unique id" +// +kubebuilder:printcolumn:name="Phase",type="string",JSONPath=".status.phase",description="The current devworkspace startup phase" +// +kubebuilder:printcolumn:name="Info",type="string",JSONPath=".status.message",description="Additional information about the devworkspace" // +devfile:jsonschema:generate // +kubebuilder:storageversion type DevWorkspace struct { diff --git a/pkg/apis/workspaces/v1alpha2/endpoint.go b/pkg/apis/workspaces/v1alpha2/endpoint.go index d54bb2c91..b01698469 100644 --- a/pkg/apis/workspaces/v1alpha2/endpoint.go +++ b/pkg/apis/workspaces/v1alpha2/endpoint.go @@ -37,12 +37,12 @@ const ( // Endpoint will be exposed on the public network, typically through // a K8S ingress or an OpenShift route PublicEndpointExposure EndpointExposure = "public" - // Endpoint will be exposed internally outside of the main workspace POD, + // Endpoint will be exposed internally outside of the main devworkspace POD, // typically by K8S services, to be consumed by other elements running // on the same cloud internal network. InternalEndpointExposure EndpointExposure = "internal" // Endpoint will not be exposed and will only be accessible - // inside the main workspace POD, on a local address. + // inside the main devworkspace POD, on a local address. NoneEndpointExposure EndpointExposure = "none" ) @@ -58,12 +58,12 @@ type Endpoint struct { // - `public` means that the endpoint will be exposed on the public network, typically through // a K8S ingress or an OpenShift route. // - // - `internal` means that the endpoint will be exposed internally outside of the main workspace POD, + // - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, // typically by K8S services, to be consumed by other elements running // on the same cloud internal network. // // - `none` means that the endpoint will not be exposed and will only be accessible - // inside the main workspace POD, on a local address. + // inside the main devworkspace POD, on a local address. // // Default value is `public` // +optional diff --git a/pkg/apis/workspaces/v1alpha2/events.go b/pkg/apis/workspaces/v1alpha2/events.go index b6986ce32..2a8bd91a5 100644 --- a/pkg/apis/workspaces/v1alpha2/events.go +++ b/pkg/apis/workspaces/v1alpha2/events.go @@ -1,26 +1,26 @@ package v1alpha2 type Events struct { - WorkspaceEvents `json:",inline"` + DevWorkspaceEvents `json:",inline"` } -type WorkspaceEvents struct { - // IDs of commands that should be executed before the workspace start. - // Kubernetes-wise, these commands would typically be executed in init containers of the workspace POD. +type DevWorkspaceEvents struct { + // IDs of commands that should be executed before the devworkspace start. + // Kubernetes-wise, these commands would typically be executed in init containers of the devworkspace POD. // +optional PreStart []string `json:"preStart,omitempty"` - // IDs of commands that should be executed after the workspace is completely started. + // IDs of commands that should be executed after the devworkspace is completely started. // In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. // This means that those commands are not triggered until the user opens the IDE in his browser. // +optional PostStart []string `json:"postStart,omitempty"` // +optional - // IDs of commands that should be executed before stopping the workspace. + // IDs of commands that should be executed before stopping the devworkspace. PreStop []string `json:"preStop,omitempty"` // +optional - // IDs of commands that should be executed after stopping the workspace. + // IDs of commands that should be executed after stopping the devworkspace. PostStop []string `json:"postStop,omitempty"` } diff --git a/pkg/apis/workspaces/v1alpha2/kubernetesLikeComponent.go b/pkg/apis/workspaces/v1alpha2/kubernetesLikeComponent.go index 02a18ed71..483735c0f 100644 --- a/pkg/apis/workspaces/v1alpha2/kubernetesLikeComponent.go +++ b/pkg/apis/workspaces/v1alpha2/kubernetesLikeComponent.go @@ -34,12 +34,12 @@ type K8sLikeComponent struct { Endpoints []Endpoint `json:"endpoints,omitempty" patchStrategy:"merge" patchMergeKey:"name"` } -// Component that allows partly importing Kubernetes resources into the workspace POD +// Component that allows partly importing Kubernetes resources into the devworkspace POD type KubernetesComponent struct { K8sLikeComponent `json:",inline"` } -// Component that allows partly importing Openshift resources into the workspace POD +// Component that allows partly importing Openshift resources into the devworkspace POD type OpenshiftComponent struct { K8sLikeComponent `json:",inline"` } diff --git a/pkg/apis/workspaces/v1alpha2/volumeComponent.go b/pkg/apis/workspaces/v1alpha2/volumeComponent.go index 6323180a2..54d3ecbbb 100644 --- a/pkg/apis/workspaces/v1alpha2/volumeComponent.go +++ b/pkg/apis/workspaces/v1alpha2/volumeComponent.go @@ -1,6 +1,6 @@ package v1alpha2 -// Component that allows the developer to declare and configure a volume into his workspace +// Component that allows the developer to declare and configure a volume into their devworkspace type VolumeComponent struct { BaseComponent `json:",inline"` Volume `json:",inline"` diff --git a/pkg/apis/workspaces/v1alpha2/zz_generated.deepcopy.go b/pkg/apis/workspaces/v1alpha2/zz_generated.deepcopy.go index 6647e17eb..b4f23be28 100644 --- a/pkg/apis/workspaces/v1alpha2/zz_generated.deepcopy.go +++ b/pkg/apis/workspaces/v1alpha2/zz_generated.deepcopy.go @@ -1214,6 +1214,57 @@ func (in *DevWorkspace) DeepCopyObject() runtime.Object { return nil } +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *DevWorkspaceCondition) DeepCopyInto(out *DevWorkspaceCondition) { + *out = *in + in.LastTransitionTime.DeepCopyInto(&out.LastTransitionTime) +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DevWorkspaceCondition. +func (in *DevWorkspaceCondition) DeepCopy() *DevWorkspaceCondition { + if in == nil { + return nil + } + out := new(DevWorkspaceCondition) + in.DeepCopyInto(out) + return out +} + +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *DevWorkspaceEvents) DeepCopyInto(out *DevWorkspaceEvents) { + *out = *in + if in.PreStart != nil { + in, out := &in.PreStart, &out.PreStart + *out = make([]string, len(*in)) + copy(*out, *in) + } + if in.PostStart != nil { + in, out := &in.PostStart, &out.PostStart + *out = make([]string, len(*in)) + copy(*out, *in) + } + if in.PreStop != nil { + in, out := &in.PreStop, &out.PreStop + *out = make([]string, len(*in)) + copy(*out, *in) + } + if in.PostStop != nil { + in, out := &in.PostStop, &out.PostStop + *out = make([]string, len(*in)) + copy(*out, *in) + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DevWorkspaceEvents. +func (in *DevWorkspaceEvents) DeepCopy() *DevWorkspaceEvents { + if in == nil { + return nil + } + out := new(DevWorkspaceEvents) + in.DeepCopyInto(out) + return out +} + // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *DevWorkspaceList) DeepCopyInto(out *DevWorkspaceList) { *out = *in @@ -1246,6 +1297,54 @@ func (in *DevWorkspaceList) DeepCopyObject() runtime.Object { return nil } +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *DevWorkspacePodContributions) DeepCopyInto(out *DevWorkspacePodContributions) { + *out = *in + if in.Volumes != nil { + in, out := &in.Volumes, &out.Volumes + *out = make([]v1.Volume, len(*in)) + for i := range *in { + (*in)[i].DeepCopyInto(&(*out)[i]) + } + } + if in.InitContainers != nil { + in, out := &in.InitContainers, &out.InitContainers + *out = make([]v1.Container, len(*in)) + for i := range *in { + (*in)[i].DeepCopyInto(&(*out)[i]) + } + } + if in.Containers != nil { + in, out := &in.Containers, &out.Containers + *out = make([]v1.Container, len(*in)) + for i := range *in { + (*in)[i].DeepCopyInto(&(*out)[i]) + } + } + if in.ImagePullSecrets != nil { + in, out := &in.ImagePullSecrets, &out.ImagePullSecrets + *out = make([]v1.LocalObjectReference, len(*in)) + copy(*out, *in) + } + if in.CommonEnv != nil { + in, out := &in.CommonEnv, &out.CommonEnv + *out = make([]v1.EnvVar, len(*in)) + for i := range *in { + (*in)[i].DeepCopyInto(&(*out)[i]) + } + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DevWorkspacePodContributions. +func (in *DevWorkspacePodContributions) DeepCopy() *DevWorkspacePodContributions { + if in == nil { + return nil + } + out := new(DevWorkspacePodContributions) + in.DeepCopyInto(out) + return out +} + // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *DevWorkspaceSpec) DeepCopyInto(out *DevWorkspaceSpec) { *out = *in @@ -1267,7 +1366,7 @@ func (in *DevWorkspaceStatus) DeepCopyInto(out *DevWorkspaceStatus) { *out = *in if in.Conditions != nil { in, out := &in.Conditions, &out.Conditions - *out = make([]WorkspaceCondition, len(*in)) + *out = make([]DevWorkspaceCondition, len(*in)) for i := range *in { (*in)[i].DeepCopyInto(&(*out)[i]) } @@ -1562,7 +1661,7 @@ func (in *EnvVarPluginOverrideParentOverride) DeepCopy() *EnvVarPluginOverridePa // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *Events) DeepCopyInto(out *Events) { *out = *in - in.WorkspaceEvents.DeepCopyInto(&out.WorkspaceEvents) + in.DevWorkspaceEvents.DeepCopyInto(&out.DevWorkspaceEvents) } // DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Events. @@ -2796,105 +2895,6 @@ func (in *VolumePluginOverrideParentOverride) DeepCopy() *VolumePluginOverridePa return out } -// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. -func (in *WorkspaceCondition) DeepCopyInto(out *WorkspaceCondition) { - *out = *in - in.LastTransitionTime.DeepCopyInto(&out.LastTransitionTime) -} - -// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkspaceCondition. -func (in *WorkspaceCondition) DeepCopy() *WorkspaceCondition { - if in == nil { - return nil - } - out := new(WorkspaceCondition) - in.DeepCopyInto(out) - return out -} - -// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. -func (in *WorkspaceEvents) DeepCopyInto(out *WorkspaceEvents) { - *out = *in - if in.PreStart != nil { - in, out := &in.PreStart, &out.PreStart - *out = make([]string, len(*in)) - copy(*out, *in) - } - if in.PostStart != nil { - in, out := &in.PostStart, &out.PostStart - *out = make([]string, len(*in)) - copy(*out, *in) - } - if in.PreStop != nil { - in, out := &in.PreStop, &out.PreStop - *out = make([]string, len(*in)) - copy(*out, *in) - } - if in.PostStop != nil { - in, out := &in.PostStop, &out.PostStop - *out = make([]string, len(*in)) - copy(*out, *in) - } -} - -// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkspaceEvents. -func (in *WorkspaceEvents) DeepCopy() *WorkspaceEvents { - if in == nil { - return nil - } - out := new(WorkspaceEvents) - in.DeepCopyInto(out) - return out -} - -// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. -func (in *WorkspacePodContributions) DeepCopyInto(out *WorkspacePodContributions) { - *out = *in - if in.Volumes != nil { - in, out := &in.Volumes, &out.Volumes - *out = make([]v1.Volume, len(*in)) - for i := range *in { - (*in)[i].DeepCopyInto(&(*out)[i]) - } - } - if in.InitContainers != nil { - in, out := &in.InitContainers, &out.InitContainers - *out = make([]v1.Container, len(*in)) - for i := range *in { - (*in)[i].DeepCopyInto(&(*out)[i]) - } - } - if in.Containers != nil { - in, out := &in.Containers, &out.Containers - *out = make([]v1.Container, len(*in)) - for i := range *in { - (*in)[i].DeepCopyInto(&(*out)[i]) - } - } - if in.ImagePullSecrets != nil { - in, out := &in.ImagePullSecrets, &out.ImagePullSecrets - *out = make([]v1.LocalObjectReference, len(*in)) - copy(*out, *in) - } - if in.CommonEnv != nil { - in, out := &in.CommonEnv, &out.CommonEnv - *out = make([]v1.EnvVar, len(*in)) - for i := range *in { - (*in)[i].DeepCopyInto(&(*out)[i]) - } - } -} - -// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkspacePodContributions. -func (in *WorkspacePodContributions) DeepCopy() *WorkspacePodContributions { - if in == nil { - return nil - } - out := new(WorkspacePodContributions) - in.DeepCopyInto(out) - return out -} - // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *ZipProjectSource) DeepCopyInto(out *ZipProjectSource) { *out = *in diff --git a/pkg/apis/workspaces/v1alpha2/zz_generated.parent_overrides.go b/pkg/apis/workspaces/v1alpha2/zz_generated.parent_overrides.go index 292203982..bcc457cc0 100644 --- a/pkg/apis/workspaces/v1alpha2/zz_generated.parent_overrides.go +++ b/pkg/apis/workspaces/v1alpha2/zz_generated.parent_overrides.go @@ -126,18 +126,18 @@ type ComponentUnionParentOverride struct { // +optional ComponentType ComponentTypeParentOverride `json:"componentType,omitempty"` - // Allows adding and configuring workspace-related containers + // Allows adding and configuring devworkspace-related containers // +optional Container *ContainerComponentParentOverride `json:"container,omitempty"` - // Allows importing into the workspace the Kubernetes resources + // Allows importing into the devworkspace the Kubernetes resources // defined in a given manifest. For example this allows reusing the Kubernetes // definitions used to deploy some runtime components in production. // // +optional Kubernetes *KubernetesComponentParentOverride `json:"kubernetes,omitempty"` - // Allows importing into the workspace the OpenShift resources + // Allows importing into the devworkspace the OpenShift resources // defined in a given manifest. For example this allows reusing the OpenShift // definitions used to deploy some runtime components in production. // @@ -187,7 +187,7 @@ type ProjectSourceParentOverride struct { type CommandUnionParentOverride struct { // +kubebuilder:validation:Enum=Exec;Apply;Composite - // Type of workspace command + // Type of devworkspace command // +unionDiscriminator // +optional CommandType CommandTypeParentOverride `json:"commandType,omitempty"` @@ -197,15 +197,15 @@ type CommandUnionParentOverride struct { Exec *ExecCommandParentOverride `json:"exec,omitempty"` // Command that consists in applying a given component definition, - // typically bound to a workspace event. + // typically bound to a devworkspace event. // // For example, when an `apply` command is bound to a `preStart` event, // and references a `container` component, it will start the container as a - // K8S initContainer in the workspace POD, unless the component has its + // K8S initContainer in the devworkspace POD, unless the component has its // `dedicatedPod` field set to `true`. // // When no `apply` command exist for a given component, - // it is assumed the component will be applied at workspace start + // it is assumed the component will be applied at devworkspace start // by default. // +optional Apply *ApplyCommandParentOverride `json:"apply,omitempty"` @@ -220,24 +220,24 @@ type CommandUnionParentOverride struct { // Only one of the following component type may be specified. type ComponentTypeParentOverride string -// Component that allows the developer to add a configured container into his workspace +// Component that allows the developer to add a configured container into their devworkspace type ContainerComponentParentOverride struct { BaseComponentParentOverride `json:",inline"` ContainerParentOverride `json:",inline"` Endpoints []EndpointParentOverride `json:"endpoints,omitempty" patchStrategy:"merge" patchMergeKey:"name"` } -// Component that allows partly importing Kubernetes resources into the workspace POD +// Component that allows partly importing Kubernetes resources into the devworkspace POD type KubernetesComponentParentOverride struct { K8sLikeComponentParentOverride `json:",inline"` } -// Component that allows partly importing Openshift resources into the workspace POD +// Component that allows partly importing Openshift resources into the devworkspace POD type OpenshiftComponentParentOverride struct { K8sLikeComponentParentOverride `json:",inline"` } -// Component that allows the developer to declare and configure a volume into his workspace +// Component that allows the developer to declare and configure a volume into their devworkspace type VolumeComponentParentOverride struct { BaseComponentParentOverride `json:",inline"` VolumeParentOverride `json:",inline"` @@ -338,8 +338,8 @@ type CompositeCommandParentOverride struct { Parallel bool `json:"parallel,omitempty"` } -// Workspace component: Anything that will bring additional features / tooling / behaviour / context -// to the workspace, in order to make working in it easier. +// DevWorkspace component: Anything that will bring additional features / tooling / behaviour / context +// to the devworkspace, in order to make working in it easier. type BaseComponentParentOverride struct { } @@ -422,12 +422,12 @@ type EndpointParentOverride struct { // - `public` means that the endpoint will be exposed on the public network, typically through // a K8S ingress or an OpenShift route. // - // - `internal` means that the endpoint will be exposed internally outside of the main workspace POD, + // - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, // typically by K8S services, to be consumed by other elements running // on the same cloud internal network. // // - `none` means that the endpoint will not be exposed and will only be accessible - // inside the main workspace POD, on a local address. + // inside the main devworkspace POD, on a local address. // // Default value is `public` // +optional @@ -700,18 +700,18 @@ type ComponentUnionPluginOverrideParentOverride struct { // +optional ComponentType ComponentTypePluginOverrideParentOverride `json:"componentType,omitempty"` - // Allows adding and configuring workspace-related containers + // Allows adding and configuring devworkspace-related containers // +optional Container *ContainerComponentPluginOverrideParentOverride `json:"container,omitempty"` - // Allows importing into the workspace the Kubernetes resources + // Allows importing into the devworkspace the Kubernetes resources // defined in a given manifest. For example this allows reusing the Kubernetes // definitions used to deploy some runtime components in production. // // +optional Kubernetes *KubernetesComponentPluginOverrideParentOverride `json:"kubernetes,omitempty"` - // Allows importing into the workspace the OpenShift resources + // Allows importing into the devworkspace the OpenShift resources // defined in a given manifest. For example this allows reusing the OpenShift // definitions used to deploy some runtime components in production. // @@ -728,7 +728,7 @@ type ComponentUnionPluginOverrideParentOverride struct { type CommandUnionPluginOverrideParentOverride struct { // +kubebuilder:validation:Enum=Exec;Apply;Composite - // Type of workspace command + // Type of devworkspace command // +unionDiscriminator // +optional CommandType CommandTypePluginOverrideParentOverride `json:"commandType,omitempty"` @@ -738,15 +738,15 @@ type CommandUnionPluginOverrideParentOverride struct { Exec *ExecCommandPluginOverrideParentOverride `json:"exec,omitempty"` // Command that consists in applying a given component definition, - // typically bound to a workspace event. + // typically bound to a devworkspace event. // // For example, when an `apply` command is bound to a `preStart` event, // and references a `container` component, it will start the container as a - // K8S initContainer in the workspace POD, unless the component has its + // K8S initContainer in the devworkspace POD, unless the component has its // `dedicatedPod` field set to `true`. // // When no `apply` command exist for a given component, - // it is assumed the component will be applied at workspace start + // it is assumed the component will be applied at devworkspace start // by default. // +optional Apply *ApplyCommandPluginOverrideParentOverride `json:"apply,omitempty"` @@ -772,24 +772,24 @@ type CommandGroupParentOverride struct { // Only one of the following component type may be specified. type ComponentTypePluginOverrideParentOverride string -// Component that allows the developer to add a configured container into his workspace +// Component that allows the developer to add a configured container into their devworkspace type ContainerComponentPluginOverrideParentOverride struct { BaseComponentPluginOverrideParentOverride `json:",inline"` ContainerPluginOverrideParentOverride `json:",inline"` Endpoints []EndpointPluginOverrideParentOverride `json:"endpoints,omitempty" patchStrategy:"merge" patchMergeKey:"name"` } -// Component that allows partly importing Kubernetes resources into the workspace POD +// Component that allows partly importing Kubernetes resources into the devworkspace POD type KubernetesComponentPluginOverrideParentOverride struct { K8sLikeComponentPluginOverrideParentOverride `json:",inline"` } -// Component that allows partly importing Openshift resources into the workspace POD +// Component that allows partly importing Openshift resources into the devworkspace POD type OpenshiftComponentPluginOverrideParentOverride struct { K8sLikeComponentPluginOverrideParentOverride `json:",inline"` } -// Component that allows the developer to declare and configure a volume into his workspace +// Component that allows the developer to declare and configure a volume into their devworkspace type VolumeComponentPluginOverrideParentOverride struct { BaseComponentPluginOverrideParentOverride `json:",inline"` VolumePluginOverrideParentOverride `json:",inline"` @@ -866,8 +866,8 @@ type CompositeCommandPluginOverrideParentOverride struct { // +kubebuilder:validation:Enum=build;run;test;debug type CommandGroupKindParentOverride string -// Workspace component: Anything that will bring additional features / tooling / behaviour / context -// to the workspace, in order to make working in it easier. +// DevWorkspace component: Anything that will bring additional features / tooling / behaviour / context +// to the devworkspace, in order to make working in it easier. type BaseComponentPluginOverrideParentOverride struct { } @@ -951,12 +951,12 @@ type EndpointPluginOverrideParentOverride struct { // - `public` means that the endpoint will be exposed on the public network, typically through // a K8S ingress or an OpenShift route. // - // - `internal` means that the endpoint will be exposed internally outside of the main workspace POD, + // - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, // typically by K8S services, to be consumed by other elements running // on the same cloud internal network. // // - `none` means that the endpoint will not be exposed and will only be accessible - // inside the main workspace POD, on a local address. + // inside the main devworkspace POD, on a local address. // // Default value is `public` // +optional diff --git a/pkg/apis/workspaces/v1alpha2/zz_generated.plugin_overrides.go b/pkg/apis/workspaces/v1alpha2/zz_generated.plugin_overrides.go index de0a7dc46..d94b3e685 100644 --- a/pkg/apis/workspaces/v1alpha2/zz_generated.plugin_overrides.go +++ b/pkg/apis/workspaces/v1alpha2/zz_generated.plugin_overrides.go @@ -66,18 +66,18 @@ type ComponentUnionPluginOverride struct { // +optional ComponentType ComponentTypePluginOverride `json:"componentType,omitempty"` - // Allows adding and configuring workspace-related containers + // Allows adding and configuring devworkspace-related containers // +optional Container *ContainerComponentPluginOverride `json:"container,omitempty"` - // Allows importing into the workspace the Kubernetes resources + // Allows importing into the devworkspace the Kubernetes resources // defined in a given manifest. For example this allows reusing the Kubernetes // definitions used to deploy some runtime components in production. // // +optional Kubernetes *KubernetesComponentPluginOverride `json:"kubernetes,omitempty"` - // Allows importing into the workspace the OpenShift resources + // Allows importing into the devworkspace the OpenShift resources // defined in a given manifest. For example this allows reusing the OpenShift // definitions used to deploy some runtime components in production. // @@ -94,7 +94,7 @@ type ComponentUnionPluginOverride struct { type CommandUnionPluginOverride struct { // +kubebuilder:validation:Enum=Exec;Apply;Composite - // Type of workspace command + // Type of devworkspace command // +unionDiscriminator // +optional CommandType CommandTypePluginOverride `json:"commandType,omitempty"` @@ -104,15 +104,15 @@ type CommandUnionPluginOverride struct { Exec *ExecCommandPluginOverride `json:"exec,omitempty"` // Command that consists in applying a given component definition, - // typically bound to a workspace event. + // typically bound to a devworkspace event. // // For example, when an `apply` command is bound to a `preStart` event, // and references a `container` component, it will start the container as a - // K8S initContainer in the workspace POD, unless the component has its + // K8S initContainer in the devworkspace POD, unless the component has its // `dedicatedPod` field set to `true`. // // When no `apply` command exist for a given component, - // it is assumed the component will be applied at workspace start + // it is assumed the component will be applied at devworkspace start // by default. // +optional Apply *ApplyCommandPluginOverride `json:"apply,omitempty"` @@ -127,24 +127,24 @@ type CommandUnionPluginOverride struct { // Only one of the following component type may be specified. type ComponentTypePluginOverride string -// Component that allows the developer to add a configured container into his workspace +// Component that allows the developer to add a configured container into their devworkspace type ContainerComponentPluginOverride struct { BaseComponentPluginOverride `json:",inline"` ContainerPluginOverride `json:",inline"` Endpoints []EndpointPluginOverride `json:"endpoints,omitempty" patchStrategy:"merge" patchMergeKey:"name"` } -// Component that allows partly importing Kubernetes resources into the workspace POD +// Component that allows partly importing Kubernetes resources into the devworkspace POD type KubernetesComponentPluginOverride struct { K8sLikeComponentPluginOverride `json:",inline"` } -// Component that allows partly importing Openshift resources into the workspace POD +// Component that allows partly importing Openshift resources into the devworkspace POD type OpenshiftComponentPluginOverride struct { K8sLikeComponentPluginOverride `json:",inline"` } -// Component that allows the developer to declare and configure a volume into his workspace +// Component that allows the developer to declare and configure a volume into their devworkspace type VolumeComponentPluginOverride struct { BaseComponentPluginOverride `json:",inline"` VolumePluginOverride `json:",inline"` @@ -217,8 +217,8 @@ type CompositeCommandPluginOverride struct { Parallel bool `json:"parallel,omitempty"` } -// Workspace component: Anything that will bring additional features / tooling / behaviour / context -// to the workspace, in order to make working in it easier. +// DevWorkspace component: Anything that will bring additional features / tooling / behaviour / context +// to the devworkspace, in order to make working in it easier. type BaseComponentPluginOverride struct { } @@ -301,12 +301,12 @@ type EndpointPluginOverride struct { // - `public` means that the endpoint will be exposed on the public network, typically through // a K8S ingress or an OpenShift route. // - // - `internal` means that the endpoint will be exposed internally outside of the main workspace POD, + // - `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, // typically by K8S services, to be consumed by other elements running // on the same cloud internal network. // // - `none` means that the endpoint will not be exposed and will only be accessible - // inside the main workspace POD, on a local address. + // inside the main devworkspace POD, on a local address. // // Default value is `public` // +optional diff --git a/pkg/utils/overriding/keys.go b/pkg/utils/overriding/keys.go index cca05ca96..27c7254c4 100644 --- a/pkg/utils/overriding/keys.go +++ b/pkg/utils/overriding/keys.go @@ -1,7 +1,7 @@ package overriding import ( - workspaces "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2" + devworkspaces "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2" "github.com/hashicorp/go-multierror" "k8s.io/apimachinery/pkg/util/sets" ) @@ -14,7 +14,7 @@ type checkFn func(elementType string, keysSets []sets.String) []error // For each type of top-level list, the `keysSets` argument that will be passed to the `doCheck` function // contains the the key sets that correspond to the `toplevelListContainers` passed to this method, // in the same order. -func checkKeys(doCheck checkFn, toplevelListContainers ...workspaces.TopLevelListContainer) error { +func checkKeys(doCheck checkFn, toplevelListContainers ...devworkspaces.TopLevelListContainer) error { var errors *multierror.Error // intermediate storage for the conversion []map[string]KeyedList -> map[string][]sets.String diff --git a/pkg/utils/overriding/merging.go b/pkg/utils/overriding/merging.go index 2ce6fc60c..7db05339d 100644 --- a/pkg/utils/overriding/merging.go +++ b/pkg/utils/overriding/merging.go @@ -5,7 +5,7 @@ import ( "reflect" "strings" - workspaces "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2" + devworkspaces "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2" "k8s.io/apimachinery/pkg/util/json" "k8s.io/apimachinery/pkg/util/sets" "k8s.io/apimachinery/pkg/util/yaml" @@ -21,11 +21,11 @@ import ( // The result is a transformed `DevWorkspaceTemplateSpec` object, that does not contain any `plugin` component // (since they are expected to be provided as flattened overridden devfiles in the arguments) func MergeDevWorkspaceTemplateSpec( - mainContent *workspaces.DevWorkspaceTemplateSpecContent, - parentFlattenedContent *workspaces.DevWorkspaceTemplateSpecContent, - pluginFlattenedContents ...*workspaces.DevWorkspaceTemplateSpecContent) (*workspaces.DevWorkspaceTemplateSpecContent, error) { + mainContent *devworkspaces.DevWorkspaceTemplateSpecContent, + parentFlattenedContent *devworkspaces.DevWorkspaceTemplateSpecContent, + pluginFlattenedContents ...*devworkspaces.DevWorkspaceTemplateSpecContent) (*devworkspaces.DevWorkspaceTemplateSpecContent, error) { - allContents := []*workspaces.DevWorkspaceTemplateSpecContent{} + allContents := []*devworkspaces.DevWorkspaceTemplateSpecContent{} if parentFlattenedContent != nil { allContents = append(allContents, parentFlattenedContent) } @@ -52,12 +52,12 @@ func MergeDevWorkspaceTemplateSpec( } } - result := workspaces.DevWorkspaceTemplateSpecContent{} + result := devworkspaces.DevWorkspaceTemplateSpecContent{} // Merge top-level lists (Commands, Projects, Components, etc ...) topLevelListsNames := result.GetToplevelLists() - topLevelListsByContent := []workspaces.TopLevelLists{} + topLevelListsByContent := []devworkspaces.TopLevelLists{} for _, content := range allContents { topLevelListsByContent = append(topLevelListsByContent, content.GetToplevelLists()) } @@ -78,7 +78,7 @@ func MergeDevWorkspaceTemplateSpec( keyedList := toplevelLists[toplevelListName] for _, keyed := range keyedList { if content == mainContent { - if component, isComponent := keyed.(workspaces.Component); isComponent && + if component, isComponent := keyed.(devworkspaces.Component); isComponent && component.Plugin != nil { continue } @@ -98,7 +98,7 @@ func MergeDevWorkspaceTemplateSpec( for _, content := range allContents { if content.Events != nil { if result.Events == nil { - result.Events = &workspaces.Events{} + result.Events = &devworkspaces.Events{} } preStartCommands = preStartCommands.Union(sets.NewString(content.Events.PreStart...)) postStartCommands = postStartCommands.Union(sets.NewString(content.Events.PostStart...)) @@ -126,13 +126,13 @@ func MergeDevWorkspaceTemplateSpec( // // The result is a transformed `DevfileWorkspaceTemplateSpec` object, that does not contain any `plugin` component // (since they are expected to be provided as flattened overridden devfiles in the arguments) -func MergeDevWorkspaceTemplateSpecBytes(originalBytes []byte, flattenedParentBytes []byte, flattenPluginsBytes ...[]byte) (*workspaces.DevWorkspaceTemplateSpecContent, error) { +func MergeDevWorkspaceTemplateSpecBytes(originalBytes []byte, flattenedParentBytes []byte, flattenPluginsBytes ...[]byte) (*devworkspaces.DevWorkspaceTemplateSpecContent, error) { originalJson, err := yaml.ToJSON(originalBytes) if err != nil { return nil, err } - original := workspaces.DevWorkspaceTemplateSpecContent{} + original := devworkspaces.DevWorkspaceTemplateSpecContent{} err = json.Unmarshal(originalJson, &original) if err != nil { return nil, err @@ -143,20 +143,20 @@ func MergeDevWorkspaceTemplateSpecBytes(originalBytes []byte, flattenedParentByt return nil, err } - flattenedParent := workspaces.DevWorkspaceTemplateSpecContent{} + flattenedParent := devworkspaces.DevWorkspaceTemplateSpecContent{} err = json.Unmarshal(flattenedParentJson, &flattenedParent) if err != nil { return nil, err } - flattenedPlugins := []*workspaces.DevWorkspaceTemplateSpecContent{} + flattenedPlugins := []*devworkspaces.DevWorkspaceTemplateSpecContent{} for _, flattenedPluginBytes := range flattenPluginsBytes { flattenedPluginJson, err := yaml.ToJSON(flattenedPluginBytes) if err != nil { return nil, err } - flattenedPlugin := workspaces.DevWorkspaceTemplateSpecContent{} + flattenedPlugin := devworkspaces.DevWorkspaceTemplateSpecContent{} err = json.Unmarshal(flattenedPluginJson, &flattenedPlugin) if err != nil { return nil, err @@ -167,7 +167,7 @@ func MergeDevWorkspaceTemplateSpecBytes(originalBytes []byte, flattenedParentByt return MergeDevWorkspaceTemplateSpec(&original, &flattenedParent, flattenedPlugins...) } -func ensureNoConflictWithParent(mainContent *workspaces.DevWorkspaceTemplateSpecContent, parentflattenedContent *workspaces.DevWorkspaceTemplateSpecContent) error { +func ensureNoConflictWithParent(mainContent *devworkspaces.DevWorkspaceTemplateSpecContent, parentflattenedContent *devworkspaces.DevWorkspaceTemplateSpecContent) error { return checkKeys(func(elementType string, keysSets []sets.String) []error { mainKeys := keysSets[0] parentOrPluginKeys := keysSets[1] @@ -183,7 +183,7 @@ func ensureNoConflictWithParent(mainContent *workspaces.DevWorkspaceTemplateSpec mainContent, parentflattenedContent) } -func ensureNoConflictsWithPlugins(mainContent *workspaces.DevWorkspaceTemplateSpecContent, pluginFlattenedContents ...*workspaces.DevWorkspaceTemplateSpecContent) error { +func ensureNoConflictsWithPlugins(mainContent *devworkspaces.DevWorkspaceTemplateSpecContent, pluginFlattenedContents ...*devworkspaces.DevWorkspaceTemplateSpecContent) error { getPluginKey := func(pluginIndex int) string { index := 0 for _, comp := range mainContent.Components { @@ -197,7 +197,7 @@ func ensureNoConflictsWithPlugins(mainContent *workspaces.DevWorkspaceTemplateSp return "unknown" } - allSpecs := []workspaces.TopLevelListContainer{mainContent} + allSpecs := []devworkspaces.TopLevelListContainer{mainContent} for _, pluginFlattenedContent := range pluginFlattenedContents { allSpecs = append(allSpecs, pluginFlattenedContent) } diff --git a/pkg/utils/overriding/overriding.go b/pkg/utils/overriding/overriding.go index 6eba4c417..1a6f1d25c 100644 --- a/pkg/utils/overriding/overriding.go +++ b/pkg/utils/overriding/overriding.go @@ -5,7 +5,7 @@ import ( "reflect" "strings" - workspaces "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2" + dw "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2" unions "github.com/devfile/api/v2/pkg/utils/unions" "k8s.io/apimachinery/pkg/util/json" "k8s.io/apimachinery/pkg/util/sets" @@ -21,13 +21,13 @@ import ( // https://github.com/kubernetes/community/blob/master/contributors/devel/sig-api-machinery/strategic-merge-patch.md#background // // The result is a transformed `DevfileWorkspaceTemplateSpec` object that can be serialized back to yaml or json. -func OverrideDevWorkspaceTemplateSpecBytes(originalBytes []byte, patchBytes []byte) (*workspaces.DevWorkspaceTemplateSpecContent, error) { +func OverrideDevWorkspaceTemplateSpecBytes(originalBytes []byte, patchBytes []byte) (*dw.DevWorkspaceTemplateSpecContent, error) { originalJson, err := yaml.ToJSON(originalBytes) if err != nil { return nil, err } - original := workspaces.DevWorkspaceTemplateSpecContent{} + original := dw.DevWorkspaceTemplateSpecContent{} err = json.Unmarshal(originalJson, &original) if err != nil { return nil, err @@ -38,7 +38,7 @@ func OverrideDevWorkspaceTemplateSpecBytes(originalBytes []byte, patchBytes []by return nil, err } - patch := workspaces.ParentOverrides{} + patch := dw.ParentOverrides{} err = json.Unmarshal(patchJson, &patch) if err != nil { return nil, err @@ -56,7 +56,7 @@ func OverrideDevWorkspaceTemplateSpecBytes(originalBytes []byte, patchBytes []by // https://github.com/kubernetes/community/blob/master/contributors/devel/sig-api-machinery/strategic-merge-patch.md#background // // The result is a transformed `DevfileWorkspaceTemplateSpec` object. -func OverrideDevWorkspaceTemplateSpec(original *workspaces.DevWorkspaceTemplateSpecContent, patch workspaces.Overrides) (*workspaces.DevWorkspaceTemplateSpecContent, error) { +func OverrideDevWorkspaceTemplateSpec(original *dw.DevWorkspaceTemplateSpecContent, patch dw.Overrides) (*dw.DevWorkspaceTemplateSpecContent, error) { if err := ensureOnlyExistingElementsAreOverridden(original, patch); err != nil { return nil, err } @@ -102,7 +102,7 @@ func OverrideDevWorkspaceTemplateSpec(original *workspaces.DevWorkspaceTemplateS return nil, err } - patched := workspaces.DevWorkspaceTemplateSpecContent{} + patched := dw.DevWorkspaceTemplateSpecContent{} err = json.Unmarshal(patchedBytes, &patched) if err != nil { return nil, err @@ -114,7 +114,7 @@ func OverrideDevWorkspaceTemplateSpec(original *workspaces.DevWorkspaceTemplateS return &patched, nil } -func ensureOnlyExistingElementsAreOverridden(spec *workspaces.DevWorkspaceTemplateSpecContent, overrides workspaces.Overrides) error { +func ensureOnlyExistingElementsAreOverridden(spec *dw.DevWorkspaceTemplateSpecContent, overrides dw.Overrides) error { return checkKeys(func(elementType string, keysSets []sets.String) []error { if len(keysSets) <= 1 { return []error{} diff --git a/pkg/utils/overriding/overriding_test.go b/pkg/utils/overriding/overriding_test.go index 4af4ab6fa..5b6af2dd5 100644 --- a/pkg/utils/overriding/overriding_test.go +++ b/pkg/utils/overriding/overriding_test.go @@ -7,7 +7,7 @@ import ( "strings" "testing" - workspaces "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2" + dw "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2" "github.com/stretchr/testify/assert" "k8s.io/apimachinery/pkg/util/json" yamlMachinery "k8s.io/apimachinery/pkg/util/yaml" @@ -15,19 +15,19 @@ import ( ) func TestBasicToplevelOverriding(t *testing.T) { - original := workspaces.DevWorkspaceTemplateSpecContent{ - Commands: []workspaces.Command{ + original := dw.DevWorkspaceTemplateSpecContent{ + Commands: []dw.Command{ { Id: "command-with-type-changed", - CommandUnion: workspaces.CommandUnion{ - Exec: &workspaces.ExecCommand{}, + CommandUnion: dw.CommandUnion{ + Exec: &dw.ExecCommand{}, }, }, { Id: "command-to-replace", - CommandUnion: workspaces.CommandUnion{ - Exec: &workspaces.ExecCommand{ - Env: []workspaces.EnvVar{ + CommandUnion: dw.CommandUnion{ + Exec: &dw.ExecCommand{ + Env: []dw.EnvVar{ { Name: "envVarToReplace", Value: "envVarToReplaceOriginalValue", @@ -42,9 +42,9 @@ func TestBasicToplevelOverriding(t *testing.T) { }, { Id: "command-not-changed", - CommandUnion: workspaces.CommandUnion{ - Exec: &workspaces.ExecCommand{ - LabeledCommand: workspaces.LabeledCommand{ + CommandUnion: dw.CommandUnion{ + Exec: &dw.ExecCommand{ + LabeledCommand: dw.LabeledCommand{ Label: "commandNotChangedLabel", }, }, @@ -53,21 +53,21 @@ func TestBasicToplevelOverriding(t *testing.T) { }, } - patch := workspaces.ParentOverrides{ - Commands: []workspaces.CommandParentOverride{ + patch := dw.ParentOverrides{ + Commands: []dw.CommandParentOverride{ { Id: "command-with-type-changed", - CommandUnionParentOverride: workspaces.CommandUnionParentOverride{ - Apply: &workspaces.ApplyCommandParentOverride{ + CommandUnionParentOverride: dw.CommandUnionParentOverride{ + Apply: &dw.ApplyCommandParentOverride{ Component: "mycomponent", }, }, }, { Id: "command-to-replace", - CommandUnionParentOverride: workspaces.CommandUnionParentOverride{ - Exec: &workspaces.ExecCommandParentOverride{ - Env: []workspaces.EnvVarParentOverride{ + CommandUnionParentOverride: dw.CommandUnionParentOverride{ + Exec: &dw.ExecCommandParentOverride{ + Env: []dw.EnvVarParentOverride{ { Name: "envVarToReplace", Value: "envVarToReplaceNewValue", @@ -83,21 +83,21 @@ func TestBasicToplevelOverriding(t *testing.T) { }, } - expected := &workspaces.DevWorkspaceTemplateSpecContent{ - Commands: []workspaces.Command{ + expected := &dw.DevWorkspaceTemplateSpecContent{ + Commands: []dw.Command{ { Id: "command-with-type-changed", - CommandUnion: workspaces.CommandUnion{ - Apply: &workspaces.ApplyCommand{ + CommandUnion: dw.CommandUnion{ + Apply: &dw.ApplyCommand{ Component: "mycomponent", }, }, }, { Id: "command-to-replace", - CommandUnion: workspaces.CommandUnion{ - Exec: &workspaces.ExecCommand{ - Env: []workspaces.EnvVar{ + CommandUnion: dw.CommandUnion{ + Exec: &dw.ExecCommand{ + Env: []dw.EnvVar{ { Name: "envVarToReplace", Value: "envVarToReplaceNewValue", @@ -116,9 +116,9 @@ func TestBasicToplevelOverriding(t *testing.T) { }, { Id: "command-not-changed", - CommandUnion: workspaces.CommandUnion{ - Exec: &workspaces.ExecCommand{ - LabeledCommand: workspaces.LabeledCommand{ + CommandUnion: dw.CommandUnion{ + Exec: &dw.ExecCommand{ + LabeledCommand: dw.LabeledCommand{ Label: "commandNotChangedLabel", }, }, @@ -309,9 +309,9 @@ func TestPluginOverrides(t *testing.T) { patchFile := "test-fixtures/patches/override-just-plugin/patch.yaml" resultFile := "test-fixtures/patches/override-just-plugin/result.yaml" - originalDWT := workspaces.DevWorkspaceTemplateSpecContent{} - patch := workspaces.PluginOverrides{} - expectedDWT := workspaces.DevWorkspaceTemplateSpecContent{} + originalDWT := dw.DevWorkspaceTemplateSpecContent{} + patch := dw.PluginOverrides{} + expectedDWT := dw.DevWorkspaceTemplateSpecContent{} readFileToStruct(t, originalFile, &originalDWT) readFileToStruct(t, patchFile, &patch) @@ -328,9 +328,9 @@ func TestMergingOnlyPlugins(t *testing.T) { pluginFile := "test-fixtures/merges/no-parent/plugin.yaml" resultFile := "test-fixtures/merges/no-parent/result.yaml" - baseDWT := workspaces.DevWorkspaceTemplateSpecContent{} - pluginDWT := workspaces.DevWorkspaceTemplateSpecContent{} - expectedDWT := workspaces.DevWorkspaceTemplateSpecContent{} + baseDWT := dw.DevWorkspaceTemplateSpecContent{} + pluginDWT := dw.DevWorkspaceTemplateSpecContent{} + expectedDWT := dw.DevWorkspaceTemplateSpecContent{} readFileToStruct(t, baseFile, &baseDWT) readFileToStruct(t, pluginFile, &pluginDWT) @@ -348,9 +348,9 @@ func TestMergingOnlyParent(t *testing.T) { parentFile := "test-fixtures/merges/no-parent/plugin.yaml" resultFile := "test-fixtures/merges/no-parent/result.yaml" - baseDWT := workspaces.DevWorkspaceTemplateSpecContent{} - parentDWT := workspaces.DevWorkspaceTemplateSpecContent{} - expectedDWT := workspaces.DevWorkspaceTemplateSpecContent{} + baseDWT := dw.DevWorkspaceTemplateSpecContent{} + parentDWT := dw.DevWorkspaceTemplateSpecContent{} + expectedDWT := dw.DevWorkspaceTemplateSpecContent{} readFileToStruct(t, baseFile, &baseDWT) readFileToStruct(t, parentFile, &parentDWT) diff --git a/pkg/utils/unions/normalize.go b/pkg/utils/unions/normalize.go index 25ee67250..96d6e486e 100644 --- a/pkg/utils/unions/normalize.go +++ b/pkg/utils/unions/normalize.go @@ -3,7 +3,7 @@ package unions import ( "reflect" - workspaces "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2" + dw "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2" "github.com/mitchellh/reflectwalk" ) @@ -15,7 +15,7 @@ func (n *normalizer) Struct(s reflect.Value) error { addr := s.Addr() if addr.CanInterface() { i := addr.Interface() - if u, ok := i.(workspaces.Union); ok { + if u, ok := i.(dw.Union); ok { u.Normalize() } } @@ -34,7 +34,7 @@ func (n *simplifier) Struct(s reflect.Value) error { addr := s.Addr() if addr.CanInterface() { i := addr.Interface() - if u, ok := i.(workspaces.Union); ok { + if u, ok := i.(dw.Union); ok { u.Simplify() } } diff --git a/pkg/utils/unions/normalize_test.go b/pkg/utils/unions/normalize_test.go index 1e1fc14cd..373e5e2a0 100644 --- a/pkg/utils/unions/normalize_test.go +++ b/pkg/utils/unions/normalize_test.go @@ -3,27 +3,27 @@ package unions import ( "testing" - workspaces "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2" + dw "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2" "github.com/stretchr/testify/assert" ) func TestNormalizingUnion_SetDiscriminator(t *testing.T) { - original := workspaces.DevWorkspaceTemplateSpecContent{ - Projects: []workspaces.Project{ + original := dw.DevWorkspaceTemplateSpecContent{ + Projects: []dw.Project{ { Name: "MyProject", - ProjectSource: workspaces.ProjectSource{ - Git: &workspaces.GitProjectSource{}, + ProjectSource: dw.ProjectSource{ + Git: &dw.GitProjectSource{}, }, }, }, } - expected := workspaces.DevWorkspaceTemplateSpecContent{ - Projects: []workspaces.Project{ + expected := dw.DevWorkspaceTemplateSpecContent{ + Projects: []dw.Project{ { Name: "MyProject", - ProjectSource: workspaces.ProjectSource{ - Git: &workspaces.GitProjectSource{}, + ProjectSource: dw.ProjectSource{ + Git: &dw.GitProjectSource{}, SourceType: "Git", }, }, @@ -40,24 +40,24 @@ func TestNormalizingUnion_SetDiscriminator(t *testing.T) { } func TestNormalizingUnion_CleanupOldValue(t *testing.T) { - original := workspaces.DevWorkspaceTemplateSpecContent{ - Projects: []workspaces.Project{ + original := dw.DevWorkspaceTemplateSpecContent{ + Projects: []dw.Project{ { Name: "MyProject", - ProjectSource: workspaces.ProjectSource{ - Git: &workspaces.GitProjectSource{}, - Zip: &workspaces.ZipProjectSource{}, + ProjectSource: dw.ProjectSource{ + Git: &dw.GitProjectSource{}, + Zip: &dw.ZipProjectSource{}, SourceType: "Git", }, }, }, } - expected := workspaces.DevWorkspaceTemplateSpecContent{ - Projects: []workspaces.Project{ + expected := dw.DevWorkspaceTemplateSpecContent{ + Projects: []dw.Project{ { Name: "MyProject", - ProjectSource: workspaces.ProjectSource{ - Git: &workspaces.GitProjectSource{}, + ProjectSource: dw.ProjectSource{ + Git: &dw.GitProjectSource{}, SourceType: "Git", }, }, @@ -74,23 +74,23 @@ func TestNormalizingUnion_CleanupOldValue(t *testing.T) { } func TestSimplifyingUnion(t *testing.T) { - original := workspaces.DevWorkspaceTemplateSpecContent{ - Projects: []workspaces.Project{ + original := dw.DevWorkspaceTemplateSpecContent{ + Projects: []dw.Project{ { Name: "MyProject", - ProjectSource: workspaces.ProjectSource{ - Git: &workspaces.GitProjectSource{}, + ProjectSource: dw.ProjectSource{ + Git: &dw.GitProjectSource{}, SourceType: "Git", }, }, }, } - expected := workspaces.DevWorkspaceTemplateSpecContent{ - Projects: []workspaces.Project{ + expected := dw.DevWorkspaceTemplateSpecContent{ + Projects: []dw.Project{ { Name: "MyProject", - ProjectSource: workspaces.ProjectSource{ - Git: &workspaces.GitProjectSource{}, + ProjectSource: dw.ProjectSource{ + Git: &dw.GitProjectSource{}, }, }, }, diff --git a/pkg/validation/events_test.go b/pkg/validation/events_test.go index 34755931b..d7bf5ed81 100644 --- a/pkg/validation/events_test.go +++ b/pkg/validation/events_test.go @@ -32,7 +32,7 @@ func TestValidateEvents(t *testing.T) { { name: "Valid preStart events - Apply and Composite Apply Commands", events: v1alpha2.Events{ - WorkspaceEvents: v1alpha2.WorkspaceEvents{ + DevWorkspaceEvents: v1alpha2.DevWorkspaceEvents{ PreStart: []string{ "apply1", "apply2", @@ -44,7 +44,7 @@ func TestValidateEvents(t *testing.T) { { name: "Invalid exec commands in preStart", events: v1alpha2.Events{ - WorkspaceEvents: v1alpha2.WorkspaceEvents{ + DevWorkspaceEvents: v1alpha2.DevWorkspaceEvents{ PreStart: []string{ "apply12", "exec2", @@ -57,7 +57,7 @@ func TestValidateEvents(t *testing.T) { { name: "Invalid exec commands in postStop", events: v1alpha2.Events{ - WorkspaceEvents: v1alpha2.WorkspaceEvents{ + DevWorkspaceEvents: v1alpha2.DevWorkspaceEvents{ PostStop: []string{ "apply12", "exec2", @@ -70,7 +70,7 @@ func TestValidateEvents(t *testing.T) { { name: "Invalid apply commands in postStart", events: v1alpha2.Events{ - WorkspaceEvents: v1alpha2.WorkspaceEvents{ + DevWorkspaceEvents: v1alpha2.DevWorkspaceEvents{ PostStart: []string{ "apply12", "exec2", @@ -83,7 +83,7 @@ func TestValidateEvents(t *testing.T) { { name: "Invalid apply commands in preStop", events: v1alpha2.Events{ - WorkspaceEvents: v1alpha2.WorkspaceEvents{ + DevWorkspaceEvents: v1alpha2.DevWorkspaceEvents{ PreStop: []string{ "apply12", "exec2", diff --git a/samples/devworkspaces/custom.devworkspace.yaml b/samples/devworkspaces/custom.devworkspace.yaml index 0c06f8fa3..4f49784fd 100644 --- a/samples/devworkspaces/custom.devworkspace.yaml +++ b/samples/devworkspaces/custom.devworkspace.yaml @@ -1,7 +1,7 @@ kind: "DevWorkspace" apiVersion: "workspace.devfile.io/v1alpha2" metadata: - "name": "myWorkspace" + "name": "myDevWorkspace" spec: started: true routingClass: 'openshift-auth' diff --git a/samples/devworkspaces/example.devworkspace.yaml b/samples/devworkspaces/example.devworkspace.yaml index 09c794d51..7cf6f1ab5 100644 --- a/samples/devworkspaces/example.devworkspace.yaml +++ b/samples/devworkspaces/example.devworkspace.yaml @@ -1,7 +1,7 @@ kind: "DevWorkspace" apiVersion: "workspace.devfile.io/v1alpha2" metadata: - "name": "myWorkspace" + "name": "myDevWorkspace" spec: started: true routingClass: 'openshift-auth' diff --git a/samples/devworkspaces/with-nodejs-parent-template.devworkspace.yaml b/samples/devworkspaces/with-nodejs-parent-template.devworkspace.yaml index e348773b6..79d07116b 100644 --- a/samples/devworkspaces/with-nodejs-parent-template.devworkspace.yaml +++ b/samples/devworkspaces/with-nodejs-parent-template.devworkspace.yaml @@ -1,4 +1,4 @@ -apiVersion: workspace.che.eclipse.org/v1alpha2 +apiVersion: workspace.devfile.io/v1alpha2 kind: DevWorkspace metadata: name: "with-nodejs-template-parent" diff --git a/schemas/latest/dev-workspace-template-spec.json b/schemas/latest/dev-workspace-template-spec.json index a1e5aee1c..7052e3732 100644 --- a/schemas/latest/dev-workspace-template-spec.json +++ b/schemas/latest/dev-workspace-template-spec.json @@ -1,10 +1,10 @@ { - "description": "Structure of the workspace. This is also the specification of a workspace template.", + "description": "Structure of the devworkspace. This is also the specification of a devworkspace template.", "type": "object", "title": "DevWorkspaceTemplateSpec schema - Version 2.1.0-alpha", "properties": { "commands": { - "description": "Predefined, ready-to-use, workspace-related commands", + "description": "Predefined, ready-to-use, devworkspace-related commands", "type": "array", "items": { "type": "object", @@ -35,7 +35,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "required": [ "component" @@ -261,7 +261,7 @@ } }, "components": { - "description": "List of the workspace components, such as editor and plugins, user-provided containers, or other types of components", + "description": "List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components", "type": "array", "items": { "type": "object", @@ -307,7 +307,7 @@ "additionalProperties": true }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "required": [ "image" @@ -352,7 +352,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "default": "public", "enum": [ @@ -480,7 +480,7 @@ "additionalProperties": false }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -510,7 +510,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "default": "public", "enum": [ @@ -570,7 +570,7 @@ "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -600,7 +600,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "default": "public", "enum": [ @@ -701,7 +701,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -898,7 +898,7 @@ "additionalProperties": true }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -939,7 +939,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -1043,7 +1043,7 @@ "additionalProperties": false }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1072,7 +1072,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -1130,7 +1130,7 @@ "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1159,7 +1159,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -1283,28 +1283,28 @@ "type": "object", "properties": { "postStart": { - "description": "IDs of commands that should be executed after the workspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser.", + "description": "IDs of commands that should be executed after the devworkspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser.", "type": "array", "items": { "type": "string" } }, "postStop": { - "description": "IDs of commands that should be executed after stopping the workspace.", + "description": "IDs of commands that should be executed after stopping the devworkspace.", "type": "array", "items": { "type": "string" } }, "preStart": { - "description": "IDs of commands that should be executed before the workspace start. Kubernetes-wise, these commands would typically be executed in init containers of the workspace POD.", + "description": "IDs of commands that should be executed before the devworkspace start. Kubernetes-wise, these commands would typically be executed in init containers of the devworkspace POD.", "type": "array", "items": { "type": "string" } }, "preStop": { - "description": "IDs of commands that should be executed before stopping the workspace.", + "description": "IDs of commands that should be executed before stopping the devworkspace.", "type": "array", "items": { "type": "string" @@ -1314,7 +1314,7 @@ "additionalProperties": false }, "parent": { - "description": "Parent workspace template", + "description": "Parent devworkspace template", "type": "object", "oneOf": [ { @@ -1361,7 +1361,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -1563,7 +1563,7 @@ "additionalProperties": true }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -1604,7 +1604,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -1708,7 +1708,7 @@ "additionalProperties": false }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1737,7 +1737,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -1795,7 +1795,7 @@ "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1824,7 +1824,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -1923,7 +1923,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -2120,7 +2120,7 @@ "additionalProperties": true }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -2161,7 +2161,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -2265,7 +2265,7 @@ "additionalProperties": false }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -2294,7 +2294,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -2352,7 +2352,7 @@ "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -2381,7 +2381,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -2767,7 +2767,7 @@ "additionalProperties": false }, "projects": { - "description": "Projects worked on in the workspace, containing names and sources locations", + "description": "Projects worked on in the devworkspace, containing names and sources locations", "type": "array", "items": { "type": "object", diff --git a/schemas/latest/dev-workspace-template.json b/schemas/latest/dev-workspace-template.json index 615de4ecd..82b985460 100644 --- a/schemas/latest/dev-workspace-template.json +++ b/schemas/latest/dev-workspace-template.json @@ -165,11 +165,11 @@ "additionalProperties": false }, "spec": { - "description": "Structure of the workspace. This is also the specification of a workspace template.", + "description": "Structure of the devworkspace. This is also the specification of a devworkspace template.", "type": "object", "properties": { "commands": { - "description": "Predefined, ready-to-use, workspace-related commands", + "description": "Predefined, ready-to-use, devworkspace-related commands", "type": "array", "items": { "type": "object", @@ -200,7 +200,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "required": [ "component" @@ -426,7 +426,7 @@ } }, "components": { - "description": "List of the workspace components, such as editor and plugins, user-provided containers, or other types of components", + "description": "List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components", "type": "array", "items": { "type": "object", @@ -472,7 +472,7 @@ "additionalProperties": true }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "required": [ "image" @@ -517,7 +517,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "default": "public", "enum": [ @@ -645,7 +645,7 @@ "additionalProperties": false }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -675,7 +675,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "default": "public", "enum": [ @@ -735,7 +735,7 @@ "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -765,7 +765,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "default": "public", "enum": [ @@ -866,7 +866,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -1063,7 +1063,7 @@ "additionalProperties": true }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -1104,7 +1104,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -1208,7 +1208,7 @@ "additionalProperties": false }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1237,7 +1237,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -1295,7 +1295,7 @@ "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1324,7 +1324,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -1448,28 +1448,28 @@ "type": "object", "properties": { "postStart": { - "description": "IDs of commands that should be executed after the workspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser.", + "description": "IDs of commands that should be executed after the devworkspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser.", "type": "array", "items": { "type": "string" } }, "postStop": { - "description": "IDs of commands that should be executed after stopping the workspace.", + "description": "IDs of commands that should be executed after stopping the devworkspace.", "type": "array", "items": { "type": "string" } }, "preStart": { - "description": "IDs of commands that should be executed before the workspace start. Kubernetes-wise, these commands would typically be executed in init containers of the workspace POD.", + "description": "IDs of commands that should be executed before the devworkspace start. Kubernetes-wise, these commands would typically be executed in init containers of the devworkspace POD.", "type": "array", "items": { "type": "string" } }, "preStop": { - "description": "IDs of commands that should be executed before stopping the workspace.", + "description": "IDs of commands that should be executed before stopping the devworkspace.", "type": "array", "items": { "type": "string" @@ -1479,7 +1479,7 @@ "additionalProperties": false }, "parent": { - "description": "Parent workspace template", + "description": "Parent devworkspace template", "type": "object", "oneOf": [ { @@ -1526,7 +1526,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -1728,7 +1728,7 @@ "additionalProperties": true }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -1769,7 +1769,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -1873,7 +1873,7 @@ "additionalProperties": false }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1902,7 +1902,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -1960,7 +1960,7 @@ "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1989,7 +1989,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -2088,7 +2088,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -2285,7 +2285,7 @@ "additionalProperties": true }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -2326,7 +2326,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -2430,7 +2430,7 @@ "additionalProperties": false }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -2459,7 +2459,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -2517,7 +2517,7 @@ "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -2546,7 +2546,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -2932,7 +2932,7 @@ "additionalProperties": false }, "projects": { - "description": "Projects worked on in the workspace, containing names and sources locations", + "description": "Projects worked on in the devworkspace, containing names and sources locations", "type": "array", "items": { "type": "object", diff --git a/schemas/latest/dev-workspace.json b/schemas/latest/dev-workspace.json index 98dcbe01c..6a53cd05e 100644 --- a/schemas/latest/dev-workspace.json +++ b/schemas/latest/dev-workspace.json @@ -178,11 +178,11 @@ "type": "boolean" }, "template": { - "description": "Structure of the workspace. This is also the specification of a workspace template.", + "description": "Structure of the devworkspace. This is also the specification of a devworkspace template.", "type": "object", "properties": { "commands": { - "description": "Predefined, ready-to-use, workspace-related commands", + "description": "Predefined, ready-to-use, devworkspace-related commands", "type": "array", "items": { "type": "object", @@ -213,7 +213,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "required": [ "component" @@ -439,7 +439,7 @@ } }, "components": { - "description": "List of the workspace components, such as editor and plugins, user-provided containers, or other types of components", + "description": "List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components", "type": "array", "items": { "type": "object", @@ -485,7 +485,7 @@ "additionalProperties": true }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "required": [ "image" @@ -530,7 +530,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "default": "public", "enum": [ @@ -658,7 +658,7 @@ "additionalProperties": false }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -688,7 +688,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "default": "public", "enum": [ @@ -748,7 +748,7 @@ "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -778,7 +778,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "default": "public", "enum": [ @@ -879,7 +879,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -1076,7 +1076,7 @@ "additionalProperties": true }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -1117,7 +1117,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -1221,7 +1221,7 @@ "additionalProperties": false }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1250,7 +1250,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -1308,7 +1308,7 @@ "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1337,7 +1337,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -1461,28 +1461,28 @@ "type": "object", "properties": { "postStart": { - "description": "IDs of commands that should be executed after the workspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser.", + "description": "IDs of commands that should be executed after the devworkspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser.", "type": "array", "items": { "type": "string" } }, "postStop": { - "description": "IDs of commands that should be executed after stopping the workspace.", + "description": "IDs of commands that should be executed after stopping the devworkspace.", "type": "array", "items": { "type": "string" } }, "preStart": { - "description": "IDs of commands that should be executed before the workspace start. Kubernetes-wise, these commands would typically be executed in init containers of the workspace POD.", + "description": "IDs of commands that should be executed before the devworkspace start. Kubernetes-wise, these commands would typically be executed in init containers of the devworkspace POD.", "type": "array", "items": { "type": "string" } }, "preStop": { - "description": "IDs of commands that should be executed before stopping the workspace.", + "description": "IDs of commands that should be executed before stopping the devworkspace.", "type": "array", "items": { "type": "string" @@ -1492,7 +1492,7 @@ "additionalProperties": false }, "parent": { - "description": "Parent workspace template", + "description": "Parent devworkspace template", "type": "object", "oneOf": [ { @@ -1539,7 +1539,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -1741,7 +1741,7 @@ "additionalProperties": true }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -1782,7 +1782,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -1886,7 +1886,7 @@ "additionalProperties": false }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1915,7 +1915,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -1973,7 +1973,7 @@ "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -2002,7 +2002,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -2101,7 +2101,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -2298,7 +2298,7 @@ "additionalProperties": true }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -2339,7 +2339,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -2443,7 +2443,7 @@ "additionalProperties": false }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -2472,7 +2472,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -2530,7 +2530,7 @@ "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -2559,7 +2559,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -2945,7 +2945,7 @@ "additionalProperties": false }, "projects": { - "description": "Projects worked on in the workspace, containing names and sources locations", + "description": "Projects worked on in the devworkspace, containing names and sources locations", "type": "array", "items": { "type": "object", @@ -3251,14 +3251,14 @@ "description": "DevWorkspaceStatus defines the observed state of DevWorkspace", "type": "object", "required": [ - "workspaceId" + "devWorkspaceId" ], "properties": { "conditions": { "description": "Conditions represent the latest available observations of an object's state", "type": "array", "items": { - "description": "WorkspaceCondition contains details for the current condition of this workspace.", + "description": "DevWorkspaceCondition contains details for the current condition of this devworkspace.", "type": "object", "required": [ "status", @@ -3290,8 +3290,12 @@ "additionalProperties": false } }, + "devWorkspaceId": { + "description": "Id of the DevWorkspace", + "type": "string" + }, "ideUrl": { - "description": "URL at which the Worksace Editor can be joined", + "description": "URL at which the DevWorkspace Editor can be joined", "type": "string" }, "message": { @@ -3300,10 +3304,6 @@ }, "phase": { "type": "string" - }, - "workspaceId": { - "description": "Id of the workspace", - "type": "string" } }, "additionalProperties": false diff --git a/schemas/latest/devfile.json b/schemas/latest/devfile.json index e01f2e6d8..e8f24e9c1 100644 --- a/schemas/latest/devfile.json +++ b/schemas/latest/devfile.json @@ -1,5 +1,5 @@ { - "description": "Devfile describes the structure of a cloud-native workspace and development environment.", + "description": "Devfile describes the structure of a cloud-native devworkspace and development environment.", "type": "object", "title": "Devfile schema - Version 2.1.0-alpha", "required": [ @@ -7,7 +7,7 @@ ], "properties": { "commands": { - "description": "Predefined, ready-to-use, workspace-related commands", + "description": "Predefined, ready-to-use, devworkspace-related commands", "type": "array", "items": { "type": "object", @@ -33,7 +33,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "required": [ "component" @@ -211,7 +211,7 @@ } }, "components": { - "description": "List of the workspace components, such as editor and plugins, user-provided containers, or other types of components", + "description": "List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components", "type": "array", "items": { "type": "object", @@ -252,7 +252,7 @@ "additionalProperties": true }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "required": [ "image" @@ -297,7 +297,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "default": "public", "enum": [ @@ -405,7 +405,7 @@ "additionalProperties": false }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -435,7 +435,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "default": "public", "enum": [ @@ -495,7 +495,7 @@ "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -525,7 +525,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "default": "public", "enum": [ @@ -626,7 +626,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -823,7 +823,7 @@ "additionalProperties": true }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -864,7 +864,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -968,7 +968,7 @@ "additionalProperties": false }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -997,7 +997,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -1055,7 +1055,7 @@ "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1084,7 +1084,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -1208,28 +1208,28 @@ "type": "object", "properties": { "postStart": { - "description": "IDs of commands that should be executed after the workspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser.", + "description": "IDs of commands that should be executed after the devworkspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser.", "type": "array", "items": { "type": "string" } }, "postStop": { - "description": "IDs of commands that should be executed after stopping the workspace.", + "description": "IDs of commands that should be executed after stopping the devworkspace.", "type": "array", "items": { "type": "string" } }, "preStart": { - "description": "IDs of commands that should be executed before the workspace start. Kubernetes-wise, these commands would typically be executed in init containers of the workspace POD.", + "description": "IDs of commands that should be executed before the devworkspace start. Kubernetes-wise, these commands would typically be executed in init containers of the devworkspace POD.", "type": "array", "items": { "type": "string" } }, "preStop": { - "description": "IDs of commands that should be executed before stopping the workspace.", + "description": "IDs of commands that should be executed before stopping the devworkspace.", "type": "array", "items": { "type": "string" @@ -1295,7 +1295,7 @@ "additionalProperties": true }, "parent": { - "description": "Parent workspace template", + "description": "Parent devworkspace template", "type": "object", "oneOf": [ { @@ -1342,7 +1342,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -1544,7 +1544,7 @@ "additionalProperties": true }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -1585,7 +1585,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -1689,7 +1689,7 @@ "additionalProperties": false }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1718,7 +1718,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -1776,7 +1776,7 @@ "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1805,7 +1805,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -1904,7 +1904,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -2101,7 +2101,7 @@ "additionalProperties": true }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -2142,7 +2142,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -2246,7 +2246,7 @@ "additionalProperties": false }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -2275,7 +2275,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -2333,7 +2333,7 @@ "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -2362,7 +2362,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -2748,7 +2748,7 @@ "additionalProperties": false }, "projects": { - "description": "Projects worked on in the workspace, containing names and sources locations", + "description": "Projects worked on in the devworkspace, containing names and sources locations", "type": "array", "items": { "type": "object", diff --git a/schemas/latest/ide-targeted/dev-workspace-template-spec.json b/schemas/latest/ide-targeted/dev-workspace-template-spec.json index 47dff6067..14c402875 100644 --- a/schemas/latest/ide-targeted/dev-workspace-template-spec.json +++ b/schemas/latest/ide-targeted/dev-workspace-template-spec.json @@ -1,10 +1,10 @@ { - "description": "Structure of the workspace. This is also the specification of a workspace template.\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs.", + "description": "Structure of the devworkspace. This is also the specification of a devworkspace template.\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs.", "type": "object", "title": "DevWorkspaceTemplateSpec schema - Version 2.1.0-alpha - IDE-targeted variant", "properties": { "commands": { - "description": "Predefined, ready-to-use, workspace-related commands", + "description": "Predefined, ready-to-use, devworkspace-related commands", "type": "array", "items": { "type": "object", @@ -35,7 +35,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "required": [ "component" @@ -80,7 +80,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default." + "markdownDescription": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default." }, "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", @@ -291,10 +291,10 @@ }, "additionalProperties": false }, - "markdownDescription": "Predefined, ready-to-use, workspace-related commands" + "markdownDescription": "Predefined, ready-to-use, devworkspace-related commands" }, "components": { - "description": "List of the workspace components, such as editor and plugins, user-provided containers, or other types of components", + "description": "List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components", "type": "array", "items": { "type": "object", @@ -341,7 +341,7 @@ "markdownDescription": "Map of implementation-dependant free-form YAML attributes." }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "required": [ "image" @@ -390,14 +390,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -504,7 +504,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows adding and configuring workspace-related containers" + "markdownDescription": "Allows adding and configuring devworkspace-related containers" }, "custom": { "description": "Custom component whose logic is implementation-dependant and should be provided by the user possibly through some dedicated controller", @@ -530,7 +530,7 @@ "markdownDescription": "Custom component whose logic is implementation-dependant and should be provided by the user possibly through some dedicated controller" }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -561,14 +561,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -617,7 +617,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." }, "name": { "description": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.", @@ -627,7 +627,7 @@ "markdownDescription": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin." }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -658,14 +658,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -714,7 +714,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." }, "plugin": { "description": "Allows importing a plugin.\n\nPlugins are mainly imported devfiles that contribute components, commands and events as a consistent single unit. They are defined in either YAML files following the devfile syntax, or as `DevWorkspaceTemplate` Kubernetes Custom Resources", @@ -764,7 +764,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -803,7 +803,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default." + "markdownDescription": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default." }, "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", @@ -988,7 +988,7 @@ "markdownDescription": "Map of implementation-dependant free-form YAML attributes." }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -1033,14 +1033,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -1146,10 +1146,10 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows adding and configuring workspace-related containers" + "markdownDescription": "Allows adding and configuring devworkspace-related containers" }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1179,14 +1179,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -1235,7 +1235,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." }, "name": { "description": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.", @@ -1245,7 +1245,7 @@ "markdownDescription": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin." }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1275,14 +1275,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -1331,7 +1331,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." }, "volume": { "description": "Allows specifying the definition of a volume shared by several other components", @@ -1411,50 +1411,50 @@ }, "additionalProperties": false }, - "markdownDescription": "List of the workspace components, such as editor and plugins, user-provided containers, or other types of components" + "markdownDescription": "List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components" }, "events": { "description": "Bindings of commands to events. Each command is referred-to by its name.", "type": "object", "properties": { "postStart": { - "description": "IDs of commands that should be executed after the workspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser.", + "description": "IDs of commands that should be executed after the devworkspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser.", "type": "array", "items": { "type": "string" }, - "markdownDescription": "IDs of commands that should be executed after the workspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser." + "markdownDescription": "IDs of commands that should be executed after the devworkspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser." }, "postStop": { - "description": "IDs of commands that should be executed after stopping the workspace.", + "description": "IDs of commands that should be executed after stopping the devworkspace.", "type": "array", "items": { "type": "string" }, - "markdownDescription": "IDs of commands that should be executed after stopping the workspace." + "markdownDescription": "IDs of commands that should be executed after stopping the devworkspace." }, "preStart": { - "description": "IDs of commands that should be executed before the workspace start. Kubernetes-wise, these commands would typically be executed in init containers of the workspace POD.", + "description": "IDs of commands that should be executed before the devworkspace start. Kubernetes-wise, these commands would typically be executed in init containers of the devworkspace POD.", "type": "array", "items": { "type": "string" }, - "markdownDescription": "IDs of commands that should be executed before the workspace start. Kubernetes-wise, these commands would typically be executed in init containers of the workspace POD." + "markdownDescription": "IDs of commands that should be executed before the devworkspace start. Kubernetes-wise, these commands would typically be executed in init containers of the devworkspace POD." }, "preStop": { - "description": "IDs of commands that should be executed before stopping the workspace.", + "description": "IDs of commands that should be executed before stopping the devworkspace.", "type": "array", "items": { "type": "string" }, - "markdownDescription": "IDs of commands that should be executed before stopping the workspace." + "markdownDescription": "IDs of commands that should be executed before stopping the devworkspace." } }, "additionalProperties": false, "markdownDescription": "Bindings of commands to events. Each command is referred-to by its name." }, "parent": { - "description": "Parent workspace template", + "description": "Parent devworkspace template", "type": "object", "oneOf": [ { @@ -1501,7 +1501,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -1540,7 +1540,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default." + "markdownDescription": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default." }, "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", @@ -1730,7 +1730,7 @@ "markdownDescription": "Map of implementation-dependant free-form YAML attributes." }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -1775,14 +1775,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -1888,10 +1888,10 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows adding and configuring workspace-related containers" + "markdownDescription": "Allows adding and configuring devworkspace-related containers" }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1921,14 +1921,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -1977,7 +1977,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." }, "name": { "description": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.", @@ -1987,7 +1987,7 @@ "markdownDescription": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin." }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -2017,14 +2017,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -2073,7 +2073,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." }, "plugin": { "description": "Allows importing a plugin.\n\nPlugins are mainly imported devfiles that contribute components, commands and events as a consistent single unit. They are defined in either YAML files following the devfile syntax, or as `DevWorkspaceTemplate` Kubernetes Custom Resources", @@ -2123,7 +2123,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -2162,7 +2162,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default." + "markdownDescription": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default." }, "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", @@ -2347,7 +2347,7 @@ "markdownDescription": "Map of implementation-dependant free-form YAML attributes." }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -2392,14 +2392,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -2505,10 +2505,10 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows adding and configuring workspace-related containers" + "markdownDescription": "Allows adding and configuring devworkspace-related containers" }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -2538,14 +2538,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -2594,7 +2594,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." }, "name": { "description": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.", @@ -2604,7 +2604,7 @@ "markdownDescription": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin." }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -2634,14 +2634,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -2690,7 +2690,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." }, "volume": { "description": "Allows specifying the definition of a volume shared by several other components", @@ -3074,10 +3074,10 @@ } }, "additionalProperties": false, - "markdownDescription": "Parent workspace template" + "markdownDescription": "Parent devworkspace template" }, "projects": { - "description": "Projects worked on in the workspace, containing names and sources locations", + "description": "Projects worked on in the devworkspace, containing names and sources locations", "type": "array", "items": { "type": "object", @@ -3242,7 +3242,7 @@ }, "additionalProperties": false }, - "markdownDescription": "Projects worked on in the workspace, containing names and sources locations" + "markdownDescription": "Projects worked on in the devworkspace, containing names and sources locations" }, "starterProjects": { "description": "StarterProjects is a project that can be used as a starting point when bootstrapping new projects", @@ -3411,5 +3411,5 @@ } }, "additionalProperties": false, - "markdownDescription": "Structure of the workspace. This is also the specification of a workspace template.\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs." + "markdownDescription": "Structure of the devworkspace. This is also the specification of a devworkspace template.\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs." } \ No newline at end of file diff --git a/schemas/latest/ide-targeted/dev-workspace-template.json b/schemas/latest/ide-targeted/dev-workspace-template.json index f4a15060a..6f9241d52 100644 --- a/schemas/latest/ide-targeted/dev-workspace-template.json +++ b/schemas/latest/ide-targeted/dev-workspace-template.json @@ -198,11 +198,11 @@ "markdownDescription": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." }, "spec": { - "description": "Structure of the workspace. This is also the specification of a workspace template.", + "description": "Structure of the devworkspace. This is also the specification of a devworkspace template.", "type": "object", "properties": { "commands": { - "description": "Predefined, ready-to-use, workspace-related commands", + "description": "Predefined, ready-to-use, devworkspace-related commands", "type": "array", "items": { "type": "object", @@ -233,7 +233,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "required": [ "component" @@ -278,7 +278,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default." + "markdownDescription": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default." }, "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", @@ -489,10 +489,10 @@ }, "additionalProperties": false }, - "markdownDescription": "Predefined, ready-to-use, workspace-related commands" + "markdownDescription": "Predefined, ready-to-use, devworkspace-related commands" }, "components": { - "description": "List of the workspace components, such as editor and plugins, user-provided containers, or other types of components", + "description": "List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components", "type": "array", "items": { "type": "object", @@ -539,7 +539,7 @@ "markdownDescription": "Map of implementation-dependant free-form YAML attributes." }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "required": [ "image" @@ -588,14 +588,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -702,7 +702,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows adding and configuring workspace-related containers" + "markdownDescription": "Allows adding and configuring devworkspace-related containers" }, "custom": { "description": "Custom component whose logic is implementation-dependant and should be provided by the user possibly through some dedicated controller", @@ -728,7 +728,7 @@ "markdownDescription": "Custom component whose logic is implementation-dependant and should be provided by the user possibly through some dedicated controller" }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -759,14 +759,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -815,7 +815,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." }, "name": { "description": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.", @@ -825,7 +825,7 @@ "markdownDescription": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin." }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -856,14 +856,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -912,7 +912,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." }, "plugin": { "description": "Allows importing a plugin.\n\nPlugins are mainly imported devfiles that contribute components, commands and events as a consistent single unit. They are defined in either YAML files following the devfile syntax, or as `DevWorkspaceTemplate` Kubernetes Custom Resources", @@ -962,7 +962,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -1001,7 +1001,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default." + "markdownDescription": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default." }, "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", @@ -1186,7 +1186,7 @@ "markdownDescription": "Map of implementation-dependant free-form YAML attributes." }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -1231,14 +1231,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -1344,10 +1344,10 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows adding and configuring workspace-related containers" + "markdownDescription": "Allows adding and configuring devworkspace-related containers" }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1377,14 +1377,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -1433,7 +1433,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." }, "name": { "description": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.", @@ -1443,7 +1443,7 @@ "markdownDescription": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin." }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1473,14 +1473,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -1529,7 +1529,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." }, "volume": { "description": "Allows specifying the definition of a volume shared by several other components", @@ -1609,50 +1609,50 @@ }, "additionalProperties": false }, - "markdownDescription": "List of the workspace components, such as editor and plugins, user-provided containers, or other types of components" + "markdownDescription": "List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components" }, "events": { "description": "Bindings of commands to events. Each command is referred-to by its name.", "type": "object", "properties": { "postStart": { - "description": "IDs of commands that should be executed after the workspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser.", + "description": "IDs of commands that should be executed after the devworkspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser.", "type": "array", "items": { "type": "string" }, - "markdownDescription": "IDs of commands that should be executed after the workspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser." + "markdownDescription": "IDs of commands that should be executed after the devworkspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser." }, "postStop": { - "description": "IDs of commands that should be executed after stopping the workspace.", + "description": "IDs of commands that should be executed after stopping the devworkspace.", "type": "array", "items": { "type": "string" }, - "markdownDescription": "IDs of commands that should be executed after stopping the workspace." + "markdownDescription": "IDs of commands that should be executed after stopping the devworkspace." }, "preStart": { - "description": "IDs of commands that should be executed before the workspace start. Kubernetes-wise, these commands would typically be executed in init containers of the workspace POD.", + "description": "IDs of commands that should be executed before the devworkspace start. Kubernetes-wise, these commands would typically be executed in init containers of the devworkspace POD.", "type": "array", "items": { "type": "string" }, - "markdownDescription": "IDs of commands that should be executed before the workspace start. Kubernetes-wise, these commands would typically be executed in init containers of the workspace POD." + "markdownDescription": "IDs of commands that should be executed before the devworkspace start. Kubernetes-wise, these commands would typically be executed in init containers of the devworkspace POD." }, "preStop": { - "description": "IDs of commands that should be executed before stopping the workspace.", + "description": "IDs of commands that should be executed before stopping the devworkspace.", "type": "array", "items": { "type": "string" }, - "markdownDescription": "IDs of commands that should be executed before stopping the workspace." + "markdownDescription": "IDs of commands that should be executed before stopping the devworkspace." } }, "additionalProperties": false, "markdownDescription": "Bindings of commands to events. Each command is referred-to by its name." }, "parent": { - "description": "Parent workspace template", + "description": "Parent devworkspace template", "type": "object", "oneOf": [ { @@ -1699,7 +1699,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -1738,7 +1738,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default." + "markdownDescription": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default." }, "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", @@ -1928,7 +1928,7 @@ "markdownDescription": "Map of implementation-dependant free-form YAML attributes." }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -1973,14 +1973,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -2086,10 +2086,10 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows adding and configuring workspace-related containers" + "markdownDescription": "Allows adding and configuring devworkspace-related containers" }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -2119,14 +2119,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -2175,7 +2175,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." }, "name": { "description": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.", @@ -2185,7 +2185,7 @@ "markdownDescription": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin." }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -2215,14 +2215,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -2271,7 +2271,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." }, "plugin": { "description": "Allows importing a plugin.\n\nPlugins are mainly imported devfiles that contribute components, commands and events as a consistent single unit. They are defined in either YAML files following the devfile syntax, or as `DevWorkspaceTemplate` Kubernetes Custom Resources", @@ -2321,7 +2321,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -2360,7 +2360,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default." + "markdownDescription": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default." }, "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", @@ -2545,7 +2545,7 @@ "markdownDescription": "Map of implementation-dependant free-form YAML attributes." }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -2590,14 +2590,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -2703,10 +2703,10 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows adding and configuring workspace-related containers" + "markdownDescription": "Allows adding and configuring devworkspace-related containers" }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -2736,14 +2736,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -2792,7 +2792,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." }, "name": { "description": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.", @@ -2802,7 +2802,7 @@ "markdownDescription": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin." }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -2832,14 +2832,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -2888,7 +2888,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." }, "volume": { "description": "Allows specifying the definition of a volume shared by several other components", @@ -3272,10 +3272,10 @@ } }, "additionalProperties": false, - "markdownDescription": "Parent workspace template" + "markdownDescription": "Parent devworkspace template" }, "projects": { - "description": "Projects worked on in the workspace, containing names and sources locations", + "description": "Projects worked on in the devworkspace, containing names and sources locations", "type": "array", "items": { "type": "object", @@ -3440,7 +3440,7 @@ }, "additionalProperties": false }, - "markdownDescription": "Projects worked on in the workspace, containing names and sources locations" + "markdownDescription": "Projects worked on in the devworkspace, containing names and sources locations" }, "starterProjects": { "description": "StarterProjects is a project that can be used as a starting point when bootstrapping new projects", @@ -3609,7 +3609,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Structure of the workspace. This is also the specification of a workspace template." + "markdownDescription": "Structure of the devworkspace. This is also the specification of a devworkspace template." } }, "additionalProperties": false, diff --git a/schemas/latest/ide-targeted/dev-workspace.json b/schemas/latest/ide-targeted/dev-workspace.json index 8861962cb..6d9ec7ce4 100644 --- a/schemas/latest/ide-targeted/dev-workspace.json +++ b/schemas/latest/ide-targeted/dev-workspace.json @@ -211,11 +211,11 @@ "type": "boolean" }, "template": { - "description": "Structure of the workspace. This is also the specification of a workspace template.", + "description": "Structure of the devworkspace. This is also the specification of a devworkspace template.", "type": "object", "properties": { "commands": { - "description": "Predefined, ready-to-use, workspace-related commands", + "description": "Predefined, ready-to-use, devworkspace-related commands", "type": "array", "items": { "type": "object", @@ -246,7 +246,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "required": [ "component" @@ -291,7 +291,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default." + "markdownDescription": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default." }, "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", @@ -502,10 +502,10 @@ }, "additionalProperties": false }, - "markdownDescription": "Predefined, ready-to-use, workspace-related commands" + "markdownDescription": "Predefined, ready-to-use, devworkspace-related commands" }, "components": { - "description": "List of the workspace components, such as editor and plugins, user-provided containers, or other types of components", + "description": "List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components", "type": "array", "items": { "type": "object", @@ -552,7 +552,7 @@ "markdownDescription": "Map of implementation-dependant free-form YAML attributes." }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "required": [ "image" @@ -601,14 +601,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -715,7 +715,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows adding and configuring workspace-related containers" + "markdownDescription": "Allows adding and configuring devworkspace-related containers" }, "custom": { "description": "Custom component whose logic is implementation-dependant and should be provided by the user possibly through some dedicated controller", @@ -741,7 +741,7 @@ "markdownDescription": "Custom component whose logic is implementation-dependant and should be provided by the user possibly through some dedicated controller" }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -772,14 +772,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -828,7 +828,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." }, "name": { "description": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.", @@ -838,7 +838,7 @@ "markdownDescription": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin." }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -869,14 +869,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -925,7 +925,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." }, "plugin": { "description": "Allows importing a plugin.\n\nPlugins are mainly imported devfiles that contribute components, commands and events as a consistent single unit. They are defined in either YAML files following the devfile syntax, or as `DevWorkspaceTemplate` Kubernetes Custom Resources", @@ -975,7 +975,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -1014,7 +1014,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default." + "markdownDescription": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default." }, "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", @@ -1199,7 +1199,7 @@ "markdownDescription": "Map of implementation-dependant free-form YAML attributes." }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -1244,14 +1244,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -1357,10 +1357,10 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows adding and configuring workspace-related containers" + "markdownDescription": "Allows adding and configuring devworkspace-related containers" }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1390,14 +1390,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -1446,7 +1446,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." }, "name": { "description": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.", @@ -1456,7 +1456,7 @@ "markdownDescription": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin." }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1486,14 +1486,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -1542,7 +1542,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." }, "volume": { "description": "Allows specifying the definition of a volume shared by several other components", @@ -1622,50 +1622,50 @@ }, "additionalProperties": false }, - "markdownDescription": "List of the workspace components, such as editor and plugins, user-provided containers, or other types of components" + "markdownDescription": "List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components" }, "events": { "description": "Bindings of commands to events. Each command is referred-to by its name.", "type": "object", "properties": { "postStart": { - "description": "IDs of commands that should be executed after the workspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser.", + "description": "IDs of commands that should be executed after the devworkspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser.", "type": "array", "items": { "type": "string" }, - "markdownDescription": "IDs of commands that should be executed after the workspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser." + "markdownDescription": "IDs of commands that should be executed after the devworkspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser." }, "postStop": { - "description": "IDs of commands that should be executed after stopping the workspace.", + "description": "IDs of commands that should be executed after stopping the devworkspace.", "type": "array", "items": { "type": "string" }, - "markdownDescription": "IDs of commands that should be executed after stopping the workspace." + "markdownDescription": "IDs of commands that should be executed after stopping the devworkspace." }, "preStart": { - "description": "IDs of commands that should be executed before the workspace start. Kubernetes-wise, these commands would typically be executed in init containers of the workspace POD.", + "description": "IDs of commands that should be executed before the devworkspace start. Kubernetes-wise, these commands would typically be executed in init containers of the devworkspace POD.", "type": "array", "items": { "type": "string" }, - "markdownDescription": "IDs of commands that should be executed before the workspace start. Kubernetes-wise, these commands would typically be executed in init containers of the workspace POD." + "markdownDescription": "IDs of commands that should be executed before the devworkspace start. Kubernetes-wise, these commands would typically be executed in init containers of the devworkspace POD." }, "preStop": { - "description": "IDs of commands that should be executed before stopping the workspace.", + "description": "IDs of commands that should be executed before stopping the devworkspace.", "type": "array", "items": { "type": "string" }, - "markdownDescription": "IDs of commands that should be executed before stopping the workspace." + "markdownDescription": "IDs of commands that should be executed before stopping the devworkspace." } }, "additionalProperties": false, "markdownDescription": "Bindings of commands to events. Each command is referred-to by its name." }, "parent": { - "description": "Parent workspace template", + "description": "Parent devworkspace template", "type": "object", "oneOf": [ { @@ -1712,7 +1712,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -1751,7 +1751,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default." + "markdownDescription": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default." }, "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", @@ -1941,7 +1941,7 @@ "markdownDescription": "Map of implementation-dependant free-form YAML attributes." }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -1986,14 +1986,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -2099,10 +2099,10 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows adding and configuring workspace-related containers" + "markdownDescription": "Allows adding and configuring devworkspace-related containers" }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -2132,14 +2132,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -2188,7 +2188,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." }, "name": { "description": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.", @@ -2198,7 +2198,7 @@ "markdownDescription": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin." }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -2228,14 +2228,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -2284,7 +2284,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." }, "plugin": { "description": "Allows importing a plugin.\n\nPlugins are mainly imported devfiles that contribute components, commands and events as a consistent single unit. They are defined in either YAML files following the devfile syntax, or as `DevWorkspaceTemplate` Kubernetes Custom Resources", @@ -2334,7 +2334,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -2373,7 +2373,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default." + "markdownDescription": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default." }, "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", @@ -2558,7 +2558,7 @@ "markdownDescription": "Map of implementation-dependant free-form YAML attributes." }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -2603,14 +2603,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -2716,10 +2716,10 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows adding and configuring workspace-related containers" + "markdownDescription": "Allows adding and configuring devworkspace-related containers" }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -2749,14 +2749,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -2805,7 +2805,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." }, "name": { "description": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.", @@ -2815,7 +2815,7 @@ "markdownDescription": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin." }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -2845,14 +2845,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -2901,7 +2901,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." }, "volume": { "description": "Allows specifying the definition of a volume shared by several other components", @@ -3285,10 +3285,10 @@ } }, "additionalProperties": false, - "markdownDescription": "Parent workspace template" + "markdownDescription": "Parent devworkspace template" }, "projects": { - "description": "Projects worked on in the workspace, containing names and sources locations", + "description": "Projects worked on in the devworkspace, containing names and sources locations", "type": "array", "items": { "type": "object", @@ -3453,7 +3453,7 @@ }, "additionalProperties": false }, - "markdownDescription": "Projects worked on in the workspace, containing names and sources locations" + "markdownDescription": "Projects worked on in the devworkspace, containing names and sources locations" }, "starterProjects": { "description": "StarterProjects is a project that can be used as a starting point when bootstrapping new projects", @@ -3622,7 +3622,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Structure of the workspace. This is also the specification of a workspace template." + "markdownDescription": "Structure of the devworkspace. This is also the specification of a devworkspace template." } }, "additionalProperties": false, @@ -3632,14 +3632,14 @@ "description": "DevWorkspaceStatus defines the observed state of DevWorkspace", "type": "object", "required": [ - "workspaceId" + "devWorkspaceId" ], "properties": { "conditions": { "description": "Conditions represent the latest available observations of an object's state", "type": "array", "items": { - "description": "WorkspaceCondition contains details for the current condition of this workspace.", + "description": "DevWorkspaceCondition contains details for the current condition of this devworkspace.", "type": "object", "required": [ "status", @@ -3674,14 +3674,19 @@ } }, "additionalProperties": false, - "markdownDescription": "WorkspaceCondition contains details for the current condition of this workspace." + "markdownDescription": "DevWorkspaceCondition contains details for the current condition of this devworkspace." }, "markdownDescription": "Conditions represent the latest available observations of an object's state" }, + "devWorkspaceId": { + "description": "Id of the DevWorkspace", + "type": "string", + "markdownDescription": "Id of the DevWorkspace" + }, "ideUrl": { - "description": "URL at which the Worksace Editor can be joined", + "description": "URL at which the DevWorkspace Editor can be joined", "type": "string", - "markdownDescription": "URL at which the Worksace Editor can be joined" + "markdownDescription": "URL at which the DevWorkspace Editor can be joined" }, "message": { "description": "Message is a short user-readable message giving additional information about an object's state", @@ -3690,11 +3695,6 @@ }, "phase": { "type": "string" - }, - "workspaceId": { - "description": "Id of the workspace", - "type": "string", - "markdownDescription": "Id of the workspace" } }, "additionalProperties": false, diff --git a/schemas/latest/ide-targeted/devfile.json b/schemas/latest/ide-targeted/devfile.json index cb0298de5..eef5bf70f 100644 --- a/schemas/latest/ide-targeted/devfile.json +++ b/schemas/latest/ide-targeted/devfile.json @@ -1,5 +1,5 @@ { - "description": "Devfile describes the structure of a cloud-native workspace and development environment.\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs.", + "description": "Devfile describes the structure of a cloud-native devworkspace and development environment.\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs.", "type": "object", "title": "Devfile schema - Version 2.1.0-alpha - IDE-targeted variant", "required": [ @@ -7,7 +7,7 @@ ], "properties": { "commands": { - "description": "Predefined, ready-to-use, workspace-related commands", + "description": "Predefined, ready-to-use, devworkspace-related commands", "type": "array", "items": { "type": "object", @@ -33,7 +33,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "required": [ "component" @@ -78,7 +78,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default." + "markdownDescription": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default." }, "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", @@ -234,10 +234,10 @@ }, "additionalProperties": false }, - "markdownDescription": "Predefined, ready-to-use, workspace-related commands" + "markdownDescription": "Predefined, ready-to-use, devworkspace-related commands" }, "components": { - "description": "List of the workspace components, such as editor and plugins, user-provided containers, or other types of components", + "description": "List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components", "type": "array", "items": { "type": "object", @@ -279,7 +279,7 @@ "markdownDescription": "Map of implementation-dependant free-form YAML attributes." }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "required": [ "image" @@ -328,14 +328,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -442,10 +442,10 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows adding and configuring workspace-related containers" + "markdownDescription": "Allows adding and configuring devworkspace-related containers" }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -476,14 +476,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -532,7 +532,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." }, "name": { "description": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.", @@ -542,7 +542,7 @@ "markdownDescription": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin." }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -573,14 +573,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -629,7 +629,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." }, "plugin": { "description": "Allows importing a plugin.\n\nPlugins are mainly imported devfiles that contribute components, commands and events as a consistent single unit. They are defined in either YAML files following the devfile syntax, or as `DevWorkspaceTemplate` Kubernetes Custom Resources", @@ -679,7 +679,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -718,7 +718,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default." + "markdownDescription": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default." }, "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", @@ -903,7 +903,7 @@ "markdownDescription": "Map of implementation-dependant free-form YAML attributes." }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -948,14 +948,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -1061,10 +1061,10 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows adding and configuring workspace-related containers" + "markdownDescription": "Allows adding and configuring devworkspace-related containers" }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1094,14 +1094,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -1150,7 +1150,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." }, "name": { "description": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.", @@ -1160,7 +1160,7 @@ "markdownDescription": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin." }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1190,14 +1190,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -1246,7 +1246,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." }, "volume": { "description": "Allows specifying the definition of a volume shared by several other components", @@ -1326,43 +1326,43 @@ }, "additionalProperties": false }, - "markdownDescription": "List of the workspace components, such as editor and plugins, user-provided containers, or other types of components" + "markdownDescription": "List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components" }, "events": { "description": "Bindings of commands to events. Each command is referred-to by its name.", "type": "object", "properties": { "postStart": { - "description": "IDs of commands that should be executed after the workspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser.", + "description": "IDs of commands that should be executed after the devworkspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser.", "type": "array", "items": { "type": "string" }, - "markdownDescription": "IDs of commands that should be executed after the workspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser." + "markdownDescription": "IDs of commands that should be executed after the devworkspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser." }, "postStop": { - "description": "IDs of commands that should be executed after stopping the workspace.", + "description": "IDs of commands that should be executed after stopping the devworkspace.", "type": "array", "items": { "type": "string" }, - "markdownDescription": "IDs of commands that should be executed after stopping the workspace." + "markdownDescription": "IDs of commands that should be executed after stopping the devworkspace." }, "preStart": { - "description": "IDs of commands that should be executed before the workspace start. Kubernetes-wise, these commands would typically be executed in init containers of the workspace POD.", + "description": "IDs of commands that should be executed before the devworkspace start. Kubernetes-wise, these commands would typically be executed in init containers of the devworkspace POD.", "type": "array", "items": { "type": "string" }, - "markdownDescription": "IDs of commands that should be executed before the workspace start. Kubernetes-wise, these commands would typically be executed in init containers of the workspace POD." + "markdownDescription": "IDs of commands that should be executed before the devworkspace start. Kubernetes-wise, these commands would typically be executed in init containers of the devworkspace POD." }, "preStop": { - "description": "IDs of commands that should be executed before stopping the workspace.", + "description": "IDs of commands that should be executed before stopping the devworkspace.", "type": "array", "items": { "type": "string" }, - "markdownDescription": "IDs of commands that should be executed before stopping the workspace." + "markdownDescription": "IDs of commands that should be executed before stopping the devworkspace." } }, "additionalProperties": false, @@ -1437,7 +1437,7 @@ "markdownDescription": "Optional metadata" }, "parent": { - "description": "Parent workspace template", + "description": "Parent devworkspace template", "type": "object", "oneOf": [ { @@ -1484,7 +1484,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -1523,7 +1523,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default." + "markdownDescription": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default." }, "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", @@ -1713,7 +1713,7 @@ "markdownDescription": "Map of implementation-dependant free-form YAML attributes." }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -1758,14 +1758,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -1871,10 +1871,10 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows adding and configuring workspace-related containers" + "markdownDescription": "Allows adding and configuring devworkspace-related containers" }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1904,14 +1904,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -1960,7 +1960,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." }, "name": { "description": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.", @@ -1970,7 +1970,7 @@ "markdownDescription": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin." }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -2000,14 +2000,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -2056,7 +2056,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." }, "plugin": { "description": "Allows importing a plugin.\n\nPlugins are mainly imported devfiles that contribute components, commands and events as a consistent single unit. They are defined in either YAML files following the devfile syntax, or as `DevWorkspaceTemplate` Kubernetes Custom Resources", @@ -2106,7 +2106,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -2145,7 +2145,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default." + "markdownDescription": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default." }, "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", @@ -2330,7 +2330,7 @@ "markdownDescription": "Map of implementation-dependant free-form YAML attributes." }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -2375,14 +2375,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -2488,10 +2488,10 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows adding and configuring workspace-related containers" + "markdownDescription": "Allows adding and configuring devworkspace-related containers" }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -2521,14 +2521,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -2577,7 +2577,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." }, "name": { "description": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.", @@ -2587,7 +2587,7 @@ "markdownDescription": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin." }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -2617,14 +2617,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -2673,7 +2673,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." }, "volume": { "description": "Allows specifying the definition of a volume shared by several other components", @@ -3057,10 +3057,10 @@ } }, "additionalProperties": false, - "markdownDescription": "Parent workspace template" + "markdownDescription": "Parent devworkspace template" }, "projects": { - "description": "Projects worked on in the workspace, containing names and sources locations", + "description": "Projects worked on in the devworkspace, containing names and sources locations", "type": "array", "items": { "type": "object", @@ -3201,7 +3201,7 @@ }, "additionalProperties": false }, - "markdownDescription": "Projects worked on in the workspace, containing names and sources locations" + "markdownDescription": "Projects worked on in the devworkspace, containing names and sources locations" }, "schemaVersion": { "description": "Devfile schema version", @@ -3352,5 +3352,5 @@ } }, "additionalProperties": false, - "markdownDescription": "Devfile describes the structure of a cloud-native workspace and development environment.\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs." + "markdownDescription": "Devfile describes the structure of a cloud-native devworkspace and development environment.\n\nIDE-targeted variants of the schemas provide the following difference compared to the main schemas:\n- They contain additional non-standard `markdownDescription` attributes that are used by IDEs such a VSCode\nto provide markdown-rendered documentation hovers. \n- They don't contain `default` attributes, since this triggers unwanted addition of defaulted fields during completion in IDEs." } \ No newline at end of file diff --git a/schemas/latest/ide-targeted/parent-overrides.json b/schemas/latest/ide-targeted/parent-overrides.json index 293d94504..06ba994bf 100644 --- a/schemas/latest/ide-targeted/parent-overrides.json +++ b/schemas/latest/ide-targeted/parent-overrides.json @@ -30,7 +30,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -69,7 +69,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default." + "markdownDescription": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default." }, "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", @@ -259,7 +259,7 @@ "markdownDescription": "Map of implementation-dependant free-form YAML attributes." }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -304,14 +304,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -417,10 +417,10 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows adding and configuring workspace-related containers" + "markdownDescription": "Allows adding and configuring devworkspace-related containers" }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -450,14 +450,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -506,7 +506,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." }, "name": { "description": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.", @@ -516,7 +516,7 @@ "markdownDescription": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin." }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -546,14 +546,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -602,7 +602,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." }, "plugin": { "description": "Allows importing a plugin.\n\nPlugins are mainly imported devfiles that contribute components, commands and events as a consistent single unit. They are defined in either YAML files following the devfile syntax, or as `DevWorkspaceTemplate` Kubernetes Custom Resources", @@ -652,7 +652,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -691,7 +691,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default." + "markdownDescription": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default." }, "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", @@ -876,7 +876,7 @@ "markdownDescription": "Map of implementation-dependant free-form YAML attributes." }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -921,14 +921,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -1034,10 +1034,10 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows adding and configuring workspace-related containers" + "markdownDescription": "Allows adding and configuring devworkspace-related containers" }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1067,14 +1067,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -1123,7 +1123,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." }, "name": { "description": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.", @@ -1133,7 +1133,7 @@ "markdownDescription": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin." }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1163,14 +1163,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -1219,7 +1219,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." }, "volume": { "description": "Allows specifying the definition of a volume shared by several other components", diff --git a/schemas/latest/ide-targeted/plugin-overrides.json b/schemas/latest/ide-targeted/plugin-overrides.json index 5d062988e..417825c15 100644 --- a/schemas/latest/ide-targeted/plugin-overrides.json +++ b/schemas/latest/ide-targeted/plugin-overrides.json @@ -30,7 +30,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -69,7 +69,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default." + "markdownDescription": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default." }, "attributes": { "description": "Map of implementation-dependant free-form YAML attributes.", @@ -254,7 +254,7 @@ "markdownDescription": "Map of implementation-dependant free-form YAML attributes." }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -299,14 +299,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -412,10 +412,10 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows adding and configuring workspace-related containers" + "markdownDescription": "Allows adding and configuring devworkspace-related containers" }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -445,14 +445,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -501,7 +501,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production." }, "name": { "description": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.", @@ -511,7 +511,7 @@ "markdownDescription": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin." }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -541,14 +541,14 @@ "markdownDescription": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\"," }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", "internal", "none" ], - "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`" + "markdownDescription": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`" }, "name": { "type": "string", @@ -597,7 +597,7 @@ } }, "additionalProperties": false, - "markdownDescription": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." + "markdownDescription": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production." }, "volume": { "description": "Allows specifying the definition of a volume shared by several other components", diff --git a/schemas/latest/parent-overrides.json b/schemas/latest/parent-overrides.json index d0b11998d..53f1db705 100644 --- a/schemas/latest/parent-overrides.json +++ b/schemas/latest/parent-overrides.json @@ -29,7 +29,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -231,7 +231,7 @@ "additionalProperties": true }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -272,7 +272,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -376,7 +376,7 @@ "additionalProperties": false }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -405,7 +405,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -463,7 +463,7 @@ "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -492,7 +492,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -591,7 +591,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -788,7 +788,7 @@ "additionalProperties": true }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -829,7 +829,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -933,7 +933,7 @@ "additionalProperties": false }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -962,7 +962,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -1020,7 +1020,7 @@ "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -1049,7 +1049,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", diff --git a/schemas/latest/plugin-overrides.json b/schemas/latest/plugin-overrides.json index 1315ddeaf..09fbba842 100644 --- a/schemas/latest/plugin-overrides.json +++ b/schemas/latest/plugin-overrides.json @@ -29,7 +29,7 @@ ], "properties": { "apply": { - "description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.", + "description": "Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default.", "type": "object", "properties": { "component": { @@ -226,7 +226,7 @@ "additionalProperties": true }, "container": { - "description": "Allows adding and configuring workspace-related containers", + "description": "Allows adding and configuring devworkspace-related containers", "type": "object", "properties": { "args": { @@ -267,7 +267,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -371,7 +371,7 @@ "additionalProperties": false }, "kubernetes": { - "description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -400,7 +400,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public", @@ -458,7 +458,7 @@ "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" }, "openshift": { - "description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", + "description": "Allows importing into the devworkspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.", "type": "object", "oneOf": [ { @@ -487,7 +487,7 @@ "additionalProperties": true }, "exposure": { - "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`", + "description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`", "type": "string", "enum": [ "public",