Finalize workspace to DevWorkspace renaming

Author: sleshchenko

Makefile

@@ -23,7 +23,8 @@ export ROUTING_SUFFIX ?= 192.168.99.100.nip.io
 export PULL_POLICY ?= Always
 export DEFAULT_ROUTING ?= basic
 export KUBECONFIG ?= ${HOME}/.kube/config
-export DEVWORKSPACE_API_VERSION ?= 283b0c54946e9fea9872c25e1e086c303688f0e8
+#TODO Revert before merge
+export DEVWORKSPACE_API_VERSION ?= 546111ae6350d790ef1dcaa58aa7d78dce205e96
 
 #internal params
 DEVWORKSPACE_CTRL_SA=devworkspace-controller-serviceaccount

PROJECT

@@ -1,7 +1,7 @@
 domain: devfile.io
 layout: go.kubebuilder.io/v2
 multigroup: true
-projectName: devworkspace-operator-migration
+projectName: devworkspace-operator
 repo: github.com/devfile/devworkspace-operator
 resources:
 - group: controller

README.md

@@ -16,7 +16,7 @@ You can add these Kubernetes annotations to specific DevWorkspace CR to customiz
 
 The `controller.devfile.io/restricted-access` specifies that a DevWorkspace needs additional access control (in addition to RBAC). When a DevWorkspace is created with the `controller.devfile.io/restricted-access` annotation set to `true`, the webhook server will guarantee
 - Only the DevWorkspace Operator ServiceAccount or DevWorkspace creator can modify important fields in the devworksapce
-- Only the DevWorkspace creator can create `pods/exec` into workspace-related containers.
+- Only the DevWorkspace creator can create `pods/exec` into devworkspace-related containers.
 
 This annotation should be used when a DevWorkspace is expected to contain sensitive information that should be protect above the protection provided by standard RBAC rules (e.g. if the DevWorkspace will store the user's OpenShift token in-memory).
 
@@ -49,7 +49,7 @@ export DWO_IMG=quay.io/devfile/devworkspace-controller:next
 make install
 ```
 
-By default, controller will expose workspace servers without any authentication; this is not advisable for public clusters, as any user could access the created workspace via URL.
+By default, controller will expose devworkspace servers without any authentication; this is not advisable for public clusters, as any user could access the created devworkspace via URL.
 
 In case of OpenShift, you're able to configure DevWorkspace CR to secure your servers with the following piece of configuration:
 
@@ -95,9 +95,9 @@ Some of the rules supported by the makefile:
 To see all rules supported by the makefile, run `make help`
 
 ### Test run controller
-1. Take a look samples workspace configuration in `./samples` folder.
-2. Apply any of them by executing `kubectl apply -f ./samples/workspace_java_mysql.yaml -n <namespace>`
-3. As soon as workspace is started you're able to get IDE url by executing `kubectl get devworkspace -n <namespace>`
+1. Take a look samples devworkspace configuration in `./samples` folder.
+2. Apply any of them by executing `kubectl apply -f ./samples/flattened_theia-next.yaml -n <namespace>`
+3. As soon as devworkspace is started you're able to get IDE url by executing `kubectl get devworkspace -n <namespace>`
 
 ### Run controller locally
 ```bash
@@ -106,7 +106,7 @@ oc patch deployment/devworkspace-controller-manager --patch "{\"spec\":{\"replic
 make run
 ```
 
-When running locally, only a single namespace is watched; as a result, all workspaces have to be deployed to `${NAMESPACE}`
+When running locally, only a single namespace is watched; as a result, all devworkspaces have to be deployed to `${NAMESPACE}`
 
 ### Run controller locally and debug
 Debugging the controller depends on `delve` being installed (`go get -u github.com/go-delve/delve/cmd/dlv`). Note that at the time of writing, executing `go get` in this repo's directory will update go.mod; these changes should be dropped before committing.

apis/controller/v1alpha1/common.go

@@ -14,44 +14,44 @@ package v1alpha1
 
 import v1 "k8s.io/api/core/v1"
 
-// Summary of additions that are to be merged into the main workspace deployment
+// Summary of additions that are to be merged into the main devworkspace deployment
 type PodAdditions struct {
-	// Annotations to be applied to workspace deployment
+	// Annotations to be applied to devworkspace deployment
 	// +optional
 	// +patchMergeKey=name
 	// +patchStrategy=merge
 	Annotations map[string]string `json:"annotations,omitempty"`
-	// Labels to be applied to workspace deployment
+	// Labels to be applied to devworkspace deployment
 	// +optional
 	// +patchMergeKey=name
 	// +patchStrategy=merge
 	Labels map[string]string `json:"labels,omitempty"`
-	// Containers to add to workspace deployment
+	// Containers to add to devworkspace deployment
 	// +optional
 	// +patchMergeKey=name
 	// +patchStrategy=merge
 	Containers []v1.Container `json:"containers,omitempty"`
-	// Init containers to add to workspace deployment
+	// Init containers to add to devworkspace deployment
 	// +optional
 	// +patchMergeKey=name
 	// +patchStrategy=merge
 	InitContainers []v1.Container `json:"initContainers,omitempty"`
-	// Volumes to add to workspace deployment
+	// Volumes to add to devworkspace deployment
 	// +optional
 	// +patchMergeKey=name
 	// +patchStrategy=merge
 	Volumes []v1.Volume `json:"volumes,omitempty"`
-	// VolumeMounts to add to all containers in a workspace deployment
+	// VolumeMounts to add to all containers in a devworkspace deployment
 	// +optional
 	// +patchMergeKey=name
 	// +patchStrategy=merge
 	VolumeMounts []v1.VolumeMount `json:"volumeMounts,omitempty"`
-	// ImagePullSecrets to add to workspace deployment
+	// ImagePullSecrets to add to devworkspace deployment
 	// +optional
 	// +patchMergeKey=name
 	// +patchStrategy=merge
 	PullSecrets []v1.LocalObjectReference `json:"pullSecrets,omitempty"`
-	// Annotations for the workspace service account, it might be used for e.g. OpenShift oauth with SA as auth client
+	// Annotations for the devworkspace service account, it might be used for e.g. OpenShift oauth with SA as auth client
 	// +optional
 	// +patchMergeKey=name
 	// +patchStrategy=merge

apis/controller/v1alpha1/component.go

@@ -13,31 +13,31 @@
 package v1alpha1
 
 import (
-	devworkspace "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
+	dw "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
 )
 
-// Description of a devfile component's workspace additions
+// Description of a devfile component's devworkspace additions
 type ComponentDescription struct {
 	// The name of the component
 	Name string `json:"name"`
-	// Additions to the workspace pod
+	// Additions to the devworkspace pod
 	PodAdditions PodAdditions `json:"podAdditions"`
 	// Additional metadata from devfile (e.g. attributes, commands)
 	ComponentMetadata ComponentMetadata `json:"componentMetadata"`
 }
 
 type ComponentMetadata struct {
-	// Containers is a map of container names to ContainerDescriptions. Field is serialized into workspace status "additionalFields"
+	// Containers is a map of container names to ContainerDescriptions. Field is serialized into devworkspace status "additionalFields"
 	// and consumed by che-rest-apis
 	Containers map[string]ContainerDescription `json:"containers,omitempty"`
-	// ContributedRuntimeCommands represent the devfile commands available in the current workspace. They are serialized into the
-	// workspace status "additionalFields" and consumed by che-rest-apis.
-	ContributedRuntimeCommands []CheWorkspaceCommand `json:"contributedRuntimeCommands,omitempty"`
-	// Endpoints stores the workspace endpoints defined by the component
-	Endpoints []devworkspace.Endpoint `json:"endpoints,omitempty"`
+	// ContributedRuntimeCommands represent the devfile commands available in the current devworkspace. They are serialized into the
+	// devworkspace status "additionalFields" and consumed by che-rest-apis.
+	ContributedRuntimeCommands []ComponentCommand `json:"contributedRuntimeCommands,omitempty"`
+	// Endpoints stores the devworkspace endpoints defined by the component
+	Endpoints []dw.Endpoint `json:"endpoints,omitempty"`
 }
 
-// ContainerDescription stores metadata about workspace containers. This is used to provide information
+// ContainerDescription stores metadata about devworkspace containers. This is used to provide information
 // to Theia via the che-rest-apis container.
 type ContainerDescription struct {
 	// Attributes stores the Che-specific metadata about a component, e.g. a plugin's ID, memoryLimit from devfile, etc.
@@ -46,8 +46,8 @@ type ContainerDescription struct {
 	Ports []int `json:"ports,omitempty"`
 }
 
-// Command to add to workspace
-type CheWorkspaceCommand struct {
+// Command to add to devworkspace
+type ComponentCommand struct {
 	// Name of the command
 	Name string `json:"name"`
 	// Type of the command

apis/controller/v1alpha1/component_types.go

@@ -13,26 +13,26 @@
 package v1alpha1
 
 import (
-	devworkspace "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
+	dw "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
 // ComponentSpec defines the desired state of Component
 // +k8s:openapi-gen=true
-type WorkspaceComponentSpec struct {
-	// Id of workspace that contains this component
-	WorkspaceId string `json:"workspaceId"`
+type DevWorkspaceComponentSpec struct {
+	// Id of devworkspace that contains this component
+	DevWorkspaceId string `json:"devWorkspaceId"`
 	// List of devfile components to be processed by this component
-	Components []devworkspace.Component `json:"components"`
+	Components []dw.Component `json:"components"`
 	// Commands from devfile, to be matched to components
-	Commands []devworkspace.Command `json:"commands,omitempty"`
+	Commands []dw.Command `json:"commands,omitempty"`
 	// Events
-	Events *devworkspace.Events `json:"events,omitempty"`
+	Events *dw.Events `json:"events,omitempty"`
 }
 
 // ComponentStatus defines the observed state of Component
 // +k8s:openapi-gen=true
-type WorkspaceComponentStatus struct {
+type DevWorkspaceComponentStatus struct {
 	// Ready indicates whether the component has finished processing its spec
 	Ready bool `json:"ready"`
 	// Failed indicates that an unresolvable problem prevents this component
@@ -55,8 +55,8 @@ type Component struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
-	Spec   WorkspaceComponentSpec   `json:"spec,omitempty"`
-	Status WorkspaceComponentStatus `json:"status,omitempty"`
+	Spec   DevWorkspaceComponentSpec   `json:"spec,omitempty"`
+	Status DevWorkspaceComponentStatus `json:"status,omitempty"`
 }
 
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

apis/controller/v1alpha1/devfile.go

@@ -23,14 +23,14 @@ type DevfileSpec struct {
 	// Devfile attributes, e.g. persistVolumes
 	DevfileAttributes `json:"attributes,omitempty" yaml:"attributes,omitempty"`
 
-	// List of projects that should be imported into the workspace
+	// List of projects that should be imported into the devworkspace
 	Projects []ProjectSpec `json:"projects,omitempty" yaml:"projects,omitempty"` // Description of the projects, containing names and sources locations
 
-	// List of components (editor, plugins, containers, ...) that will provide the workspace features
-	Components []ComponentSpec `json:"components" yaml:"components"` // Description of the workspace components, such as editor and plugins
+	// List of components (editor, plugins, containers, ...) that will provide the devworkspace features
+	Components []ComponentSpec `json:"components" yaml:"components"` // Description of the devworkspace components, such as editor and plugins
 
-	// List of workspace-wide commands that can be associated to a given component, in order to run in the related container
-	Commands []CommandSpec `json:"commands,omitempty" yaml:"commands,omitempty"` // Description of the predefined commands to be available in workspace
+	// List of devworkspace-wide commands that can be associated to a given component, in order to run in the related container
+	Commands []CommandSpec `json:"commands,omitempty" yaml:"commands,omitempty"` // Description of the predefined commands to be available in devworkspace
 }
 
 type DevfileMeta struct {
@@ -96,7 +96,7 @@ type Endpoint struct {
 type EndpointAttribute string
 
 const (
-	//endpoint attribute that is used to configure whether it should be available publicly or workspace only
+	//endpoint attribute that is used to configure whether it should be available publicly or devworkspace only
 	PUBLIC_ENDPOINT_ATTRIBUTE EndpointAttribute = "public"
 
 	//endpoint attribute that is used to configure whether it should be covered with authentication or not

apis/controller/v1alpha1/devworkspacerouting_types.go

@@ -13,23 +13,23 @@
 package v1alpha1
 
 import (
-	devworkspace "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
+	dw "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
 	devfileAttr "github.com/devfile/api/v2/pkg/attributes"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
 // DevWorkspaceRoutingSpec defines the desired state of DevWorkspaceRouting
 // +k8s:openapi-gen=true
 type DevWorkspaceRoutingSpec struct {
-	// WorkspaceId for the workspace being routed
-	WorkspaceId string `json:"workspaceId"`
-	// Class of the routing: this drives which Workspace Routing controller will manage this routing
+	// Id for the DevWorkspace being routed
+	DevWorkspaceId string `json:"devWorkspaceId"`
+	// Class of the routing: this drives which DevWorkspaceRouting controller will manage this routing
 	RoutingClass DevWorkspaceRoutingClass `json:"routingClass,omitempty"`
 	// Routing suffix for cluster
 	RoutingSuffix string `json:"routingSuffix"`
 	// Machines to endpoints map
 	Endpoints map[string]EndpointList `json:"endpoints"`
-	// Selector that should be used by created services to point to the workspace Pod
+	// Selector that should be used by created services to point to the devworkspace Pod
 	PodSelector map[string]string `json:"podSelector"`
 }
 
@@ -46,7 +46,7 @@ const (
 // DevWorkspaceRoutingStatus defines the observed state of DevWorkspaceRouting
 // +k8s:openapi-gen=true
 type DevWorkspaceRoutingStatus struct {
-	// Additions to main workspace deployment
+	// Additions to main devworkspace deployment
 	PodAdditions *PodAdditions `json:"podAdditions,omitempty"`
 	// Machine name to exposed endpoint map
 	ExposedEndpoints map[string]ExposedEndpointList `json:"exposedEndpoints,omitempty"`
@@ -73,7 +73,7 @@ type ExposedEndpoint struct {
 	Attributes devfileAttr.Attributes `json:"attributes,omitempty"`
 }
 
-type EndpointList []devworkspace.Endpoint
+type EndpointList []dw.Endpoint
 
 type ExposedEndpointList []ExposedEndpoint