-
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 499b3f1
Showing
17 changed files
with
318 additions
and
96 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 |
|---|---|---|
| @@ -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
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,14 +1,32 @@ | ||
| # jellyfin | ||
|    A Helm chart for Kubernetes | ||
|
|
||
|    | ||
| ### Add Helm repository | ||
|
|
||
| A Helm chart for Kubernetes | ||
| ```shell | ||
| helm repo add drew-viles https://drew-viles.github.io/helm-charts | ||
| helm repo update | ||
| ``` | ||
|
|
||
| ## Maintainers | ||
| ## Install chart | ||
|
|
||
| | Name | Email | Url | | ||
| | ---- | ------ | --- | | ||
| | Drew | <[email protected]> | | | ||
| 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 +68,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) | ||
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,34 @@ | ||
| {{- template "chart.header" . }} | ||
| {{- template "chart.deprecationWarning" . }} | ||
| {{- template "chart.versionBadge" . }}{{- template "chart.typeBadge" . }}{{- template "chart.appVersionBadge" . }} | ||
| {{- template "chart.description" . }} | ||
| {{- template "chart.homepageLine" . }} | ||
|
|
||
| ### 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 |
|---|---|---|
| @@ -1,8 +1,5 @@ | ||
| # virt-operator | ||
|
|
||
|    | ||
|
|
||
| # Virt Operator for Kube Virt | ||
|    # Virt Operator for Kube Virt | ||
|
|
||
| KubeVirt technology addresses the needs of development teams that have adopted or want to adopt Kubernetes but | ||
| possess existing Virtual Machine-based workloads that cannot be easily containerized. More specifically, | ||
|
|
@@ -13,15 +10,32 @@ Benefits are broad and significant. Teams with a reliance on existing virtual ma | |
| to rapidly containerize applications. With virtualized workloads placed directly in development workflows, | ||
| teams can decompose them over time while still leveraging remaining virtualized components as is comfortably desired. | ||
|
|
||
| ## Maintainers | ||
| ### Add Helm repository | ||
|
|
||
| ```shell | ||
| helm repo add drew-viles https://drew-viles.github.io/helm-charts | ||
| helm repo update | ||
| ``` | ||
|
|
||
| ## Install chart | ||
|
|
||
| | Name | Email | Url | | ||
| | ---- | ------ | --- | | ||
| | Drew | <[email protected]> | | | ||
| Using config from a file: | ||
|
|
||
| ## Source Code | ||
| ```bash | ||
| helm upgrade --install virt-operator . --values ./values.yaml | ||
| ``` | ||
|
|
||
| * <https://drew-viles.github.io/helm-charts/virt-operator> | ||
| ## 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/virt-operator/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 | ||
|
|
||
|
|
@@ -36,9 +50,6 @@ teams can decompose them over time while still leveraging remaining virtualized | |
| | image.repository | string | `"quay.io/kubevirt/virt-operator"` | | | ||
| | image.tag | string | `""` | | | ||
| | kubevirt.useSoftwareEmulation | bool | `false` | | | ||
| | kubevirt.version | string | `"1.1.0"` | | | ||
| | kubevirt.version | string | `"1.2.0"` | | | ||
| | nameOverride | string | `""` | | | ||
| | replicaCount | int | `2` | | | ||
|
|
||
| ---------------------------------------------- | ||
| Autogenerated from chart metadata using [helm-docs v1.11.3](https://github.com/norwoodj/helm-docs/releases/v1.11.3) | ||
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,34 @@ | ||
| {{- template "chart.header" . }} | ||
| {{- template "chart.deprecationWarning" . }} | ||
| {{- template "chart.versionBadge" . }}{{- template "chart.typeBadge" . }}{{- template "chart.appVersionBadge" . }} | ||
| {{- template "chart.description" . }} | ||
| {{- template "chart.homepageLine" . }} | ||
|
|
||
| ### 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" . }} |
Oops, something went wrong.