-
Notifications
You must be signed in to change notification settings - Fork 92
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into tsa-secret-optional-for-tuf
Signed-off-by: Carlos Vega <[email protected]>
- Loading branch information
Showing
54 changed files
with
730 additions
and
310 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 |
|---|---|---|
| @@ -1,6 +1,12 @@ | ||
| --- | ||
| version: 2 | ||
| updates: | ||
| - package-ecosystem: "github-actions" | ||
| directory: "/" | ||
| schedule: | ||
| interval: "weekly" | ||
| groups: | ||
| actions: | ||
| update-types: | ||
| - "minor" | ||
| - "patch" |
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,29 @@ | ||
| name: Check Helm Docs | ||
|
|
||
| on: | ||
| pull_request: | ||
| paths: | ||
| - "charts/**" | ||
|
|
||
| jobs: | ||
| readme: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | ||
|
|
||
| - name: Run Helm Docs and check the outcome | ||
| run: | | ||
| make docs | ||
| exit_code=$(git diff --exit-code) | ||
| exit ${exit_code} | ||
| - name: Print a comment in case of failure | ||
| run: | | ||
| echo "The README.md files are not up to date. | ||
| Please, run \"make docs\" before pushing." | ||
| exit 1 | ||
| if: | | ||
| failure() && github.event.pull_request.head.repo.full_name == github.repository |
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
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,40 @@ | ||
| DOCS_IMAGE_VERSION="v1.14.2" | ||
|
|
||
| CHART_TESTING_IMAGE_VERSION="v3.10.1" | ||
|
|
||
| # Charts's path relative to the current directory. | ||
| CHARTS := $(wildcard ./charts/*) | ||
|
|
||
| CHARTS_NAMES := $(notdir $(CHARTS)) | ||
|
|
||
| .PHONY: lint | ||
| lint: helm-deps-update $(addprefix lint-, $(CHARTS_NAMES)) | ||
|
|
||
| lint-%: | ||
| @docker run \ | ||
| -it \ | ||
| -e HOME=/home/ct \ | ||
| --mount type=tmpfs,destination=/home/ct \ | ||
| --workdir=/data \ | ||
| --volume $$(pwd):/data \ | ||
| -u $$(id -u) \ | ||
| quay.io/helmpack/chart-testing:$(CHART_TESTING_IMAGE_VERSION) \ | ||
| ct lint --config ./ct.yaml --charts ./charts/$* | ||
|
|
||
| .PHONY: docs | ||
| docs: $(addprefix docs-, $(CHARTS_NAMES)) | ||
|
|
||
| docs-%: | ||
| @docker run \ | ||
| --rm \ | ||
| --workdir=/helm-docs \ | ||
| --volume "$$(pwd):/helm-docs" \ | ||
| -u $$(id -u) \ | ||
| jnorwood/helm-docs:$(DOCS_IMAGE_VERSION) \ | ||
| helm-docs -c ./charts/$* -t ./README.md.gotmpl -o ./README.md | ||
|
|
||
| .PHONY: helm-deps-update | ||
| helm-deps-update: $(addprefix helm-deps-update-, $(CHARTS_NAMES)) | ||
|
|
||
| helm-deps-update-%: | ||
| helm dependency update ./charts/$* |
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,88 +1,34 @@ | ||
| # common | ||
|
|
||
|   | ||
| <!-- This README.md is generated. Please edit README.md.gotmpl --> | ||
|
|
||
|   | ||
|
|
||
| A Library Helm Chart containing common logic for use by Sigstore charts | ||
|
|
||
| **Homepage:** <https://sigstore.dev/> | ||
| ' | ||
| ## Quick Installation | ||
|
|
||
| ## Maintainers | ||
|
|
||
| | Name | Email | Url | | ||
| | ---- | ------ | --- | | ||
| | The Sigstore Authors | | | | ||
|
|
||
| ---------------------------------------------- | ||
|
|
||
|
|
||
| ## Named Templates | ||
|
|
||
| ### Images | ||
|
|
||
| | Name | Description | Expected Input | | ||
| |-----------------------|----------------------------------------------------------------------------------|------------------------------------| | ||
| | `common.images.image` | Create a fully qualified image reference. see [Image](#image) for the structure. | `.Values.image` Reference to Image | | ||
|
|
||
| ### Labels | ||
|
|
||
| | Name | Description | Expected Input | | ||
| |--------------------------------|---------------------------------------------|-----------------------| | ||
| | `common.labels.labels` | Returns standard Kubernetes labels | `.` Chart context | | ||
| | `common.labels.selectorLabels` | Returns specific labels used for selectors | `.` Chart context | | ||
| | `common.labels.labelsNameSuffix` | Returns the provided set of labels give the label key `app.kubernetes.io/name` appended with a provided suffix | `dict "labels" "labels-content "suffix" "suffix-value"` | | ||
| To install the helm chart with default values run following command. | ||
| The [Values](#Values) section describes the configuration options for this chart. | ||
|
|
||
| ### Names | ||
|
|
||
| | Name | Description | Expected Input | | ||
| |-----------------------------------|---------------------------------------------------------------------------------------------------|------------------------------------------------------| | ||
| | `common.names.name` | Returns the name of the chart | `.` Chart context | | ||
| | `common.names.chart` | Returns the name of the chart used by the chart label | `.` Chart context | | ||
| | `common.names.fullname` | Returns the fully qualified application name | `.` Chart context | | ||
| | `common.names.managedfullname` | Returns the fully qualified application name by providing a context to use | `dict "content" .Values.content "context" $` | | ||
| | `common.names.fullnameSuffix` | Returns the fully qualified application name appended by a provided suffix | `dict "suffix" "suffix-value "context" $` | | ||
| | `common.names.rawnamespace` | Returns the raw namespace if set with forceNamespace or .Release.Namespace is set | `.` Chart context | | ||
| | `common.names.serviceAccountName` | Returns the name of the Service account. See [ServiceAccount](#serviceaccount) for the structure. | `.Values.serviceAccount` Reference to ServiceAccount | | ||
|
|
||
| ### Network | ||
|
|
||
| | Name | Description | Expected Input | | ||
| |--------------------------------|---------------------------------------------|-----------------------| | ||
| | `common.network.containerPorts` | Returns the `containerPorts` property of a PodSpec | `dict` containing `port`, `targetPort` and optional `protocol` | | ||
|
|
||
|
|
||
| ## Input Schemas | ||
|
|
||
| The following are a set of schemas that are expected within applicable Named Templates | ||
|
|
||
| ### Image | ||
| ```shell | ||
| helm dependency update . | ||
| helm install [RELEASE_NAME] . | ||
| ``` | ||
|
|
||
| ```yaml | ||
| registry: | ||
| type: string | ||
| description: Registry where the image is located | ||
| example: gcr.io | ||
| ## Uninstallation | ||
|
|
||
| repository: | ||
| type: string | ||
| description: Repository and image name | ||
| example: sigstore/scaffolding/ct_server | ||
| To uninstall the Helm chart run following command. | ||
|
|
||
| version: | ||
| type: string | ||
| description: image tag or digest | ||
| example: 1.0.0 | ||
| ```shell | ||
| helm uninstall [RELEASE_NAME] | ||
| ``` | ||
|
|
||
| ### ServiceAccount | ||
| ## Maintainers | ||
|
|
||
| ```yaml | ||
| name: | ||
| type: string | ||
| description: Name of the ServiceAccount | ||
| example: myApp | ||
| | Name | Email | Url | | ||
| | ---- | ------ | --- | | ||
| | The Sigstore Authors | | | | ||
|
|
||
| create: | ||
| type: boolean | ||
| description: Create a dedicated ServiceAccount | ||
| example: 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,37 @@ | ||
| {{ template "chart.header" . }} | ||
|
|
||
| <!-- This README.md is generated. Please edit README.md.gotmpl --> | ||
|
|
||
| {{ template "chart.deprecationWarning" . }} | ||
|
|
||
| {{ template "chart.badgesSection" . }} | ||
|
|
||
| {{ template "chart.description" . }} | ||
|
|
||
| {{ template "chart.homepageLine" . }} | ||
| ' | ||
| ## Quick Installation | ||
|
|
||
| To install the helm chart with default values run following command. | ||
| The [Values](#Values) section describes the configuration options for this chart. | ||
|
|
||
| ```shell | ||
| helm dependency update . | ||
| helm install [RELEASE_NAME] . | ||
| ``` | ||
|
|
||
| ## Uninstallation | ||
|
|
||
| To uninstall the Helm chart run following command. | ||
|
|
||
| ```shell | ||
| helm uninstall [RELEASE_NAME] | ||
| ``` | ||
|
|
||
| {{ template "chart.maintainersSection" . }} | ||
|
|
||
| {{ template "chart.sourcesSection" . }} | ||
|
|
||
| {{ template "chart.requirementsSection" . }} | ||
|
|
||
| {{ 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
Oops, something went wrong.