diff --git a/PROJECT b/PROJECT index d324553..57eed84 100644 --- a/PROJECT +++ b/PROJECT @@ -17,4 +17,12 @@ resources: kind: Project path: github.com/open-component-model/mpas-project-controller/api/v1alpha1 version: v1alpha1 +- api: + crdVersion: v1 + namespaced: true + domain: ocm.software + group: mpas + kind: Target + path: github.com/open-component-model/mpas-project-controller/api/v1alpha1 + version: v1alpha1 version: "3" diff --git a/api/v1alpha1/target_types.go b/api/v1alpha1/target_types.go new file mode 100644 index 0000000..4aa5219 --- /dev/null +++ b/api/v1alpha1/target_types.go @@ -0,0 +1,81 @@ +/* +Copyright 2023. + +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 v1alpha1 + +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. + +// TargetSpec defines the desired state of Target +type TargetSpec struct { + // Type specifies the type of the target. Possible values are: kubernetes, ssh, ociRepository + // +required + // +kubebuilder:validation:Enum=kubernetes;ssh;ociRepository + Type string `json:"type"` + + Access *Access `json:"access,omitempty"` +} + +// TargetStatus defines the observed state of Target +type TargetStatus struct { + // INSERT ADDITIONAL STATUS FIELD - define observed state of cluster + // Important: Run "make" to regenerate code after modifying this file +} + +// Access defines the access information for a target +type Access struct { + // +required + SecretRef *TargetSecretRef `json:"secretRef"` +} + +// TargetSecretRef defines the reference to a secret within the cluster +type TargetSecretRef struct { + // +required + Name string `json:"name"` + + // Should we specify a default value? + // +optional + Namespace string `json:"namespace,omitempty"` +} + +//+kubebuilder:object:root=true +//+kubebuilder:subresource:status + +// Target is the Schema for the targets API +type Target struct { + metav1.TypeMeta `json:",inline"` + metav1.ObjectMeta `json:"metadata,omitempty"` + + Spec TargetSpec `json:"spec,omitempty"` + Status TargetStatus `json:"status,omitempty"` +} + +//+kubebuilder:object:root=true + +// TargetList contains a list of Target +type TargetList struct { + metav1.TypeMeta `json:",inline"` + metav1.ListMeta `json:"metadata,omitempty"` + Items []Target `json:"items"` +} + +func init() { + SchemeBuilder.Register(&Target{}, &TargetList{}) +} diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go index 56f38c7..002ffb3 100644 --- a/api/v1alpha1/zz_generated.deepcopy.go +++ b/api/v1alpha1/zz_generated.deepcopy.go @@ -113,3 +113,92 @@ func (in *ProjectStatus) DeepCopy() *ProjectStatus { in.DeepCopyInto(out) return out } + +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *Target) DeepCopyInto(out *Target) { + *out = *in + out.TypeMeta = in.TypeMeta + in.ObjectMeta.DeepCopyInto(&out.ObjectMeta) + out.Spec = in.Spec + out.Status = in.Status +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Target. +func (in *Target) DeepCopy() *Target { + if in == nil { + return nil + } + out := new(Target) + in.DeepCopyInto(out) + return out +} + +// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object. +func (in *Target) DeepCopyObject() runtime.Object { + if c := in.DeepCopy(); c != nil { + return c + } + return nil +} + +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *TargetList) DeepCopyInto(out *TargetList) { + *out = *in + out.TypeMeta = in.TypeMeta + in.ListMeta.DeepCopyInto(&out.ListMeta) + if in.Items != nil { + in, out := &in.Items, &out.Items + *out = make([]Target, len(*in)) + for i := range *in { + (*in)[i].DeepCopyInto(&(*out)[i]) + } + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TargetList. +func (in *TargetList) DeepCopy() *TargetList { + if in == nil { + return nil + } + out := new(TargetList) + in.DeepCopyInto(out) + return out +} + +// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object. +func (in *TargetList) DeepCopyObject() runtime.Object { + if c := in.DeepCopy(); c != nil { + return c + } + return nil +} + +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *TargetSpec) DeepCopyInto(out *TargetSpec) { + *out = *in +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TargetSpec. +func (in *TargetSpec) DeepCopy() *TargetSpec { + if in == nil { + return nil + } + out := new(TargetSpec) + in.DeepCopyInto(out) + return out +} + +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *TargetStatus) DeepCopyInto(out *TargetStatus) { + *out = *in +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TargetStatus. +func (in *TargetStatus) DeepCopy() *TargetStatus { + if in == nil { + return nil + } + out := new(TargetStatus) + in.DeepCopyInto(out) + return out +} diff --git a/config/crd/bases/mpas.ocm.software_targets.yaml b/config/crd/bases/mpas.ocm.software_targets.yaml new file mode 100644 index 0000000..27caea9 --- /dev/null +++ b/config/crd/bases/mpas.ocm.software_targets.yaml @@ -0,0 +1,74 @@ +--- +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + annotations: + controller-gen.kubebuilder.io/version: v0.11.1 + creationTimestamp: null + name: targets.mpas.ocm.software +spec: + group: mpas.ocm.software + names: + kind: Target + listKind: TargetList + plural: targets + singular: target + scope: Namespaced + versions: + - name: v1alpha1 + schema: + openAPIV3Schema: + description: Target is the Schema for the targets 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: TargetSpec defines the desired state of Target + properties: + access: + description: Access defines the access information for a target + properties: + secretRef: + description: TargetSecretRef defines the reference to a secret + within the cluster + properties: + name: + type: string + namespace: + description: Should we specify a default value? + type: string + required: + - name + type: object + required: + - secretRef + type: object + type: + description: 'Type specifies the type of the target. Possible values + are: kubernetes, ssh, ociRepository' + enum: + - kubernetes + - ssh + - ociRepository + type: string + required: + - type + type: object + status: + description: TargetStatus defines the observed state of Target + type: object + type: object + served: true + storage: true + subresources: + status: {} diff --git a/config/crd/kustomization.yaml b/config/crd/kustomization.yaml index c17a40d..ec1e260 100644 --- a/config/crd/kustomization.yaml +++ b/config/crd/kustomization.yaml @@ -3,17 +3,20 @@ # It should be run by config/default resources: - bases/mpas.ocm.software_projects.yaml +- bases/mpas.ocm.software_targets.yaml #+kubebuilder:scaffold:crdkustomizeresource patchesStrategicMerge: # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix. # patches here are for enabling the conversion webhook for each CRD #- patches/webhook_in_projects.yaml +#- patches/webhook_in_targets.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 #- patches/cainjection_in_projects.yaml +#- patches/cainjection_in_targets.yaml #+kubebuilder:scaffold:crdkustomizecainjectionpatch # the following config is for teaching kustomize how to do kustomization for CRDs. diff --git a/config/crd/patches/cainjection_in_targets.yaml b/config/crd/patches/cainjection_in_targets.yaml new file mode 100644 index 0000000..97a8063 --- /dev/null +++ b/config/crd/patches/cainjection_in_targets.yaml @@ -0,0 +1,7 @@ +# The following patch adds a directive for certmanager to inject CA into the CRD +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + annotations: + cert-manager.io/inject-ca-from: $(CERTIFICATE_NAMESPACE)/$(CERTIFICATE_NAME) + name: targets.mpas.ocm.software diff --git a/config/crd/patches/webhook_in_targets.yaml b/config/crd/patches/webhook_in_targets.yaml new file mode 100644 index 0000000..466e918 --- /dev/null +++ b/config/crd/patches/webhook_in_targets.yaml @@ -0,0 +1,16 @@ +# The following patch enables a conversion webhook for the CRD +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + name: targets.mpas.ocm.software +spec: + conversion: + strategy: Webhook + webhook: + clientConfig: + service: + namespace: system + name: webhook-service + path: /convert + conversionReviewVersions: + - v1 diff --git a/config/rbac/target_editor_role.yaml b/config/rbac/target_editor_role.yaml new file mode 100644 index 0000000..415a000 --- /dev/null +++ b/config/rbac/target_editor_role.yaml @@ -0,0 +1,31 @@ +# permissions for end users to edit targets. +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRole +metadata: + labels: + app.kubernetes.io/name: clusterrole + app.kubernetes.io/instance: target-editor-role + app.kubernetes.io/component: rbac + app.kubernetes.io/created-by: mpas-project-controller + app.kubernetes.io/part-of: mpas-project-controller + app.kubernetes.io/managed-by: kustomize + name: target-editor-role +rules: +- apiGroups: + - mpas.ocm.software + resources: + - targets + verbs: + - create + - delete + - get + - list + - patch + - update + - watch +- apiGroups: + - mpas.ocm.software + resources: + - targets/status + verbs: + - get diff --git a/config/rbac/target_viewer_role.yaml b/config/rbac/target_viewer_role.yaml new file mode 100644 index 0000000..f135392 --- /dev/null +++ b/config/rbac/target_viewer_role.yaml @@ -0,0 +1,27 @@ +# permissions for end users to view targets. +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRole +metadata: + labels: + app.kubernetes.io/name: clusterrole + app.kubernetes.io/instance: target-viewer-role + app.kubernetes.io/component: rbac + app.kubernetes.io/created-by: mpas-project-controller + app.kubernetes.io/part-of: mpas-project-controller + app.kubernetes.io/managed-by: kustomize + name: target-viewer-role +rules: +- apiGroups: + - mpas.ocm.software + resources: + - targets + verbs: + - get + - list + - watch +- apiGroups: + - mpas.ocm.software + resources: + - targets/status + verbs: + - get diff --git a/config/samples/mpas_v1alpha1_target.yaml b/config/samples/mpas_v1alpha1_target.yaml new file mode 100644 index 0000000..fbbe453 --- /dev/null +++ b/config/samples/mpas_v1alpha1_target.yaml @@ -0,0 +1,12 @@ +apiVersion: mpas.ocm.software/v1alpha1 +kind: Target +metadata: + labels: + app.kubernetes.io/name: target + app.kubernetes.io/instance: target-sample + app.kubernetes.io/part-of: mpas-project-controller + app.kubernetes.io/managed-by: kustomize + app.kubernetes.io/created-by: mpas-project-controller + name: target-sample +spec: + # TODO(user): Add fields here