Merge pull request #7 from spacelift-io/CU-8693y86jm-scaffolding-for-stack

Scaffolding for Stack

Author: michalg9

PROJECT

@@ -16,4 +16,12 @@ resources:
   kind: Run
   path: github.com/spacelift-io/spacelift-operator/api/v1beta1
   version: v1beta1
+- api:
+    crdVersion: v1
+    namespaced: true
+  controller: true
+  domain: app.spacelift.io
+  kind: Stack
+  path: github.com/spacelift-io/spacelift-operator/api/v1beta1
+  version: v1beta1
 version: "3"

api/v1beta1/stack_types.go

@@ -0,0 +1,64 @@
+/*
+Copyright 2024.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1beta1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
+// NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
+
+// StackSpec defines the desired state of Stack
+type StackSpec struct {
+	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
+	// Important: Run "make" to regenerate code after modifying this file
+
+	// Foo is an example field of Stack. Edit stack_types.go to remove/update
+	Foo string `json:"foo,omitempty"`
+}
+
+// StackStatus defines the observed state of Stack
+type StackStatus struct {
+	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
+	// Important: Run "make" to regenerate code after modifying this file
+}
+
+//+kubebuilder:object:root=true
+//+kubebuilder:subresource:status
+
+// Stack is the Schema for the stacks API
+type Stack struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   StackSpec   `json:"spec,omitempty"`
+	Status StackStatus `json:"status,omitempty"`
+}
+
+//+kubebuilder:object:root=true
+
+// StackList contains a list of Stack
+type StackList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []Stack `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&Stack{}, &StackList{})
+}

api/v1beta1/zz_generated.deepcopy.go

@@ -113,6 +113,13 @@ func main() {
 		setupLog.Error(err, "unable to create controller", "controller", "Run")
 		os.Exit(1)
 	}
+	if err = (&controller.StackReconciler{
+		Client: mgr.GetClient(),
+		Scheme: mgr.GetScheme(),
+	}).SetupWithManager(mgr); err != nil {
+		setupLog.Error(err, "unable to create controller", "controller", "Stack")
+		os.Exit(1)
+	}
 	//+kubebuilder:scaffold:builder
 
 	if err := mgr.AddHealthzCheck("healthz", healthz.Ping); err != nil {

cmd/main.go

@@ -0,0 +1,49 @@
+---
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  annotations:
+    controller-gen.kubebuilder.io/version: v0.13.0
+  name: stacks.app.spacelift.io
+spec:
+  group: app.spacelift.io
+  names:
+    kind: Stack
+    listKind: StackList
+    plural: stacks
+    singular: stack
+  scope: Namespaced
+  versions:
+  - name: v1beta1
+    schema:
+      openAPIV3Schema:
+        description: Stack is the Schema for the stacks API
+        properties:
+          apiVersion:
+            description: 'APIVersion defines the versioned schema of this representation
+              of an object. Servers should convert recognized schemas to the latest
+              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+            type: string
+          kind:
+            description: 'Kind is a string value representing the REST resource this
+              object represents. Servers may infer this from the endpoint the client
+              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+            type: string
+          metadata:
+            type: object
+          spec:
+            description: StackSpec defines the desired state of Stack
+            properties:
+              foo:
+                description: Foo is an example field of Stack. Edit stack_types.go
+                  to remove/update
+                type: string
+            type: object
+          status:
+            description: StackStatus defines the observed state of Stack
+            type: object
+        type: object
+    served: true
+    storage: true
+    subresources:
+      status: {}

config/crd/bases/app.spacelift.io_stacks.yaml

@@ -3,17 +3,20 @@
 # It should be run by config/default
 resources:
 - bases/app.spacelift.io_runs.yaml
+- bases/app.spacelift.io_stacks.yaml
 #+kubebuilder:scaffold:crdkustomizeresource
 
 patches:
 # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix.
 # patches here are for enabling the conversion webhook for each CRD
 #- path: patches/webhook_in_runs.yaml
+#- path: patches/webhook_in_stacks.yaml
 #+kubebuilder:scaffold:crdkustomizewebhookpatch
 
 # [CERTMANAGER] To enable cert-manager, uncomment all the sections with [CERTMANAGER] prefix.
 # patches here are for enabling the CA injection for each CRD
 #- path: patches/cainjection_in_runs.yaml
+#- path: patches/cainjection_in_stacks.yaml
 #+kubebuilder:scaffold:crdkustomizecainjectionpatch
 
 # the following config is for teaching kustomize how to do kustomization for CRDs.

config/crd/kustomization.yaml

@@ -30,3 +30,29 @@ rules:
   - get
   - patch
   - update
+- apiGroups:
+  - app.spacelift.io
+  resources:
+  - stacks
+  verbs:
+  - create
+  - delete
+  - get
+  - list
+  - patch
+  - update
+  - watch
+- apiGroups:
+  - app.spacelift.io
+  resources:
+  - stacks/finalizers
+  verbs:
+  - update
+- apiGroups:
+  - app.spacelift.io
+  resources:
+  - stacks/status
+  verbs:
+  - get
+  - patch
+  - update

config/rbac/role.yaml

@@ -0,0 +1,31 @@
+# permissions for end users to edit stacks.
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  labels:
+    app.kubernetes.io/name: clusterrole
+    app.kubernetes.io/instance: stack-editor-role
+    app.kubernetes.io/component: rbac
+    app.kubernetes.io/created-by: spacelift-operator
+    app.kubernetes.io/part-of: spacelift-operator
+    app.kubernetes.io/managed-by: kustomize
+  name: stack-editor-role
+rules:
+- apiGroups:
+  - app.spacelift.io
+  resources:
+  - stacks
+  verbs:
+  - create
+  - delete
+  - get
+  - list
+  - patch
+  - update
+  - watch
+- apiGroups:
+  - app.spacelift.io
+  resources:
+  - stacks/status
+  verbs:
+  - get

config/rbac/stack_editor_role.yaml

@@ -0,0 +1,27 @@
+# permissions for end users to view stacks.
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  labels:
+    app.kubernetes.io/name: clusterrole
+    app.kubernetes.io/instance: stack-viewer-role
+    app.kubernetes.io/component: rbac
+    app.kubernetes.io/created-by: spacelift-operator
+    app.kubernetes.io/part-of: spacelift-operator
+    app.kubernetes.io/managed-by: kustomize
+  name: stack-viewer-role
+rules:
+- apiGroups:
+  - app.spacelift.io
+  resources:
+  - stacks
+  verbs:
+  - get
+  - list
+  - watch
+- apiGroups:
+  - app.spacelift.io
+  resources:
+  - stacks/status
+  verbs:
+  - get

config/rbac/stack_viewer_role.yaml

@@ -0,0 +1,12 @@
+apiVersion: app.spacelift.io/v1beta1
+kind: Stack
+metadata:
+  labels:
+    app.kubernetes.io/name: stack
+    app.kubernetes.io/instance: stack-sample
+    app.kubernetes.io/part-of: spacelift-operator
+    app.kubernetes.io/managed-by: kustomize
+    app.kubernetes.io/created-by: spacelift-operator
+  name: stack-sample
+spec:
+  # TODO(user): Add fields here