Update README for raw URLs to manifest YAMLs (#13)

.ci/scripts/generate-portainer-manifests-from-chart.sh

@@ -15,18 +15,39 @@
 # 2. Remove the header produced by helf --dry-run
 # 3. Remove references to helm in rendered manifests (no point attaching a label like "app.kubernetes.io/managed-by: Helm" if we are not!)
 
-helm install --no-hooks --namespace zorgburger --set disableTest=true --dry-run zorgburger charts/portainer \
+# Create nodeport manifest for ce
+helm install --no-hooks --namespace zorgburger --set service.type=NodePort --set disableTest=true --set createNamespace=true --dry-run zorgburger charts/portainer \
 | sed -n '1,/NOTES/p' | sed \$d \
 | grep -vE 'NAME|LAST DEPLOYED|NAMESPACE|STATUS|REVISION|HOOKS|MANIFEST|TEST SUITE' \
 | grep -iv helm \
 | sed 's/zorgburger/portainer/' \
 | sed 's/portainer-portainer/portainer/' \
 > deploy/manifests/portainer/portainer.yaml
 
-helm install --no-hooks --namespace zorgburger --set service.type=LoadBalancer --set disableTest=true --dry-run zorgburger charts/portainer \
+
+# Create lb manifest for ce
+helm install --no-hooks --namespace zorgburger --set service.type=LoadBalancer --set disableTest=true --set createNamespace=true --dry-run zorgburger charts/portainer \
 | sed -n '1,/NOTES/p' | sed \$d \
 | grep -vE 'NAME|LAST DEPLOYED|NAMESPACE|STATUS|REVISION|HOOKS|MANIFEST|TEST SUITE' \
 | grep -iv helm \
 | sed 's/zorgburger/portainer/' \
 | sed 's/portainer-portainer/portainer/' \
 > deploy/manifests/portainer/portainer-lb.yaml
+
+# Create nodeport manifest for ee
+helm install --no-hooks --namespace zorgburger --set enterpriseEdition.enabled=true --set service.type=NodePort --set disableTest=true --set createNamespace=true --dry-run zorgburger charts/portainer \
+| sed -n '1,/NOTES/p' | sed \$d \
+| grep -vE 'NAME|LAST DEPLOYED|NAMESPACE|STATUS|REVISION|HOOKS|MANIFEST|TEST SUITE' \
+| grep -iv helm \
+| sed 's/zorgburger/portainer/' \
+| sed 's/portainer-portainer/portainer/' \
+> deploy/manifests/portainer/portainer-ee.yaml
+
+# Create lb manifest for ee
+helm install --no-hooks --namespace zorgburger --set enterpriseEdition.enabled=true --set service.type=LoadBalancer --set disableTest=true --set createNamespace=true --dry-run zorgburger charts/portainer \
+| sed -n '1,/NOTES/p' | sed \$d \
+| grep -vE 'NAME|LAST DEPLOYED|NAMESPACE|STATUS|REVISION|HOOKS|MANIFEST|TEST SUITE' \
+| grep -iv helm \
+| sed 's/zorgburger/portainer/' \
+| sed 's/portainer-portainer/portainer/' \
+> deploy/manifests/portainer/portainer-lb-ee.yaml

.github/workflows/on-push-lint-charts.yml

@@ -4,31 +4,104 @@ on:
   push:
     paths:
       - 'charts/**' 
-      - '.github/**'            
+      - '.github/**'
+  pull_request:
+    branches:
+      - master
+  workflow_dispatch:
+
+env:
+  KUBE_SCORE_VERSION: 1.10.0
+  HELM_VERSION: v3.10.1
 
 jobs:
   lint-test:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v1
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
 
+      - name: Set up Helm
+        uses: azure/setup-helm@v4.2.0
+        with:
+          version: ${{ env.HELM_VERSION }}
+
+      - name: Set up kube-score
+        run: |
+          wget https://github.com/zegl/kube-score/releases/download/v${{ env.KUBE_SCORE_VERSION }}/kube-score_${{ env.KUBE_SCORE_VERSION }}_linux_amd64 -O kube-score
+          chmod 755 kube-score
+
+      - name: Kube-score generated manifests
+        run: helm template charts/* | ./kube-score score -
+              --ignore-test pod-networkpolicy
+              --ignore-test deployment-has-poddisruptionbudget
+              --ignore-test deployment-has-host-podantiaffinity
+              --ignore-test container-security-context
+              --ignore-test container-resources
+              --ignore-test pod-probes
+              --ignore-test container-image-tag
+              --enable-optional-test container-security-context-privileged
+
+      # python is a requirement for the chart-testing action below (supports yamllint among other tests)
+      - uses: actions/setup-python@v5.3.0
+        with:
+          python-version: 3.13.1
+
+      - name: Set up chart-testing
+        uses: helm/chart-testing-action@v2.6.1
+        with:
+          version: v3.10.1
+
+      - name: Run chart-testing (list-changed)
+        id: list-changed
+        run: |
+          changed=$(ct list-changed --config .ci/ct-config.yaml)
+          if [[ -n "$changed" ]]; then
+            echo "::set-output name=changed::true"
+          fi
+
       - name: Run chart-testing (lint)
-        id: lint
-        uses: helm/chart-testing-action@v1.0.0
+        run: ct lint --config .ci/ct-config.yaml
+
+      # Refer to https://github.com/kubernetes-sigs/kind/releases when updating the node_images
+      - name: Create 1.29 kind cluster
+        uses: helm/kind-action@v1.12.0
         with:
-          config: .ci/ct-config.yaml
-          command: lint
+          node_image: kindest/node:v1.29.14@sha256:8703bd94ee24e51b778d5556ae310c6c0fa67d761fae6379c8e0bb480e6fea29
+          cluster_name: kubernetes-1.29
+        if: steps.list-changed.outputs.changed == 'true'
 
-      - name: Create kind cluster
-        uses: helm/kind-action@v1.0.0
+      - name: Run chart-testing (install) against 1.29
+        run: ct install --config .ci/ct-config.yaml
+
+      - name: Create 1.30 kind cluster
+        uses: helm/kind-action@v1.12.0
         with:
-          install_local_path_provisioner: true
-        # Only build a kind cluster if there are chart changes to test.
-        if: steps.lint.outputs.changed == 'true'
+          node_image: kindest/node:v1.30.10@sha256:4de75d0e82481ea846c0ed1de86328d821c1e6a6a91ac37bf804e5313670e507
+          cluster_name: kubernetes-1.30
+        if: steps.list-changed.outputs.changed == 'true'
+
+      - name: Run chart-testing (install) against 1.30
+        run: ct install --config .ci/ct-config.yaml
 
-      - name: Run chart-testing (install)
-        uses: helm/chart-testing-action@v1.0.0
+      - name: Create 1.31 kind cluster
+        uses: helm/kind-action@v1.12.0
         with:
-          command: install
-          config: .ci/ct-config.yaml
+          node_image: kindest/node:v1.31.6@sha256:28b7cbb993dfe093c76641a0c95807637213c9109b761f1d422c2400e22b8e87
+          cluster_name: kubernetes-1.31
+        if: steps.list-changed.outputs.changed == 'true'
+
+      - name: Run chart-testing (install) against 1.31
+        run: ct install --config .ci/ct-config.yaml
+
+      - name: Create 1.32 kind cluster
+        uses: helm/kind-action@v1.12.0
+        with:
+          node_image: kindest/node:v1.32.2@sha256:f226345927d7e348497136874b6d207e0b32cc52154ad8323129352923a3142f
+          cluster_name: kubernetes-1.32
+        if: steps.list-changed.outputs.changed == 'true'
+
+      - name: Run chart-testing (install) against 1.32
+        run: ct install --config .ci/ct-config.yaml

.github/workflows/on-push-master-publish-chart.yml

@@ -6,13 +6,16 @@ on:
       - master
     paths:
       - 'charts/**' 
-      - '.github/**'         
+      - '.github/**'     
+      - 'deploy/manifests/**'    
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
-
+    permissions:
+      contents: write
+      pages: write
+      pull-requests: write
     steps:
     - uses: actions/checkout@v2
 
@@ -25,6 +28,13 @@ jobs:
         git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
 
     - name: Run chart-releaser
-      uses: helm/chart-releaser-action@v1.0.0
+      uses: helm/chart-releaser-action@v1.1.0
       env:
-        CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+        CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+
+    - name: sync gh-pages branch
+      uses: repo-sync/pull-request@v2
+      with:
+        destination_branch: "gh-pages"
+        github_token: "${{ secrets.GITHUB_TOKEN }}"
+        pr_allow_empty: false

README.md

@@ -1,9 +1,30 @@
-# Portainer Kubernetes Deployment
 
-This repo contains helm and YAML (yuch) for deploying Portainer into a Kubernetes environment
+This repo contains helm and YAML for deploying Portainer into a Kubernetes environment. Follow the applicable instructions for your edition / deployment methodology below:
 
+- [Deploying with Helm](#deploying-with-helm)
+  - [Community Edition](#community-edition)
+    - [Using NodePort on a local/remote cluster](#using-nodeport-on-a-localremote-cluster)
+    - [Using a cloud provider's loadbalancer](#using-a-cloud-providers-loadbalancer)
+    - [Using ClusterIP with an ingress](#using-clusterip-with-an-ingress)
+  - [Enterprise Edition](#enterprise-edition)
+    - [Using NodePort on a local/remote cluster](#using-nodeport-on-a-localremote-cluster-1)
+    - [Using a cloud provider's loadbalancer](#using-a-cloud-providers-loadbalancer-1)
+    - [Using ClusterIP with an ingress](#using-clusterip-with-an-ingress-1)
+- [Deploying with manifests](#deploying-with-manifests)
+  - [Community Edition](#community-edition-1)
+    - [Using NodePort on a local/remote cluster](#using-nodeport-on-a-localremote-cluster-2)
+    - [Using a cloud provider's loadbalancer](#using-a-cloud-providers-loadbalancer-2)
+  - [Enterprise Edition](#enterprise-edition-1)
+    - [Using NodePort on a local/remote cluster](#using-nodeport-on-a-localremote-cluster-3)
+    - [Using a cloud provider's loadbalancer](#using-a-cloud-providers-loadbalancer-3)
+- [Note re persisting data](#note-re-persisting-data)
 
-## Quickstart with Helm
+
+
+
+# Deploying with Helm
+
+Ensure you're using at least helm v3.2, which [includes support](https://github.com/helm/helm/pull/7648) for the `--create-namespace` argument.
 
 Install the repository:
 
@@ -12,55 +33,114 @@ helm repo add portainer https://portainer.github.io/k8s/
 helm repo update
 ```
 
-Create the portainer namespace:
+## Community Edition
+
+Install the helm chart:
+
+### Using NodePort on a local/remote cluster
 
 ```
-kubectl create namespace portainer
+helm install --create-namespace -n portainer portainer portainer/portainer
 ```
 
-Install the helm chart:
+###  Using a cloud provider's loadbalancer
+
+```
+helm install --create-namespace -n portainer portainer portainer/portainer \
+--set service.type=LoadBalancer
+```
+
+
+### Using ClusterIP with an ingress
+
+```
+helm install --create-namespace -n portainer portainer portainer/portainer \
+--set service.type=ClusterIP
+```
+
+For advanced helm customization, see the [chart README](/charts/portainer/README.md)
+
+## Enterprise Edition
 
 ### Using NodePort on a local/remote cluster
 
 ```
-helm install -n portainer portainer portainer/portainer
+helm install --create-namespace -n portainer portainer portainer/portainer \
+--set enterpriseEdition.enabled=true 
 ```
 
 ###  Using a cloud provider's loadbalancer
 
 ```
-helm install -n portainer portainer portainer/portainer --set service.type=LoadBalancer
+helm install --create-namespace -n portainer portainer portainer/portainer \
+--set enterpriseEdition.enabled=true  \
+--set service.type=LoadBalancer
 ```
 
 
 ### Using ClusterIP with an ingress
 
 ```
-helm install -n portainer portainer portainer/portainer --set service.type=ClusterIP
+helm install --create-namespace -n portainer portainer portainer/portainer \
+--set enterpriseEdition.enabled=true \
+--set service.type=ClusterIP
 ```
 
 For advanced helm customization, see the [chart README](/charts/portainer/README.md)
 
-## Quickstart with manifests
+# Deploying with manifests
 
-If you're not into helm, you can install Portainer using manifests, by first creating the portainer namespace:
+If you're not using helm, you can install Portainer using manifests directly, as follows
+
+## Community Edition
+
+### Using NodePort on a local/remote cluster
 
 ```
-kubectl create namespace portainer
+kubectl apply -f https://raw.githubusercontent.com/portainer/k8s/master/deploy/manifests/portainer/portainer.yaml
 ```
 
-And then...
+###  Using a cloud provider's loadbalancer
+
+```
+kubectl apply -f https://raw.githubusercontent.com/portainer/k8s/master/deploy/manifests/portainer/portainer-lb.yaml
+```
+
+## Enterprise Edition
 
 ### Using NodePort on a local/remote cluster
 
 ```
-kubectl create namespace portainer
-kubectl apply -n portainer -f https://portainer.github.io/k8s//deploy/manifests/portainer/portainer.yaml
+kubectl apply- f https://raw.githubusercontent.com/portainer/k8s/master/deploy/manifests/portainer/portainer-ee.yaml
 ```
 
 ###  Using a cloud provider's loadbalancer
 
 ```
-kubectl create namespace portainer
-kubectl apply -n portainer -f https://portainer.github.io/k8s//deploy/manifests/portainer/portainer-lb.yaml
+kubectl apply -f https://raw.githubusercontent.com/portainer/k8s/master/deploy/manifests/portainer/portainer-lb-ee.yaml
+```
+
+# Note re persisting data
+
+The charts/manifests will create a persistent volume for storing Portainer data, using the default StorageClass.
+
+In some Kubernetes clusters (microk8s), the default Storage Class simply creates hostPath volumes, which are not explicitly tied to a particular node. In a multi-node cluster, this can create an issue when the pod is terminated and rescheduled on a different node, "leaving" all the persistent data behind and starting the pod with an "empty" volume.
+
+While this behaviour is inherently a limitation of using hostPath volumes, a suitable workaround is to use add a nodeSelector to the deployment, which effectively "pins" the portainer pod to a particular node.
+
+The nodeSelector can be added in the following ways:
+
+1. Edit your own values.yaml and set the value of nodeSelector like this:
+
+```
+nodeSelector:
+  kubernetes.io/hostname: <YOUR NODE NAME>
+```
+
+2. Explicictly set the target node when deploying/updating the helm chart on the CLI, by including `--set nodeSelector.kubernetes.io/hostname=<YOUR NODE NAME>`
+
+3. If you've deployed Portainer via manifests, without Helm, run the following one-liner to "patch" the deployment, forcing the pod to always be scheduled on the node it's currently running on:
+
+```
+kubectl patch deployments -n portainer portainer -p '{"spec": {"template": {"spec": {"nodeSelector": {"kubernetes.io/hostname": "'$(kubectl get pods -n portainer -o jsonpath='{ ..nodeName }')'"}}}}}' || (echo Failed to identify current node of portainer pod; exit 1)
 ```

charts/portainer/Chart.yaml

@@ -16,16 +16,16 @@ type: application
 
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
-version: 1.0.1
 
+version: 2.33.6
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application.
-appVersion: 2.0.0
+appVersion: ce-latest-ee-2.33.6
 
 sources:
     - https://github.com/portainer/k8s
 
 maintainers:
-    - name: funkypenguin
-      email: davidy@funkypenguin.co.nz
-      url: https://www.funkypenguin.co.nz
+    - name: Portainer
+      email: platform-team@portainer.io
+      url: https://www.portainer.io