feat(space-tpl): fix doc

edixos · Nov 16, 2023 · 28392c4 · 28392c4
1 parent 75263eb
commit 28392c4
Show file tree

Hide file tree

Showing 9 changed files with 1,127 additions and 11 deletions.
diff --git a/charts/nauticus/crds/nauticus_crds.yaml b/charts/nauticus/crds/nauticus_crds.yaml
diff --git a/config/crd/patches/cainjection_in_spacetemplates.yaml b/config/crd/patches/cainjection_in_spacetemplates.yaml
@@ -4,4 +4,4 @@ kind: CustomResourceDefinition
 metadata:
   annotations:
     cert-manager.io/inject-ca-from: $(CERTIFICATE_NAMESPACE)/$(CERTIFICATE_NAME)
-  name: spacetemplates.nauticus.io.nauticus.io
+  name: spacetemplates.nauticus.io
diff --git a/config/install.yaml b/config/install.yaml
diff --git a/config/rbac/role.yaml b/config/rbac/role.yaml
@@ -110,7 +110,7 @@ rules:
   verbs:
   - update
 - apiGroups:
-  - nauticus.io.nauticus.io
+  - nauticus.io
   resources:
   - spacetemplates/status
   verbs:

diff --git a/.../samples/space_wth_tpl_ref_overrides.yaml → ...samples/space_with_tpl_ref_overrides.yaml b/.../samples/space_wth_tpl_ref_overrides.yaml → ...samples/space_with_tpl_ref_overrides.yaml
diff --git a/controllers/spacetemplate/controller.go b/controllers/spacetemplate/controller.go
@@ -17,9 +17,9 @@ type Reconciler struct {
 	shared.Reconciler
 }
 
-//+kubebuilder:rbac:groups=nauticus.io.nauticus.io,resources=spacetemplates,verbs=get;list;watch;create;update;patch;delete
-//+kubebuilder:rbac:groups=nauticus.io.nauticus.io,resources=spacetemplates/status,verbs=get;update;patch
-//+kubebuilder:rbac:groups=nauticus.io.nauticus.io,resources=spacetemplates/finalizers,verbs=update
+//+kubebuilder:rbac:groups=nauticus.io,resources=spacetemplates,verbs=get;list;watch;create;update;patch;delete
+//+kubebuilder:rbac:groups=nauticus.io,resources=spacetemplates/status,verbs=get;update;patch
+//+kubebuilder:rbac:groups=nauticus.io,resources=spacetemplates/finalizers,verbs=update
 
 // Reconcile is part of the main kubernetes reconciliation loop which aims to
 // move the current state of the cluster closer to the desired state.

diff --git a/controllers/spacetemplate/reconsiler.go → controllers/spacetemplate/reconciler.go b/controllers/spacetemplate/reconsiler.go → controllers/spacetemplate/reconciler.go
diff --git a/docs/tutorials/space-templates-tutorial.md b/docs/tutorials/space-templates-tutorial.md
@@ -32,7 +32,7 @@ In this example, a Space named `space-tpl-ref-override` references a SpaceTempla
 * This demonstrates the flexibility of SpaceTemplates, allowing Spaces to maintain standard configurations while adjusting specific settings as needed.
 
     ```yaml title="config/samples/space_wth_tpl_ref_overrides.yaml"
-    {% include "../../config/samples/space_wth_tpl_ref_overrides.yaml" %}
+    {% include "../../config/samples/space_with_tpl_ref_overrides.yaml" %}
     ```
 #### Example: Merging Additional Role Bindings
 
@@ -42,5 +42,5 @@ In this example, a Space named `space-tpl-ref-merge` references a Space Template
 * The Space includes additional role bindings for both `viewer` and `editor` roles, with specific subjects.
 * The merged role bindings enrich the Space's access control settings, ensuring flexibility and control.
     ```yaml title="config/samples/space_wth_tpl_merge.yaml"
-    {% include "../../config/samples/space_wth_tpl_merge.yaml" %}
+    {% include "../../config/samples/space_with_tpl_merge.yaml" %}
     ```
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -137,6 +137,8 @@ nav:
 
   - Tutorials:
       - Space Tutorial: tutorials/space-tutorial.md
+      - Space Template Tutorial: tutorials/space-templates-tutorial.md
+
       - Ignore Underlying Deletion: tutorials/ignore-underlying-deletion.md
   - Reference:
       - API Specification: crds-apis.md