automated commit

Signed-off-by: Public copy <41898282+github-actions[bot]@users.noreply.github.com>
chainguard-images · Oct 28, 2024 · 63d1e6d · 63d1e6d
1 parent 6d3eb4f
commit 63d1e6d
Show file tree

Hide file tree

Showing 17 changed files with 29 additions and 30 deletions.
diff --git a/images/busybox/README.md b/images/busybox/README.md
@@ -40,7 +40,7 @@ encourage all users to test and verify the new version.
 
 You can test today by migrating to the `cgr.dev/chainguard/busybox:latest-glibc` image. From July 15, the `:latest` and `:latest-glibc` will point to the same image.
 
-Full details are in [this blog post](https://www.chainguard.dev/unchained/changes-to-static-git-and-busybox-developer-images-2).
+Full details are in [this blog post](https://www.chainguard.dev/unchained/changes-to-static-git-and-busybox-developer-images).
 
 ## Usage
 

diff --git a/images/envoy-ratelimit/README.md b/images/envoy-ratelimit/README.md
@@ -38,7 +38,7 @@ Be sure to replace the `ORGANIZATION` placeholder with the name used for your or
 
 This image should be a drop-in replacement for the upstream `envoyproxy/ratelimit` image.
 
-The [`envoyproxy/ratelimit` GitHub repository](https://gateway.envoyproxy.io/latest/user/rate-limit.html) contains lots of useful information, as well as [several examples](https://github.com/envoyproxy/ratelimit#examples) showing how `ratelimit` works.
+The [`envoyproxy/ratelimit` GitHub repository](https://gateway.envoyproxy.io/docs/tasks/traffic/global-rate-limit/) contains lots of useful information, as well as [several examples](https://github.com/envoyproxy/ratelimit#examples) showing how `ratelimit` works.
 
 Additionally, the Envoy documentation has resources on [Global rate limiting](https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/other_features/global_rate_limiting) and [Local rate limiting](https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/other_features/local_rate_limiting).
 <!--body:end-->

diff --git a/images/git/README.md b/images/git/README.md
@@ -47,21 +47,21 @@ encourage all users to test and verify the new versions.
 The affected tags are:
 
  - `latest`
- - `latest-root` 
- - `latest-dev` 
+ - `latest-root`
+ - `latest-dev`
  - `latest-root-dev`
 
 You can test today by migrating to one of the following images:
 
  - `latest-glibc`
- - `latest-glibc-root` 
- - `latest-glibc-dev` 
+ - `latest-glibc-root`
+ - `latest-glibc-dev`
  - `latest-glibc-root-dev`
 
 From July 15 the `glibc` tag and the corresponding tag without `glibc` will point to the same
 images.
 
-Full details are in [this blog post](https://www.chainguard.dev/unchained/changes-to-static-git-and-busybox-developer-images-2).
+Full details are in [this blog post](https://www.chainguard.dev/unchained/changes-to-static-git-and-busybox-developer-images).
 
 ## Usage
 

diff --git a/images/gitlab-shell/README.md b/images/gitlab-shell/README.md
@@ -33,7 +33,7 @@ Be sure to replace the `ORGANIZATION` placeholder with the name used for your or
 
 <!--body:start-->
 ## Usage
-Please refer to the following helm chart documentation for instructions on how to deploy GitLab in Kubernetes: see [here]().
+Please refer to the following helm chart documentation for instructions on how to deploy GitLab in Kubernetes: see [here](https://docs.gitlab.com/charts/).
 
 The GitLab helm chart is composed of multiple sub-charts, one of which deploys the GitLab shell component.
 
@@ -105,4 +105,4 @@ That being said, it’s worth noting that `-dev` variants of Chainguard Images a
 
 ## Learn More
 
-To better understand how to work with Chainguard Images, we encourage you to visit [Chainguard Academy](https://edu.chainguard.dev/), our documentation and education platform.
+To better understand how to work with Chainguard Images, we encourage you to visit [Chainguard Academy](https://edu.chainguard.dev/), our documentation and education platform.
diff --git a/images/jdk/README.md b/images/jdk/README.md
@@ -115,9 +115,9 @@ For a full reference on using various images in a Jenkins pipeline, please refer
 
 A less common, but powerful, use case for the JDK image is creating an optimized custom JRE for your Java application. This involves using `jdeps` to produce the information about the Java modules being used and subsequently using `jlink` to analyze your application to eliminate all module code not being used by your application. This can create a drastically smaller JRE for a particular application.
 
-Keep in mind that a JRE produced this way is a fit-for-purpose JRE, and is not broadly usable. 
+Keep in mind that a JRE produced this way is a fit-for-purpose JRE, and is not broadly usable.
 
-Our [`jlink` Springboot Demo](https://github.com/chainguard-dev/jlink-springboot-demo) shows how you can use the Chainguard JDK image to produce a custom JRE. For reference, here are two additional articles describing the use of `jlink` to create optimized application images:
+For reference, here are two additional articles describing the use of `jlink` to create optimized application images:
 
 - [Creating your own runtime using jlink](https://adoptium.net/en-GB/blog/2021/10/jlink-to-produce-own-runtime/)
 - [Creating a Custom JRE for your Java Applications](https://adriankodja.com/creating-a-custom-jre-for-your-java-applications)

diff --git a/images/oauth2-proxy/README.md b/images/oauth2-proxy/README.md
@@ -54,11 +54,11 @@ docker run --detach --name oidc-test -p 8080:8080 cgr.dev/chainguard/oauth2-prox
 
 This `docker` command runs the `oauth2-proxy` Image while passing a number of configuration options to it. Most of these are sample values intended to get a working example proxy up and running. One particularly important option you should be aware of is the `--redirect-url`, which points to the OAuth application's callback URL. In order to set up an example locally, this example uses `http://localhost:8080` here.
 
-Note that you can alternatively define these options in a configuration file or through environment variables. You can check out the [OAuth2 Proxy Overview](https://oauth2-proxy.github.io/oauth2-proxy/docs/configuration/overview/) for more details on these options.
+Note that you can alternatively define these options in a configuration file or through environment variables. You can check out the [OAuth2 Proxy Overview](https://oauth2-proxy.github.io/oauth2-proxy/configuration/overview) for more details on these options.
 
 After running this command, navigate to [`http://localhost:8080`](http://localhost:8080) in your web browser. There, you'll be presented with the OAuth2 Proxy sign-in screen.
 
-Please refer to [the official documentation](https://oauth2-proxy.github.io/oauth2-proxy/docs/) for more information on how to work with OAuth2 Proxy.
+Please refer to [the official documentation](https://oauth2-proxy.github.io/oauth2-proxy/) for more information on how to work with OAuth2 Proxy.
 
 <!--body:end-->
 

diff --git a/images/opentofu/README.md b/images/opentofu/README.md
@@ -15,7 +15,7 @@
 <!--overview:start-->
 # Chainguard Image for opentofu
 
-[opentofu](https://github.com/opentofufoundation/opentofu) lets you declaratively manage your cloud infrastructure.
+[opentofu](https://github.com/opentofu/opentofu) lets you declaratively manage your cloud infrastructure.
 
 Chainguard Images are regularly-updated, minimal container images with low-to-zero CVEs.
 <!--overview:end-->

diff --git a/images/opentofu/metadata.yaml b/images/opentofu/metadata.yaml
@@ -3,10 +3,10 @@ image: cgr.dev/chainguard/opentofu
 logo: https://storage.googleapis.com/chainguard-academy/logos/opentofu.svg
 endoflife: ""
 console_summary: ""
-short_description: '[opentofu](https://github.com/opentofufoundation/opentofu) lets you declaratively manage your cloud infrastructure.'
+short_description: '[opentofu](https://github.com/opentofu/opentofu) lets you declaratively manage your cloud infrastructure.'
 compatibility_notes: ""
 readme_file: README.md
-upstream_url: https://github.com/opentofufoundation/opentofu
+upstream_url: https://github.com/opentofu/opentofu
 keywords:
   - application
 tier: APPLICATION
diff --git a/images/php/README.md b/images/php/README.md
@@ -34,7 +34,7 @@ Be sure to replace the `ORGANIZATION` placeholder with the name used for your or
 <!--body:start-->
 ## Image Variants
 
-Our `latest` tags use the most recent build of the [Wolfi PHP](https://github.com/wolfi-dev/os/blob/main/php.yaml) package. All variants have `-dev` versions that include Composer and other utilities that are suitable for developing and building PHP applications. Check the [Tags](https://edu.chainguard.dev/chainguard/chainguard-images/reference/php/tags_history/) page for more details on available tags, and the [Details]() page for information about included packages per variant.
+Check the [Tags](https://edu.chainguard.dev/chainguard/chainguard-images/reference/php/tags_history/) page for more details on available tags, and the [SBOM](https://images.chainguard.dev/directory/image/php/sbom) page for information about included packages per variant.
 
 - `latest`: This is a distroless image for running command-line PHP applications.
 - `latest-fpm`: This is the distroless `php-fpm` image variant, designed to be used together with our [Nginx](https://edu.chainguard.dev/chainguard/chainguard-images/reference/nginx) image.
@@ -144,7 +144,7 @@ http {
 }
 ```
 
-For more detailed information on how to use these images, check the [Getting Started with the PHP Chainguard Images](https://edu.chainguard.dev/chainguard/chainguard-images/reference/php/getting-started-php/) guide.
+For more detailed information on how to use these images, check the [Getting Started with the PHP Chainguard Images](https://edu.chainguard.dev/chainguard/chainguard-images/getting-started/php/) guide.
 
 ## Detailed Environment Information
 

diff --git a/images/promtail/README.md b/images/promtail/README.md
@@ -45,7 +45,7 @@ level=warn ts=2023-09-02T14:01:20.497754387Z caller=promtail.go:265 msg="enable
 ```
 
 This image is a drop-in replacement for official image at grafana/promtail.
-See documentation [there](https://github.com/grafana/loki/blob/main/cmd/promtail/Dockerfile#L9) for how to configure it.
+See documentation [there](https://github.com/grafana/loki/blob/main/clients/cmd/promtail/Dockerfile) for how to configure it.
 <!--body:end-->
 
 ## Contact Support

diff --git a/images/redis/README.md b/images/redis/README.md
@@ -48,6 +48,9 @@ Please give careful consideration to these licensing conditions when using Redis
 
 ## Getting Started
 
+## Redis Version
+This will automatically pull the image to your local system and execute the command `redis --version`:
+
 To run the Chainguard Redis image with Docker using default configuration you could run the following command:
 
 ```sh

diff --git a/images/rust/README.md b/images/rust/README.md
@@ -36,10 +36,6 @@ Be sure to replace the `ORGANIZATION` placeholder with the name used for your or
 - [Documentation](https://edu.chainguard.dev/chainguard/chainguard-images/reference/rust)
 - [Provenance Information](https://edu.chainguard.dev/chainguard/chainguard-images/reference/rust/provenance_info/)
 
-## Image Variants
-
-Our `latest` tag uses the most recent build of the [Wolfi Rust](https://github.com/wolfi-dev/os/blob/main/rust.yaml) package.
-
 This image contains the tools needed to build Rust code.
 This includes:
 
@@ -157,4 +153,4 @@ That being said, it’s worth noting that `-dev` variants of Chainguard Images a
 
 ## Learn More
 
-To better understand how to work with Chainguard Images, we encourage you to visit [Chainguard Academy](https://edu.chainguard.dev/), our documentation and education platform.
+To better understand how to work with Chainguard Images, we encourage you to visit [Chainguard Academy](https://edu.chainguard.dev/), our documentation and education platform.
diff --git a/images/sigstore-scaffolding/README.md b/images/sigstore-scaffolding/README.md
@@ -54,7 +54,7 @@ The stack also pulls in several support images:
 - (NYI) `mysql` - Currently sigstore relies on the nearly EOL `mysql` 5.7
 
 To see an example of how we substitute images into the `scaffold` Helm chart's
-`values.yaml` see our [`values.tf`](https://github.com/chainguard-images/images/blob/main/images/sigstore-scaffolding/tests/values.tf) example.
+`values.yaml` see our [`main.tf`](https://github.com/chainguard-images/images/blob/main/images/sigstore-scaffolding/tests/main.tf) example.
 <!--body:end-->
 
 ## Contact Support

diff --git a/images/static/README.md b/images/static/README.md
@@ -40,7 +40,7 @@ encourage all users to test and verify the new version.
 
 You can test today by migrating to the `cgr.dev/chainguard/static:latest-glibc` image. From July 15, the `:latest` and `:latest-glibc` will point to the same image.
 
-Full details are in [this blog post](https://www.chainguard.dev/unchained/changes-to-static-git-and-busybox-developer-images-2).
+Full details are in [this blog post](https://www.chainguard.dev/unchained/changes-to-static-git-and-busybox-developer-images).
 
 ## Usage
 
@@ -148,7 +148,7 @@ docker run c-cgr
 Hello C users!
 ```
 
-Inspect this newly-built image as well. 
+Inspect this newly-built image as well.
 
 ```shell
 docker images c-cgr

diff --git a/images/step-issuer/README.md b/images/step-issuer/README.md
@@ -15,7 +15,7 @@
 <!--overview:start-->
 # Chainguard Image for step-issuer
 
-[step-issuer](https://smallstep.com/docs/step-issuer) is a certificate issuer for cert-manager using step certificates CA
+[step-issuer](https://smallstep.com/docs/platform/) is a certificate issuer for cert-manager using step certificates CA
 
 Chainguard Images are regularly-updated, minimal container images with low-to-zero CVEs.
 <!--overview:end-->

diff --git a/images/step-issuer/metadata.yaml b/images/step-issuer/metadata.yaml
@@ -3,7 +3,7 @@ image: cgr.dev/chainguard/step-issuer
 logo: https://storage.googleapis.com/chainguard-academy/logos/step-issuer.svg
 endoflife: ""
 console_summary: ""
-short_description: "[step-issuer](https://smallstep.com/docs/step-issuer) is a certificate issuer for cert-manager using step certificates CA"
+short_description: "[step-issuer](https://smallstep.com/docs/platform/) is a certificate issuer for cert-manager using step certificates CA"
 compatibility_notes: ""
 readme_file: README.md
 upstream_url: https://github.com/wolfi-dev/os

diff --git a/images/vault/README.md b/images/vault/README.md
@@ -78,7 +78,7 @@ $ docker run --cap-add=IPC_LOCK -e 'VAULT_LOCAL_CONFIG={"storage": {"file": {"pa
 
 ### Helm Chart Usage
 
-This image and the [vault-k8s image](https://github.com/chainguard-images/images/tree/main/images/vault-k8s) can be used with the [Hashicorp Helm chart](https://github.com/hashicorp/vault-helm). To replace the official
+This image and the `vault-k8s` image can be used with the [Helm chart](https://github.com/hashicorp/vault-helm). To replace the official
 images with the Chainguard images, provide the chart with the following values:
 
 ```