Skip to content

docs: add documentation for cross-namespace DevWorkspaceTemplate imports #1673

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dkwon17 merged 1 commit into from
Jul 14, 2026
+50 −0
Merged

docs: add documentation for cross-namespace DevWorkspaceTemplate imports #1673

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions docs/additional-configuration.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -361,6 +361,56 @@ merged with the default DevWorkspaceOperatorConfig, overriding
fields in the default configuration. Fields unset in the overridden
configuration will use the global values.

## Configuring cross-namespace DevWorkspaceTemplate imports

By default, a DevWorkspace can only import a DevWorkspaceTemplate from its own namespace.
To allow a DevWorkspaceTemplate to be imported by DevWorkspaces in other namespaces,
the annotation `controller.devfile.io/allow-import-from` must be added to the DevWorkspaceTemplate.

The annotation supports the following values:

* `*`: allow importing by all DevWorkspaces on the cluster
* `namespaceA,namespaceB`: allow importing by DevWorkspaces in a specific list of namespaces

If the annotation is not set or is empty, only DevWorkspaces in the same namespace as the template can reference it.

[source,yaml]
----
apiVersion: workspace.devfile.io/v1alpha2
kind: DevWorkspaceTemplate
metadata:
name: my-template
namespace: platform-namespace
annotations:
controller.devfile.io/allow-import-from: "*" # allow all namespaces
----

Or to restrict to specific namespaces:

[source,yaml]
----
apiVersion: workspace.devfile.io/v1alpha2
kind: DevWorkspaceTemplate
metadata:
name: my-template
namespace: platform-namespace
annotations:
controller.devfile.io/allow-import-from: "namespace-a,namespace-b"
----

A DevWorkspace can then reference the template using the `parent.kubernetes` field in the devfile:

[source,yaml]
----
schemaVersion: 2.2.0
metadata:
name: my-workspace
parent:
kubernetes:
name: my-template
namespace: platform-namespace
----

## Fine-grained configuration of workspace pods and containers
The attributes `pod-overrides` and `container-overrides` can be applied to DevWorkspaces in order to configure fields on the Kubernetes objects that are not normally exposed through the Kubernetes API.

Expand Down
Loading