Merge pull request #315 from rawlingsj/docathon

make Jenkins, Maven, JDK and JRE consistent with new template style
chainguard-images · Mar 8, 2023 · 0484852 · 0484852
2 parents 34a5bb5 + 6959f8a
commit 0484852
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@
 | [haproxy](./images/haproxy) | `cgr.dev/chainguard/haproxy` | experimental | [![](https://storage.googleapis.com/chainguard-images-build-outputs/badges/haproxy.build.status.latest.svg)](https://registry-ui.chainguard.app/?image=cgr.dev/chainguard/haproxy:latest) |
 | [helm](./images/helm) | `cgr.dev/chainguard/helm` | stable | [![](https://storage.googleapis.com/chainguard-images-build-outputs/badges/helm.build.status.latest.svg)](https://registry-ui.chainguard.app/?image=cgr.dev/chainguard/helm:latest) |
 | [jdk](./images/jdk) | `cgr.dev/chainguard/jdk` | stable | [![](https://storage.googleapis.com/chainguard-images-build-outputs/badges/jdk.build.status.latest-dev.svg)](https://registry-ui.chainguard.app/?image=cgr.dev/chainguard/jdk:latest-dev)<br/>[![](https://storage.googleapis.com/chainguard-images-build-outputs/badges/jdk.build.status.latest.svg)](https://registry-ui.chainguard.app/?image=cgr.dev/chainguard/jdk:latest)<br/>[![](https://storage.googleapis.com/chainguard-images-build-outputs/badges/jdk.build.status.openjdk-11-dev.svg)](https://registry-ui.chainguard.app/?image=cgr.dev/chainguard/jdk:openjdk-11-dev)<br/>[![](https://storage.googleapis.com/chainguard-images-build-outputs/badges/jdk.build.status.openjdk-11.svg)](https://registry-ui.chainguard.app/?image=cgr.dev/chainguard/jdk:openjdk-11) |
-| [jenkins](./images/jenkins) | `cgr.dev/chainguard/jenkins` | experimental | [![](https://storage.googleapis.com/chainguard-images-build-outputs/badges/jenkins.build.status.latest.svg)](https://registry-ui.chainguard.app/?image=cgr.dev/chainguard/jenkins:latest) |
+| [jenkins](./images/jenkins) | `cgr.dev/chainguard/jenkins` | stable | [![](https://storage.googleapis.com/chainguard-images-build-outputs/badges/jenkins.build.status.latest.svg)](https://registry-ui.chainguard.app/?image=cgr.dev/chainguard/jenkins:latest) |
 | [jre](./images/jre) | `cgr.dev/chainguard/jre` | stable | [![](https://storage.googleapis.com/chainguard-images-build-outputs/badges/jre.build.status.latest-dev.svg)](https://registry-ui.chainguard.app/?image=cgr.dev/chainguard/jre:latest-dev)<br/>[![](https://storage.googleapis.com/chainguard-images-build-outputs/badges/jre.build.status.latest.svg)](https://registry-ui.chainguard.app/?image=cgr.dev/chainguard/jre:latest)<br/>[![](https://storage.googleapis.com/chainguard-images-build-outputs/badges/jre.build.status.openjdk-11-dev.svg)](https://registry-ui.chainguard.app/?image=cgr.dev/chainguard/jre:openjdk-11-dev)<br/>[![](https://storage.googleapis.com/chainguard-images-build-outputs/badges/jre.build.status.openjdk-11.svg)](https://registry-ui.chainguard.app/?image=cgr.dev/chainguard/jre:openjdk-11) |
 | [ko](./images/ko) | `cgr.dev/chainguard/ko` | stable | [![](https://storage.googleapis.com/chainguard-images-build-outputs/badges/ko.build.status.latest.svg)](https://registry-ui.chainguard.app/?image=cgr.dev/chainguard/ko:latest) |
 | [kubectl](./images/kubectl) | `cgr.dev/chainguard/kubectl` | stable | [![](https://storage.googleapis.com/chainguard-images-build-outputs/badges/kubectl.build.status.latest.svg)](https://registry-ui.chainguard.app/?image=cgr.dev/chainguard/kubectl:latest) |

diff --git a/images/jdk/README.md b/images/jdk/README.md
@@ -11,7 +11,11 @@
 ---
 <!--monopod:end-->
 
-Java JDK image using OpenJDK via [Adoptium Temurin](https://adoptium.net/en-GB/temurin/) sources.
+Minimalist Wolfi-based Java JDK image using OpenJDK.  Used for compiling Java applications.
+
+- [Documentation](https://edu.chainguard.dev/chainguard/chainguard-images/reference/jdk)
+- [Getting Started Guide](https://edu.chainguard.dev/chainguard/chainguard-images/reference/jdk/overview/#use-it)
+- [Provenance Information](https://edu.chainguard.dev/chainguard/chainguard-images/reference/jdk/provenance_info/)
 
 ## Get It!
 

diff --git a/images/jenkins/README.md b/images/jenkins/README.md
@@ -2,7 +2,7 @@
 # jenkins
 | | |
 | - | - |
-| **Status** | experimental |
+| **Status** | stable |
 | **OCI Reference** | `cgr.dev/chainguard/jenkins` |
 | **Variants/Tags** | ![](https://storage.googleapis.com/chainguard-images-build-outputs/summary/jenkins.svg) |
 
@@ -11,7 +11,11 @@
 ---
 <!--monopod:end-->
 
-Minimal Jenkins container image. **Currently experimental.**
+Minimal [Jenkins](https://jenkins.io) container image. **Currently experimental.**
+
+- [Documentation](https://edu.chainguard.dev/chainguard/chainguard-images/reference/jenkins)
+- [Getting Started Guide](https://edu.chainguard.dev/chainguard/chainguard-images/reference/jenkins/overview/#use-it)
+- [Provenance Information](https://edu.chainguard.dev/chainguard/chainguard-images/reference/jenkins/provenance_info/)
 
 ## Get It!
 
@@ -21,7 +25,7 @@ The image is available on `cgr.dev`:
 docker pull cgr.dev/chainguard/jenkins:latest
 ```
 
-## Usage
+## Use It
 
 This is an experimental image and subject to change.  We welcome all feedback.
 

diff --git a/images/jenkins/image.yaml b/images/jenkins/image.yaml
@@ -1,4 +1,4 @@
-status: experimental
+status: stable
 versions:
   - apko:
       config: configs/latest.apko.yaml

diff --git a/images/jre/README.md b/images/jre/README.md
@@ -11,7 +11,11 @@
 ---
 <!--monopod:end-->
 
-Java JRE image using OpenJDK via [Adoptium Temurin](https://adoptium.net/en-GB/temurin/) sources.
+Minimalist Wolfi-based Java JRE image using OpenJDK.  Used for running Java applications.
+
+- [Documentation](https://edu.chainguard.dev/chainguard/chainguard-images/reference/jre)
+- [Getting Started Guide](https://edu.chainguard.dev/chainguard/chainguard-images/reference/jre/overview/#use-it)
+- [Provenance Information](https://edu.chainguard.dev/chainguard/chainguard-images/reference/jre/provenance_info/)
 
 ## Get It!
 

diff --git a/images/maven/README.md b/images/maven/README.md
@@ -11,7 +11,11 @@
 ---
 <!--monopod:end-->
 
-Minimal image with Maven build system. **EXPERIMENTAL**
+Minimal image with Maven build system.
+
+- [Documentation](https://edu.chainguard.dev/chainguard/chainguard-images/reference/maven)
+- [Getting Started Guide](https://edu.chainguard.dev/chainguard/chainguard-images/reference/maven/overview/#use-maven)
+- [Provenance Information](https://edu.chainguard.dev/chainguard/chainguard-images/reference/maven/provenance_info/)
 
 ## Get It!
 
@@ -25,17 +29,13 @@ docker pull cgr.dev/chainguard/maven:latest
 
 Chainguard Maven images come with different versions of OpenJDK, ensure you choose the correct image tag for your application needs.  In these examples we will use a Chainguard Maven image based on OpenJDK 17.
 
-__NOTE__: if you are running Docker on Mac M1 you may experience intermittent container high CPU and container / JVM crashes.  There have been [reports](https://github.com/metanorma/metanorma-docker/issues/126) of this behaviour and also affects non Chainguard images.  It is expected that using `arm` based images will address the problem which is in development for Chainguard images.  When running the examples below you might experince maven builds hanging.  If you do, you can `docker ps` and `docker kill $PID` and retry.  This is not an ideal experience and will be improved.
-
 Check the maven version
 ```
 docker run --rm --platform=linux/amd64 cgr.dev/chainguard/maven:openjdk-17 --version
 ```
 
 ### Examples
 
-_Note_ in the examples below when working with Docker we are using the flag `--platform=linux/amd64` as this has been tested on a Mac M1.  You may not need this flag and therefore can be removed during your steps.
-
 #### SpringBoot
 
 Visit https://start.spring.io