-
Notifications
You must be signed in to change notification settings - Fork 72
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1027 from chainguard-dev/create-pull-request/patch
[AutoDocs] Update Images Reference Docs
- Loading branch information
Showing
8 changed files
with
286 additions
and
7 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
45 changes: 45 additions & 0 deletions
45
content/chainguard/chainguard-images/reference/ingress-nginx-controller/_index.md
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,45 @@ | ||
| --- | ||
| title: "Image Overview: ingress-nginx-controller" | ||
| linktitle: "ingress-nginx-controller" | ||
| type: "article" | ||
| layout: "single" | ||
| description: "Overview: ingress-nginx-controller Chainguard Image" | ||
| date: 2022-11-01T11:07:52+02:00 | ||
| lastmod: 2022-11-01T11:07:52+02:00 | ||
| draft: false | ||
| tags: ["Reference", "Chainguard Images", "Product"] | ||
| images: [] | ||
| menu: | ||
| docs: | ||
| parent: "images-reference" | ||
| weight: 500 | ||
| toc: true | ||
| --- | ||
|
|
||
| {{< tabs >}} | ||
| {{< tab title="Overview" active=true url="/chainguard/chainguard-images/reference/ingress-nginx-controller/" >}} | ||
| {{< tab title="Variants" active=false url="/chainguard/chainguard-images/reference/ingress-nginx-controller/image_specs/" >}} | ||
| {{< tab title="Tags History" active=false url="/chainguard/chainguard-images/reference/ingress-nginx-controller/tags_history/" >}} | ||
| {{< tab title="Provenance" active=false url="/chainguard/chainguard-images/reference/ingress-nginx-controller/provenance_info/" >}} | ||
| {{</ tabs >}} | ||
|
|
||
|
|
||
|
|
||
| ## Get It | ||
|
|
||
| The image is available on `cgr.dev`: | ||
|
|
||
| ``` | ||
| docker pull cgr.dev/chainguard/ingress-nginx-controller | ||
| ``` | ||
|
|
||
| ## Using `ingress-nginx-controller` | ||
|
|
||
| The Chainguard image is a drop in replacement for the upstream image. For example, to install with the upstream helm chart: | ||
|
|
||
| ```bash | ||
| helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx | ||
|
|
||
| helm install foo ingress-nginx/ingress-nginx --set image.repository=cgr.dev/chainguard/ingress-nginx-controller | ||
| ``` | ||
|
|
132 changes: 132 additions & 0 deletions
132
.../chainguard/chainguard-images/reference/ingress-nginx-controller/image_specs.md
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,132 @@ | ||
| --- | ||
| title: "ingress-nginx-controller Image Variants" | ||
| type: "article" | ||
| unlisted: true | ||
| description: "Detailed information about the public ingress-nginx-controller Chainguard Image variants" | ||
| date: 2023-03-07T11:07:52+02:00 | ||
| lastmod: 2023-03-07T11:07:52+02:00 | ||
| draft: false | ||
| tags: ["Reference", "Chainguard Images", "Product"] | ||
| images: [] | ||
| weight: 550 | ||
| toc: true | ||
| --- | ||
|
|
||
| {{< tabs >}} | ||
| {{< tab title="Overview" active=false url="/chainguard/chainguard-images/reference/ingress-nginx-controller/" >}} | ||
| {{< tab title="Variants" active=true url="/chainguard/chainguard-images/reference/ingress-nginx-controller/image_specs/" >}} | ||
| {{< tab title="Tags History" active=false url="/chainguard/chainguard-images/reference/ingress-nginx-controller/tags_history/" >}} | ||
| {{< tab title="Provenance" active=false url="/chainguard/chainguard-images/reference/ingress-nginx-controller/provenance_info/" >}} | ||
| {{</ tabs >}} | ||
|
|
||
| This page shows detailed information about all public variants of the Chainguard **ingress-nginx-controller** Image. | ||
|
|
||
| ## Variants Compared | ||
| The **ingress-nginx-controller** Chainguard Image currently has 2 public variants: | ||
|
|
||
| - `latest-dev` | ||
| - `latest` | ||
|
|
||
| The table has detailed information about each of these variants. | ||
|
|
||
| | | latest-dev | latest | | ||
| |--------------|--------------------------|--------------------------| | ||
| | Default User | `root` | `root` | | ||
| | Entrypoint | not specified | not specified | | ||
| | CMD | `/usr/bin/dumb-init ---` | `/usr/bin/dumb-init ---` | | ||
| | Workdir | `/etc/nginx` | `/etc/nginx` | | ||
| | Has apk? | yes | no | | ||
| | Has a shell? | yes | no | | ||
|
|
||
| Check the [tags history page](/chainguard/chainguard-images/reference/ingress-nginx-controller/tags_history/) for the full list of available tags. | ||
|
|
||
| ## Packages Included | ||
| The table shows package distribution across variants. | ||
|
|
||
| | | latest-dev | latest | | ||
| |-----------------------------------|------------|--------| | ||
| | `aom-libs` | X | X | | ||
| | `apk-tools` | X | | | ||
| | `bash` | X | | | ||
| | `brotli` | X | X | | ||
| | `busybox` | X | | | ||
| | `ca-certificates` | X | X | | ||
| | `ca-certificates-bundle` | X | X | | ||
| | `curl` | X | X | | ||
| | `fontconfig-config` | X | X | | ||
| | `freetype` | X | X | | ||
| | `gd` | X | X | | ||
| | `geoip` | X | X | | ||
| | `git` | X | | | ||
| | `glibc` | X | X | | ||
| | `glibc-locale-posix` | X | X | | ||
| | `ingress-nginx-controller` | X | X | | ||
| | `ingress-nginx-controller-compat` | X | X | | ||
| | `ld-linux` | X | X | | ||
| | `libavif` | X | X | | ||
| | `libbrotlicommon1` | X | X | | ||
| | `libbrotlidec1` | X | X | | ||
| | `libbrotlienc1` | X | X | | ||
| | `libbz2-1` | X | X | | ||
| | `libcrypt1` | X | X | | ||
| | `libcrypto3` | X | X | | ||
| | `libcurl-openssl4` | X | X | | ||
| | `libdav1d` | X | X | | ||
| | `libedit` | X | X | | ||
| | `libexpat1` | X | X | | ||
| | `libfontconfig1` | X | X | | ||
| | `libgcc` | X | X | | ||
| | `libgcrypt` | X | X | | ||
| | `libgd` | X | X | | ||
| | `libgpg-error` | X | X | | ||
| | `libjpeg-turbo` | X | X | | ||
| | `libmaxminddb` | X | X | | ||
| | `libmaxminddb-libs` | X | X | | ||
| | `libnghttp2-14` | X | X | | ||
| | `libpcre2-8-0` | X | | | ||
| | `libpng` | X | X | | ||
| | `libssl3` | X | X | | ||
| | `libstdc++` | X | X | | ||
| | `libwebp` | X | X | | ||
| | `libx11` | X | X | | ||
| | `libxau` | X | X | | ||
| | `libxcb` | X | X | | ||
| | `libxdmcp` | X | X | | ||
| | `libxml2` | X | X | | ||
| | `libxpm` | X | X | | ||
| | `libxslt` | X | X | | ||
| | `libzstd1` | X | X | | ||
| | `lua-cjson` | X | X | | ||
| | `lua-resty-balancer` | X | X | | ||
| | `lua-resty-cache` | X | X | | ||
| | `lua-resty-cookie` | X | X | | ||
| | `lua-resty-core` | X | X | | ||
| | `lua-resty-dns` | X | X | | ||
| | `lua-resty-global-throttle` | X | X | | ||
| | `lua-resty-http` | X | X | | ||
| | `lua-resty-ipmatcher` | X | X | | ||
| | `lua-resty-lock` | X | X | | ||
| | `lua-resty-memcached` | X | X | | ||
| | `lua-resty-redis` | X | X | | ||
| | `lua-resty-string` | X | X | | ||
| | `lua-resty-upload` | X | X | | ||
| | `luajit` | X | X | | ||
| | `mimalloc` | X | X | | ||
| | `modsecurity` | X | X | | ||
| | `modsecurity-config` | X | X | | ||
| | `msgpack` | X | X | | ||
| | `ncurses` | X | X | | ||
| | `ncurses-terminfo-base` | X | X | | ||
| | `openssh-client` | X | X | | ||
| | `openssl` | X | X | | ||
| | `openssl-config` | X | X | | ||
| | `openssl-dev` | X | X | | ||
| | `openssl-provider-legacy` | X | X | | ||
| | `pcre` | X | X | | ||
| | `ssdeep` | X | X | | ||
| | `tiff` | X | X | | ||
| | `wolfi-baselayout` | X | X | | ||
| | `xz` | X | X | | ||
| | `yaml-cpp` | X | X | | ||
| | `zlib` | X | X | | ||
|
|
72 changes: 72 additions & 0 deletions
72
...inguard/chainguard-images/reference/ingress-nginx-controller/provenance_info.md
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,72 @@ | ||
| --- | ||
| title: "Provenance Information for ingress-nginx-controller Images" | ||
| type: "article" | ||
| unlisted: true | ||
| description: "Provenance information for ingress-nginx-controller Chainguard Image" | ||
| date: 2022-11-01T11:07:52+02:00 | ||
| lastmod: 2022-11-01T11:07:52+02:00 | ||
| draft: false | ||
| tags: ["Reference", "Chainguard Images", "Product"] | ||
| images: [] | ||
| weight: 600 | ||
| toc: true | ||
| --- | ||
|
|
||
| {{< tabs >}} | ||
| {{< tab title="Overview" active=false url="/chainguard/chainguard-images/reference/ingress-nginx-controller/" >}} | ||
| {{< tab title="Variants" active=false url="/chainguard/chainguard-images/reference/ingress-nginx-controller/image_specs/" >}} | ||
| {{< tab title="Tags History" active=false url="/chainguard/chainguard-images/reference/ingress-nginx-controller/tags_history/" >}} | ||
| {{< tab title="Provenance" active=true url="/chainguard/chainguard-images/reference/ingress-nginx-controller/provenance_info/" >}} | ||
| {{</ tabs >}} | ||
|
|
||
| All Chainguard Images contain verifiable signatures and high-quality SBOMs (software bill of materials), features that enable users to confirm the origin of each image built and have a detailed list of everything that is packed within. | ||
|
|
||
| ## Verifying Image Signatures | ||
| The **ingress-nginx-controller** Chainguard Images are signed using Sigstore, and you can check the included signatures using `cosign`. | ||
|
|
||
| The following command requires [cosign](https://docs.sigstore.dev/cosign/overview/) and [jq](https://stedolan.github.io/jq/) to be installed on your machine. It will pull detailed information about all signatures found for the provided image. | ||
|
|
||
| ```shell | ||
| cosign verify --certificate-oidc-issuer=https://token.actions.githubusercontent.com --certificate-identity=https://github.com/chainguard-images/images/.github/workflows/release.yaml@refs/heads/main cgr.dev/chainguard/ingress-nginx-controller | jq | ||
| ``` | ||
|
|
||
| By default, this command will fetch signatures for the `latest` tag. You can also specify the tag you want to fetch signatures for. | ||
|
|
||
| ## Downloading and Verifying SBOMs | ||
|
|
||
| All Chainguard Images come with a high-quality Software Bill Of Materials (SBOM) attested at build-time. The SBOM can be downloaded using the cosign tool: | ||
|
|
||
| ```shell | ||
| cosign download attestation \ | ||
| --predicate-type=https://spdx.dev/Document \ | ||
| cgr.dev/chainguard/ingress-nginx-controller | jq -r .payload | base64 -d | jq | ||
| ``` | ||
| By default, this command will fetch the SBOM assigned to the `latest` tag. You can also specify the tag you want to fetch the SBOM from. | ||
|
|
||
| With cosign 2.0+, you can use the `cosign verify-attestation` command to check the signature of an SBOM: | ||
|
|
||
| ```shell | ||
| cosign verify-attestation \ | ||
| --type https://spdx.dev/Document \ | ||
| --certificate-oidc-issuer=https://token.actions.githubusercontent.com \ | ||
| --certificate-identity=https://github.com/chainguard-images/images/.github/workflows/release.yaml@refs/heads/main \ | ||
| cgr.dev/chainguard/ingress-nginx-controller | ||
| ``` | ||
|
|
||
| And you should get output that verifies the SBOM signature in cosign's transparency log: | ||
|
|
||
| ``` | ||
| Verification for cgr.dev/chainguard/ingress-nginx-controller -- | ||
| The following checks were performed on each of these signatures: | ||
| - The cosign claims were validated | ||
| - Existence of the claims in the transparency log was verified offline | ||
| - The code-signing certificate was verified using trusted certificate authority certificates | ||
| Certificate subject: https://github.com/chainguard-images/images/.github/workflows/release.yaml@refs/heads/main | ||
| Certificate issuer URL: https://token.actions.githubusercontent.com | ||
| GitHub Workflow Trigger: schedule | ||
| GitHub Workflow SHA: da283c26829d46c2d2883de5ff98bee672428696 | ||
| GitHub Workflow Name: .github/workflows/release.yaml | ||
| GitHub Workflow Trigger chainguard-images/images | ||
| GitHub Workflow Ref: refs/heads/main | ||
| ... | ||
| ``` |
30 changes: 30 additions & 0 deletions
30
...chainguard/chainguard-images/reference/ingress-nginx-controller/tags_history.md
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,30 @@ | ||
| --- | ||
| title: "ingress-nginx-controller Image Tags History" | ||
| type: "article" | ||
| unlisted: true | ||
| description: "Image Tags and History for the ingress-nginx-controller Chainguard Image" | ||
| date: 2023-06-22T11:07:52+02:00 | ||
| lastmod: 2023-06-22T11:07:52+02:00 | ||
| draft: false | ||
| tags: ["Reference", "Chainguard Images", "Product"] | ||
| images: [] | ||
| weight: 700 | ||
| toc: true | ||
| --- | ||
|
|
||
| {{< tabs >}} | ||
| {{< tab title="Overview" active=false url="/chainguard/chainguard-images/reference/ingress-nginx-controller/" >}} | ||
| {{< tab title="Variants" active=false url="/chainguard/chainguard-images/reference/ingress-nginx-controller/image_specs/" >}} | ||
| {{< tab title="Tags History" active=true url="/chainguard/chainguard-images/reference/ingress-nginx-controller/tags_history/" >}} | ||
| {{< tab title="Provenance" active=false url="/chainguard/chainguard-images/reference/ingress-nginx-controller/provenance_info/" >}} | ||
| {{</ tabs >}} | ||
|
|
||
| The following table contains the most recent tags and digests that can be used to pin your Dockerfile to a specific build of this image. Check our guide on [Using the Tag History API](/chainguard/chainguard-images/using-the-tag-history-api/) for information on how to fetch all tags from an image and how to pin your Dockerfile to a specific digest. | ||
|
|
||
| Please note that digests and timestamps only change when there is a change to the image, even though images are rebuilt every night. The "Last Changed" column indicates when the image was last modified, and doesn't always reflect the latest build timestamp. For more information about how our reproducible builds work, please refer to [this blog post](https://www.chainguard.dev/unchained/reproducing-chainguards-reproducible-image-builds). | ||
|
|
||
| | Tag (s) | Last Changed | Digest | | ||
| |---------------|----------------|---------------------------------------------------------------------------| | ||
| | `latest-dev` | September 27th | `sha256:01a111cadb5a0b738bc69581c0f9d4e09853e8ff4cf6b1d94f962624354c64ae` | | ||
| | `latest` | September 27th | `sha256:dc3b9363aa621a7691dc686542ee07166180db0ba79badd5a6e2a03652fc39dc` | | ||
|
|
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