-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
patch: added template docs and updated kube-virt
- Loading branch information
1 parent
5a1b554
commit 312f832
Showing
20 changed files
with
424 additions
and
146 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # top-most EditorConfig file | ||
| root = true | ||
|
|
||
| # Unix-style newlines with a newline ending every file | ||
| [*] | ||
| end_of_line = lf | ||
| insert_final_newline = true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| * text=auto |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,7 +24,7 @@ jobs: | |
| uses: helm/[email protected] | ||
|
|
||
| - name: Run lint | ||
| run: ct lint --all --config .github/ct.yaml | ||
| run: ct lint --all --validate-maintainers=false --config .github/ct.yaml | ||
|
|
||
| lint-docs: | ||
| runs-on: ubuntu-latest | ||
|
|
@@ -57,4 +57,4 @@ jobs: | |
| - name: Run kubeconform | ||
| env: | ||
| KUBERNETES_VERSION: ${{ matrix.k8s }} | ||
| run: .github/kubeconform.sh | ||
| run: .github/kubeconform.sh | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| --- | ||
| repos: | ||
| - repo: https://github.com/pre-commit/pre-commit-hooks | ||
| rev: v4.5.0 # Use the ref you want to point at | ||
| hooks: | ||
| - id: trailing-whitespace | ||
| - repo: https://github.com/norwoodj/helm-docs.git | ||
| rev: v1.13.1 | ||
| hooks: | ||
| - id: helm-docs | ||
| args: | ||
| - --chart-search-root=charts | ||
| - repo: local | ||
| hooks: | ||
| - id: chart-lint | ||
| name: Run Chart Lint Test | ||
| language: system | ||
| entry: 'ct lint --all --validate-maintainers=false --config .github/ct.yaml' | ||
| - repo: https://github.com/drewbernetes/pre-commits.git | ||
| rev: v0.1.0 | ||
| hooks: | ||
| - id: trivy | ||
| args: | ||
| - fs | ||
| - . |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,88 @@ | ||
| {{ template "chart.header" . }} | ||
| {{ template "chart.deprecationWarning" . }} | ||
|
|
||
| {{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} | ||
|
|
||
| {{ template "chart.description" . }} | ||
|
|
||
| {{ template "chart.homepageLine" . }} | ||
|
|
||
| ## Installation | ||
|
|
||
| ### Add Helm repository | ||
|
|
||
| ```shell | ||
| helm repo add drew-viles https://drew-viles.github.io/helm-charts | ||
| helm repo update | ||
| ``` | ||
|
|
||
| ## Install chart | ||
|
|
||
| Using config from a file: | ||
|
|
||
| ```bash | ||
| helm upgrade --install {{ template "chart.name" . }} . --values ./values.yaml | ||
| ``` | ||
|
|
||
| ## Updating the Chart | ||
| Make sure you've run and resolved any issues using the following as failures of these will cause the pipeline/actions to fail. | ||
| ``` | ||
| yamllint charts/{{ template "chart.name" . }}/values.yaml --config-file .github/ct.yaml | ||
|
|
||
| helm-docs . | ||
| ``` | ||
|
|
||
| ## Configuration | ||
|
|
||
| The following table lists the configurable parameters of the chart and the default values. | ||
|
|
||
| {{ template "chart.valuesSection" . }} | ||
| {{ template "chart.header" . }} | ||
| {{ template "chart.deprecationWarning" . }} | ||
|
|
||
| {{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }} | ||
|
|
||
| This setup will deploy a multi-replica deployment with a | ||
| web frontend and a database backend. | ||
| They are in reality not linked and do not have a valid application | ||
| but the test is to ensure we can spin things up | ||
| using affinity and ant-affinity, volumes and more. | ||
|
|
||
| ### Features | ||
| * Affinity/anti-affinity to attempt to evenly split workloads | ||
| * Multiple replicas of nginx and Postgresql | ||
| * Volume creation and mounting in Postgresql container | ||
| * Configmap mounting for Nginx Index.php for querying the Postgres sts | ||
| - confirms cluster dns works | ||
| * SQL seeding for populating DB on Post start lifecycle | ||
| - confirms cluster dns works | ||
| * Public and Private Ingress | ||
| * PDB to ensure pods stay online at all times | ||
| * Scripts to deploy, delete and test | ||
|
|
||
| ## Tests | ||
| ### Ingress Testing | ||
|
|
||
| This workload will spin up an example deployment with an ingress | ||
| and certificate combo to confirm that ingress is working with TLS. | ||
|
|
||
| ### Affinity/Anti-Affinity Testing | ||
|
|
||
| This workload will spin up an example deployment to test affinity | ||
| and anti-affinity. | ||
| An Nginx and Postgres workload will be added to the cluster. | ||
|
|
||
| The Nginx pods should sit on different nodes to one another as | ||
| should the Postgres pods. | ||
| However, the Nginx pods should share a node with the Postgres and vice versa. | ||
|
|
||
| Once deployed, confirm that the pods are arranged as such onn each node. | ||
|
|
||
| *** Node X is just a random node in the EKS cluster, the pods are not | ||
| assigned to the nodes in any sort of order due to affinity settings *** | ||
|
|
||
| | **Node A** | **Node B** | **Node C** | | ||
| |:------------|:--------------|:------------| | ||
| | `Nginx` | `Nginx` | `Nginx` | | ||
| | `Postgres` | `Postgres` | `Postgres` | | ||
|
|
||
| ### Storage Testing | ||
| The storage testing simply applies a PVC to the nginx pod | ||
| allowing for storage class testing. | ||
|
|
||
| ### PDB Testing | ||
| The PDB ensures a pod is always online to ensure no downtime during upgrades | ||
|
|
||
| ### Automated Testing: | ||
| Check out [E2E Tester](https://github.com/drew-viles/k8s-e2e-tester) | ||
| for an automated tester which will fire tests against this chart. | ||
|
|
||
| ## Add Helm Repository | ||
|
|
||
| ```shell | ||
| helm repo add drew-viles https://drew-viles.github.io/helm-charts | ||
| helm repo update | ||
| ``` | ||
|
|
||
| ## Install Chart | ||
|
|
||
| Using config from a file: | ||
|
|
||
| ```bash | ||
| helm upgrade --install {{ template "chart.name" . }} . --values ./values.yaml | ||
| ``` | ||
|
|
||
| ## Updating the Chart | ||
| Make sure you've run and resolved any issues using the following as failures of these will cause the pipeline/actions to fail. | ||
| ``` | ||
| ct lint charts/{{ template "chart.name" . }}/values.yaml --validate-maintainers=false --config .github/ct.yaml | ||
|
|
||
| helm-docs . | ||
| ``` | ||
|
|
||
| ## Configuration | ||
|
|
||
| The following table lists the configurable parameters of the chart and the default values. | ||
|
|
||
| {{ template "chart.valuesSection" . }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,13 +2,34 @@ | |
|
|
||
|    | ||
|
|
||
| A Helm chart for Kubernetes | ||
| The Jellyfin helm chart simply exists for deploying the Jellyfin media server onto Kubernetes. | ||
|
|
||
| ## Maintainers | ||
| ## Add Helm Repository | ||
|
|
||
| | Name | Email | Url | | ||
| | ---- | ------ | --- | | ||
| | Drew | <[email protected]> | | | ||
| ```shell | ||
| helm repo add drew-viles https://drew-viles.github.io/helm-charts | ||
| helm repo update | ||
| ``` | ||
|
|
||
| ## Install Chart | ||
|
|
||
| Using config from a file: | ||
|
|
||
| ```bash | ||
| helm upgrade --install jellyfin . --values ./values.yaml | ||
| ``` | ||
|
|
||
| ## Updating the Chart | ||
| Make sure you've run and resolved any issues using the following as failures of these will cause the pipeline/actions to fail. | ||
| ``` | ||
| ct lint charts/jellyfin/values.yaml --validate-maintainers=false --config .github/ct.yaml | ||
| helm-docs . | ||
| ``` | ||
|
|
||
| ## Configuration | ||
|
|
||
| The following table lists the configurable parameters of the chart and the default values. | ||
|
|
||
| ## Values | ||
|
|
||
|
|
@@ -50,6 +71,3 @@ A Helm chart for Kubernetes | |
| | serviceAccount.name | string | `""` | | | ||
| | storageClassName | string | `""` | | | ||
| | tolerations | list | `[]` | | | ||
|
|
||
| ---------------------------------------------- | ||
| Autogenerated from chart metadata using [helm-docs v1.11.3](https://github.com/norwoodj/helm-docs/releases/v1.11.3) | ||
Oops, something went wrong.