PR: Generate Reference Docs for v1alpha2 Resources

CHANGELOG.md

@@ -1,6 +1,15 @@
 <a name="unreleased"></a>
 ## [Unreleased]
 
+### Feat
+- **code-editor:** :rocket: implement code editor (robotide in v1alpha1)
+
+### Fix
+- **update:** remove already exists condition from update to prevent redundant reconciles
+
+
+<a name="v0.2.7-alpha.6.3"></a>
+## [v0.2.7-alpha.6.3] - 2024-03-18
 
 <a name="v0.2.7-alpha.6.2"></a>
 ## [v0.2.7-alpha.6.2] - 2024-03-18
@@ -440,7 +449,8 @@
 - Merge pull request [#24](https://github.com/robolaunch/robot-operator/issues/24) from robolaunch/23-allow-multiple-launches
 
 
-[Unreleased]: https://github.com/robolaunch/robot-operator/compare/v0.2.7-alpha.6.2...HEAD
+[Unreleased]: https://github.com/robolaunch/robot-operator/compare/v0.2.7-alpha.6.3...HEAD
+[v0.2.7-alpha.6.3]: https://github.com/robolaunch/robot-operator/compare/v0.2.7-alpha.6.2...v0.2.7-alpha.6.3
 [v0.2.7-alpha.6.2]: https://github.com/robolaunch/robot-operator/compare/v0.2.7-alpha.6...v0.2.7-alpha.6.2
 [v0.2.7-alpha.6]: https://github.com/robolaunch/robot-operator/compare/v0.2.7-alpha.4...v0.2.7-alpha.6
 [v0.2.7-alpha.4]: https://github.com/robolaunch/robot-operator/compare/v0.2.7-alpha.1...v0.2.7-alpha.4

PROJECT

@@ -195,4 +195,17 @@ resources:
     defaulting: true
     validation: true
     webhookVersion: v1
+- api:
+    crdVersion: v1
+    namespaced: true
+  controller: true
+  domain: roboscale.io
+  group: robot
+  kind: EdgeProxy
+  path: github.com/robolaunch/robot-operator/pkg/api/roboscale.io/v1alpha2
+  version: v1alpha2
+  webhooks:
+    defaulting: true
+    validation: true
+    webhookVersion: v1
 version: "3"

config/crd/bases/robot.roboscale.io_edgeproxies.yaml

@@ -0,0 +1,45 @@
+---
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  annotations:
+    controller-gen.kubebuilder.io/version: v0.9.2
+  creationTimestamp: null
+  name: edgeproxies.robot.roboscale.io
+spec:
+  group: robot.roboscale.io
+  names:
+    kind: EdgeProxy
+    listKind: EdgeProxyList
+    plural: edgeproxies
+    singular: edgeproxy
+  scope: Namespaced
+  versions:
+  - name: v1alpha2
+    schema:
+      openAPIV3Schema:
+        description: EdgeProxy is the Schema for the edgeproxies 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: EdgeProxySpec defines the desired state of EdgeProxy.
+            type: object
+          status:
+            description: EdgeProxyStatus defines the observed state of EdgeProxy.
+            type: object
+        type: object
+    served: true
+    storage: true
+    subresources:
+      status: {}

config/crd/kustomization.yaml

@@ -21,6 +21,7 @@ resources:
 - bases/robot.roboscale.io_ros2workloads.yaml
 - bases/robot.roboscale.io_ros2bridges.yaml
 - bases/robot.roboscale.io_codeeditors.yaml
+- bases/robot.roboscale.io_edgeproxies.yaml
 #+kubebuilder:scaffold:crdkustomizeresource
 
 patchesStrategicMerge:
@@ -43,6 +44,7 @@ patchesStrategicMerge:
 #- patches/webhook_in_ros2workloads.yaml
 #- patches/webhook_in_ros2bridges.yaml
 #- patches/webhook_in_codeeditors.yaml
+#- patches/webhook_in_edgeproxies.yaml
 #+kubebuilder:scaffold:crdkustomizewebhookpatch
 
 # [CERTMANAGER] To enable cert-manager, uncomment all the sections with [CERTMANAGER] prefix.
@@ -64,6 +66,7 @@ patchesStrategicMerge:
 #- patches/cainjection_in_ros2workloads.yaml
 #- patches/cainjection_in_ros2bridges.yaml
 #- patches/cainjection_in_codeeditors.yaml
+#- patches/cainjection_in_edgeproxies.yaml
 #+kubebuilder:scaffold:crdkustomizecainjectionpatch
 
 # the following config is for teaching kustomize how to do kustomization for CRDs.

config/crd/patches/cainjection_in_edgeproxies.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: edgeproxies.robot.roboscale.io

config/crd/patches/webhook_in_edgeproxies.yaml

@@ -0,0 +1,16 @@
+# The following patch enables a conversion webhook for the CRD
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  name: edgeproxies.robot.roboscale.io
+spec:
+  conversion:
+    strategy: Webhook
+    webhook:
+      clientConfig:
+        service:
+          namespace: system
+          name: webhook-service
+          path: /convert
+      conversionReviewVersions:
+      - v1

config/manager/kustomization.yaml

@@ -5,4 +5,4 @@ kind: Kustomization
 images:
 - name: controller
   newName: robolaunchio/robot-controller-manager
-  newTag: v0.2.7-alpha.6.3
+  newTag: v0.2.7-alpha.6.4

config/rbac/edgeproxy_editor_role.yaml

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

config/rbac/edgeproxy_viewer_role.yaml

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

config/rbac/role.yaml

@@ -263,6 +263,32 @@ rules:
   - get
   - patch
   - update
+- apiGroups:
+  - robot.roboscale.io
+  resources:
+  - edgeproxies
+  verbs:
+  - create
+  - delete
+  - get
+  - list
+  - patch
+  - update
+  - watch
+- apiGroups:
+  - robot.roboscale.io
+  resources:
+  - edgeproxies/finalizers
+  verbs:
+  - update
+- apiGroups:
+  - robot.roboscale.io
+  resources:
+  - edgeproxies/status
+  verbs:
+  - get
+  - patch
+  - update
 - apiGroups:
   - robot.roboscale.io
   resources:

config/samples/robot_v1alpha2_edgeproxy.yaml

@@ -0,0 +1,12 @@
+apiVersion: robot.roboscale.io/v1alpha2
+kind: EdgeProxy
+metadata:
+  labels:
+    app.kubernetes.io/name: edgeproxy
+    app.kubernetes.io/instance: edgeproxy-sample
+    app.kubernetes.io/part-of: robot-operator
+    app.kuberentes.io/managed-by: kustomize
+    app.kubernetes.io/created-by: robot-operator
+  name: edgeproxy-sample
+spec:
+  # TODO(user): Add fields here

config/webhook/manifests.yaml

@@ -245,6 +245,26 @@ webhooks:
     resources:
     - codeeditors
   sideEffects: None
+- admissionReviewVersions:
+  - v1
+  clientConfig:
+    service:
+      name: webhook-service
+      namespace: system
+      path: /mutate-robot-roboscale-io-v1alpha2-edgeproxy
+  failurePolicy: Fail
+  name: medgeproxy.kb.io
+  rules:
+  - apiGroups:
+    - robot.roboscale.io
+    apiVersions:
+    - v1alpha2
+    operations:
+    - CREATE
+    - UPDATE
+    resources:
+    - edgeproxies
+  sideEffects: None
 ---
 apiVersion: admissionregistration.k8s.io/v1
 kind: ValidatingWebhookConfiguration
@@ -492,3 +512,23 @@ webhooks:
     resources:
     - codeeditors
   sideEffects: None
+- admissionReviewVersions:
+  - v1
+  clientConfig:
+    service:
+      name: webhook-service
+      namespace: system
+      path: /validate-robot-roboscale-io-v1alpha2-edgeproxy
+  failurePolicy: Fail
+  name: vedgeproxy.kb.io
+  rules:
+  - apiGroups:
+    - robot.roboscale.io
+    apiVersions:
+    - v1alpha2
+    operations:
+    - CREATE
+    - UPDATE
+    resources:
+    - edgeproxies
+  sideEffects: None

docs/_coverpage.md

@@ -4,6 +4,6 @@
 
 ![](https://raw.githubusercontent.com/robolaunch/trademark/main/logos/svg/rocket.svg)
 
-# Robot Operator <small>0.2.7-alpha.6.3</small>
+# Robot Operator <small>0.2.7-alpha.6.4</small>
 
 robolaunch Kubernetes Robot Operator manages lifecycle of ROS 2 based robots and enables defining, deploying and distributing robots declaratively.