Merge pull request #19 from stakater/SA-7871_gotemplate-support-added

Sa 7871 gotemplate support added

Author: rasheedamir

.github/workflows/pull_request.yaml

@@ -8,7 +8,7 @@ on:
 
 jobs:
   doc_qa:
-    uses: stakater/.github/.github/workflows/pull_request_doc_qa.yaml@v0.0.131
+    uses: stakater/.github/.github/workflows/pull_request_doc_qa.yaml@v0.0.137
     with:
       MD_CONFIG: .github/md_config.json
       DOC_SRC: content README.md
@@ -23,7 +23,7 @@ jobs:
   build_container:
     needs: deploy_doc
     if: ${{ github.base_ref == 'main' }}
-    uses: stakater/.github/.github/workflows/pull_request_container_build.yaml@v0.0.131
+    uses: stakater/.github/.github/workflows/pull_request_container_build.yaml@v0.0.137
     with:
       DOCKER_BUILD_CONTEXTS: content=https://github.com/stakater/template-operator-docs.git#pull-request-deployments
       DOCKER_FILE_PATH: Dockerfile
@@ -35,29 +35,43 @@ jobs:
       DOCKER_SECRETS: GIT_AUTH_TOKEN=${{ secrets.PUBLISH_TOKEN }}
   test:
     runs-on: ubuntu-latest
-    needs: [
-      build_container,
-      deploy_doc
-    ]
+    needs: [ build_container, deploy_doc ]
     env:
       CURRENT_BRANCH: ${{ needs.deploy_doc.outputs.CURRENT_BRANCH }}
       IMAGE_PATH: ${{ needs.build_container.outputs.IMAGE_PATH }}
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
+
       - name: Login to Docker Registry
         uses: docker/login-action@v3
         with:
           registry: ghcr.io/stakater
           username: ${{ github.actor }}
           password: ${{ secrets.GHCR_TOKEN }}
+      
       - name: Run Docker container for the docs
         run: |
-          docker run -d --name template-operator-docs -p 8080:8080 ${{ env.IMAGE_PATH }} || exit 1
-      - name: Build testcafe tests
-        working-directory: ./testcafe
+          docker run -d --name template-operator-docs -p 8080:8080 $IMAGE_PATH
+      
+      - name: Wait for docs site to be ready
+        run: |
+          echo "Waiting for docs site to be ready..."
+          timeout 60 bash -c 'until curl -f http://127.0.0.1:8080/${{ env.CURRENT_BRANCH }}/ > /dev/null 2>&1; do sleep 2; done'
+          echo "Docs site is ready!"
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install dependencies
+        working-directory: ./e2e      
         run: |
-          docker build -t testcafe-tests --build-arg CURRENT_BRANCH=${{ env.CURRENT_BRANCH }} .
-      - name: Run Docker container to run tests
+          yarn install
+          npx playwright install --with-deps
+
+      - name: Run Playwright tests
+        working-directory: ./e2e
         run: |
-          docker run --rm --network="host" --name myapp-testcafe-container testcafe-tests:latest
+          yarn test --reporter=line

.vale.ini

@@ -1,7 +1,7 @@
 StylesPath = styles
 MinAlertLevel = warning
 
-Packages = https://github.com/stakater/vale-package/releases/download/v0.0.60/Stakater.zip
+Packages = https://github.com/stakater/vale-package/releases/download/v0.0.89/Stakater.zip
 Vocab = Stakater
 
 # Only check MarkDown files

content/architecture/concepts.md

@@ -4,7 +4,7 @@ Here are the key concepts of Template Operator:
 
 ## Template
 
-A **Template** is a reusable blueprint in Template Operator that defines configurations for Kubernetes resources. It supports raw manifests, Helm charts, or resource mappings, enabling standardization and automation across multiple tenants.
+A **Template** is a reusable blueprint in Template Operator that defines configurations for Kubernetes resources. It supports raw manifests, gotemplate based dynamic manifests, Helm charts, or resource mappings, enabling standardization and automation across multiple tenants.
 
 ## Template Instance (TI)
 

content/kubernetes-resources/cluster-template-instance.md

@@ -17,9 +17,9 @@ spec:
       values:
         - alpha
         - beta
-parameters:
-  - name: CIDR_IP
-    value: "172.17.0.0/16"
+  parameters:
+    - name: CIDR_IP
+      value: "172.17.0.0/16"
 ```
 
 ClusterTemplateInstance distributes a template across multiple namespaces which are selected by labelSelector.

content/kubernetes-resources/how-to-guides/deploying-templates.md

@@ -186,11 +186,11 @@ metadata:
 spec:
   template: namespace-parameterized-restrictions
   sync: true
-parameters:
-  - name: DEFAULT_CPU_LIMIT
-    value: "1.5"
-  - name: DEFAULT_CPU_REQUESTS
-    value: "1"
+  parameters:
+    - name: DEFAULT_CPU_LIMIT
+      value: "1.5"
+    - name: DEFAULT_CPU_REQUESTS
+      value: "1"
 ```
 
 If she wants to distribute the same Template over multiple namespaces, she can use `ClusterTemplateInstance`.
@@ -210,9 +210,9 @@ spec:
       values:
         - alpha
         - beta
-parameters:
-  - name: DEFAULT_CPU_LIMIT
-    value: "1.5"
-  - name: DEFAULT_CPU_REQUESTS
-    value: "1"
+  parameters:
+    - name: DEFAULT_CPU_LIMIT
+      value: "1.5"
+    - name: DEFAULT_CPU_REQUESTS
+      value: "1"
 ```

content/kubernetes-resources/template-instance.md

@@ -11,9 +11,9 @@ metadata:
 spec:
   template: networkpolicy
   sync: true
-parameters:
-  - name: CIDR_IP
-    value: "172.17.0.0/16"
+  parameters:
+    - name: CIDR_IP
+      value: "172.17.0.0/16"
 ```
 
 TemplateInstance are used to keep track of resources created from Templates, which are being instantiated inside a Namespace.

content/kubernetes-resources/template.md

@@ -8,7 +8,7 @@ Also, you can define custom variables in `Template`, `TemplateInstance` and `Clu
 
 ## Specification
 
-`Template` Custom Resource (CR) supports three key methods for defining and managing resources: `manifests`, `helm`, and `resource mapping`. Let’s dive into each method, their differences, and their use cases:
+`Template` Custom Resource (CR) supports three key methods for defining and managing resources: `manifests`, `helm`, `gotemplate`, and `resource mapping`. Let’s dive into each method, their differences, and their use cases:
 
 ### 1. Manifests
 
@@ -140,7 +140,49 @@ A brief explanation of the fields in the Helm section:
     * `forceString`: Whether to use `--set` or `--set-string` when setting the value. Default is `false` (use `--set`).
 * `values`: The values file for the Helm chart.
 
-### 3. Resource Mapping
+### 3. GoTemplate
+
+This method uses inline Go templates to dynamically generate Kubernetes manifests. It leverages Go’s `text/template` syntax along with Sprig functions for string operations, date formatting, conditionals, arithmetic, and more.
+
+#### How It Works
+
+* The `gotemplate` section contains YAML written with Go template expressions such as `{{ .Name }}` or `{{ now | date "2006-01-02" }}`.
+* Template `parameters` are injected at runtime, and Sprig functions can be used to transform or compute values.
+* The rendered output must be valid Kubernetes YAML, which the operator then applies to the target namespaces.
+
+#### Use Cases
+
+* Ideal for dynamic resource generation without maintaining a full Helm chart.
+* Useful when you need lightweight templating with conditional or computed fields.
+* Suitable for resources that change based on tenant, namespace, or environment attributes.
+
+#### Example
+
+```yaml
+apiVersion: templates.stakater.com/v1alpha1
+kind: Template
+metadata:
+  name: inline-gotemplate
+parameters:
+  - name: Name
+    value: "sample-App"
+  - name: LogLevel
+    value: "INFO"
+resources:
+  gotemplate: |
+    apiVersion: v1
+    kind: ConfigMap
+    metadata:
+      name: "{{ .Name | lower }}-config"
+      labels:
+        app: "{{ .Name | lower }}"
+    data:
+      appName: "{{ .Name }}"
+      logLevel: "{{ .LogLevel }}"
+      configVersion: "{{ now | date "2006-01-02" }}"
+```
+
+### 4. Resource Mapping
 
 This approach maps secrets and ConfigMaps from one tenant's namespace to another tenant's namespace, or within a tenant's namespace.
 

e2e/Dockerfile

@@ -0,0 +1,23 @@
+# Stage 1: Install Playwright and Chromium
+FROM node:22-bookworm AS playwright-setup
+
+WORKDIR /e2e
+
+# Copy package files
+COPY package.json yarn.lock* ./
+
+# Install dependencies
+RUN yarn install --frozen-lockfile || yarn install
+
+# Install only Chromium browser
+RUN npx playwright install --with-deps chromium
+
+# Copy tests
+COPY src ./src
+COPY playwright.config.ts ./
+
+# Set CI env for Playwright
+ENV CI=true
+
+# Run Playwright tests
+CMD ["yarn", "start"]

e2e/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "e2e",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "dependencies": {
+    "@types/node": "^24.10.1",
+    "dotenv": "^17.2.3"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.57.0"
+  },
+  "scripts": {
+    "local": "playwright test --headed",
+    "start": "playwright test",
+    "test": "playwright test",
+    "test:ui": "playwright test --ui",
+    "test:debug": "playwright test --debug"
+  }
+}

e2e/playwright.config.ts

@@ -0,0 +1,23 @@
+import { defineConfig, devices } from '@playwright/test';
+
+export default defineConfig({
+  testDir: './src',
+  fullyParallel: true,
+  forbidOnly: !!process.env.CI,
+  retries: process.env.CI ? 2 : 0,
+  workers: process.env.CI ? 1 : undefined,
+  reporter: process.env.CI ? 'github' : 'html',
+  use: {
+    baseURL: process.env.BASE_URL || 'http://127.0.0.1:8080',
+    trace: 'on-first-retry',
+  },
+  projects: [
+    {
+      name: 'chromium',
+      use: {
+        ...devices['Desktop Chrome'],
+        headless: true,
+      },
+    },
+  ],
+});