Skip to content

Commit

Permalink
Merge pull request #1012 from chainguard-dev/create-pull-request/patch
Browse files Browse the repository at this point in the history
[AutoDocs] Update Images Reference Docs
  • Loading branch information
erikaheidi authored Sep 18, 2023
2 parents cec7e1b + 54877bf commit ecf4e22
Show file tree
Hide file tree
Showing 43 changed files with 1,969 additions and 34 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Please note that digests and timestamps only change when there is a change to th

| Tag (s) | Last Changed | Digest |
|--------------------------|----------------|---------------------------------------------------------------------------|
| `latest-splunk` | September 18th | `sha256:714aea688ee559f5cb5040f9e76565afd231dee66e05e3e14b9544bdb702a18a` |
| `latest-dev` `edge-dev` | September 14th | `sha256:1d50e543cd661c21a3812e59dcf5d5f5747d6f8a38ddbe02db5a3f3821a17471` |
| `latest` `edge` | September 14th | `sha256:5aa6177d87ac9bdcac270830c3c118267c0f11481aadca56419b633a5ae79d07` |
| `latest-splunk` | September 14th | `sha256:3f29e6690e4bdffa91baca5c50828ef33b582bb6b25303449f0ddda3ff417062` |

Original file line number Diff line number Diff line change
Expand Up @@ -23,23 +23,11 @@ toc: true
{{< tab title="Provenance" active=false url="/chainguard/chainguard-images/reference/kubeflow-jupyter-web-app/provenance_info/" >}}
{{</ tabs >}}

Minimal **kubeflow-jupyter-web-app** images with nightly builds.

## Get it!

Minimalist Jupyter Web Application.

## Usage

There are kustomize files exist for deploying this image to a kubernetes cluster in kubeflow official GitHub [repository](github.com/kubeflow/kubeflow/). You can find them in [kubeflow/kubeflow/tree/master/components/crud-web-apps/jupyter/manifests](https://github.com/kubeflow/kubeflow/tree/master/components/crud-web-apps/jupyter/manifests).

All you need to do is running the following command in the directory of the kustomize files:

```bash
$ kubectl create ns kubeflow
$ export CURRENT_JWA_IMG=docker.io/kubeflownotebookswg/jupyter-web-app:latest
$ export PR_JWA_IMG=cgr.dev/chainguard/kubeflow-jupyter-web-app:latest
$ kustomize build overlays/istio | sed "s#$CURRENT_JWA_IMG#$PR_JWA_IMG#g" | kubectl apply -f -
$ kubectl wait pods -n kubeflow -l app=jupyter-web-app --for=condition=Ready --timeout=300s
````

then you will be having a Jupyter Web Application running in your kubernetes cluster, voila!
```
docker pull cgr.dev/chainguard/kubeflow-jupyter-web-app:latest
```

Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@ The **kubeflow-jupyter-web-app** Chainguard Image currently has 2 public variant

The table has detailed information about each of these variants.

| | latest-dev | latest |
|--------------|---------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|
| Default User | `nonroot` | `nonroot` |
| Entrypoint | `/bin/bash -c "gunicorn -w 3 --bind 0.0.0.0:5000 --chdir usr/share/kubeflow-jupyter-web-app --access-logfile - entrypoint:app"` | `/bin/bash -c "gunicorn -w 3 --bind 0.0.0.0:5000 --chdir usr/share/kubeflow-jupyter-web-app --access-logfile - entrypoint:app"` |
| CMD | not specified | not specified |
| Workdir | not specified | not specified |
| Has apk? | yes | no |
| Has a shell? | yes | yes |
| | latest-dev | latest |
|--------------|----------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|
| Default User | `nonroot` | `nonroot` |
| Entrypoint | `/bin/bash -c "gunicorn -w 3 --bind 0.0.0.0:5000 --chdir /usr/share/kubeflow-jupyter-web-app --access-logfile - entrypoint:app"` | `/bin/bash -c "gunicorn -w 3 --bind 0.0.0.0:5000 --chdir /usr/share/kubeflow-jupyter-web-app --access-logfile - entrypoint:app"` |
| CMD | not specified | not specified |
| Workdir | not specified | not specified |
| Has apk? | yes | no |
| Has a shell? | yes | yes |

Check the [tags history page](/chainguard/chainguard-images/reference/kubeflow-jupyter-web-app/tags_history/) for the full list of available tags.

Expand All @@ -47,7 +47,7 @@ The table shows package distribution across variants.
|----------------------------|------------|--------|
| `apk-tools` | X | |
| `bash` | X | X |
| `busybox` | X | X |
| `busybox` | X | |
| `ca-certificates-bundle` | X | X |
| `gdbm` | X | X |
| `git` | X | |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ Please note that digests and timestamps only change when there is a change to th

| Tag (s) | Last Changed | Digest |
|---------------|----------------|---------------------------------------------------------------------------|
| `latest-dev` | September 15th | `sha256:60205821f93e83baef37df709c627a0444a02e7a03a264bd045618e2aee36bbd` |
| `latest` | September 15th | `sha256:ca9f344a575db94be40bbf3233e447c4b797b17d91deecc4badeaca4dc2bf5cf` |
| `latest-dev` | September 18th | `sha256:a7b559689e1807c644f03d64e8e673d3347fb46e1943f9942745e7b1f5bf994e` |
| `latest` | September 18th | `sha256:8ad8d8f8976288a846e96f3b1fd0ce3c0991a176f1d3e697ef1137dd9d1df6ad` |

Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: "Image Overview: kubeflow-pipelines-api-server"
linktitle: "kubeflow-pipelines-api-server"
type: "article"
layout: "single"
description: "Overview: kubeflow-pipelines-api-server 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/kubeflow-pipelines-api-server/" >}}
{{< tab title="Variants" active=false url="/chainguard/chainguard-images/reference/kubeflow-pipelines-api-server/image_specs/" >}}
{{< tab title="Tags History" active=false url="/chainguard/chainguard-images/reference/kubeflow-pipelines-api-server/tags_history/" >}}
{{< tab title="Provenance" active=false url="/chainguard/chainguard-images/reference/kubeflow-pipelines-api-server/provenance_info/" >}}
{{</ tabs >}}

Minimal **kubeflow-pipelines-api-server** images with nightly builds.

## Get it!

```
docker pull cgr.dev/chainguard/kubeflow-pipelines-api-server:latest
```

Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
title: "kubeflow-pipelines-api-server Image Variants"
type: "article"
unlisted: true
description: "Detailed information about the public kubeflow-pipelines-api-server 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/kubeflow-pipelines-api-server/" >}}
{{< tab title="Variants" active=true url="/chainguard/chainguard-images/reference/kubeflow-pipelines-api-server/image_specs/" >}}
{{< tab title="Tags History" active=false url="/chainguard/chainguard-images/reference/kubeflow-pipelines-api-server/tags_history/" >}}
{{< tab title="Provenance" active=false url="/chainguard/chainguard-images/reference/kubeflow-pipelines-api-server/provenance_info/" >}}
{{</ tabs >}}

This page shows detailed information about all public variants of the Chainguard **kubeflow-pipelines-api-server** Image.

## Variants Compared
The **kubeflow-pipelines-api-server** 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 | `nonroot` | `nonroot` |
| Entrypoint | not specified | not specified |
| CMD | `/usr/bin/apiserver --config=/config --sampleconfig=/config/sample_config.json -logtostderr=true` | `/usr/bin/apiserver --config=/config --sampleconfig=/config/sample_config.json -logtostderr=true` |
| Workdir | not specified | not specified |
| Has apk? | yes | no |
| Has a shell? | yes | no |

Check the [tags history page](/chainguard/chainguard-images/reference/kubeflow-pipelines-api-server/tags_history/) for the full list of available tags.

## Packages Included
The table shows package distribution across variants.

| | latest-dev | latest |
|--------------------------------|------------|--------|
| `apk-tools` | X | |
| `bash` | X | |
| `busybox` | X | |
| `ca-certificates-bundle` | X | X |
| `git` | X | |
| `glibc` | X | X |
| `glibc-locale-posix` | X | X |
| `kubeflow-pipelines-apiserver` | X | X |
| `ld-linux` | X | X |
| `libbrotlicommon1` | X | |
| `libbrotlidec1` | X | |
| `libcrypt1` | X | |
| `libcrypto3` | X | X |
| `libcurl-openssl4` | X | |
| `libexpat1` | X | |
| `libgcc` | X | X |
| `libnghttp2-14` | X | |
| `libpcre2-8-0` | X | |
| `libssl3` | X | X |
| `libstdc++` | X | X |
| `ncurses` | X | |
| `ncurses-terminfo-base` | X | |
| `openssl-config` | X | X |
| `wget` | X | X |
| `wolfi-baselayout` | X | X |
| `zlib` | X | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
title: "Provenance Information for kubeflow-pipelines-api-server Images"
type: "article"
unlisted: true
description: "Provenance information for kubeflow-pipelines-api-server 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/kubeflow-pipelines-api-server/" >}}
{{< tab title="Variants" active=false url="/chainguard/chainguard-images/reference/kubeflow-pipelines-api-server/image_specs/" >}}
{{< tab title="Tags History" active=false url="/chainguard/chainguard-images/reference/kubeflow-pipelines-api-server/tags_history/" >}}
{{< tab title="Provenance" active=true url="/chainguard/chainguard-images/reference/kubeflow-pipelines-api-server/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 **kubeflow-pipelines-api-server** 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/kubeflow-pipelines-api-server | 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/kubeflow-pipelines-api-server | 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/kubeflow-pipelines-api-server
```

And you should get output that verifies the SBOM signature in cosign's transparency log:

```
Verification for cgr.dev/chainguard/kubeflow-pipelines-api-server --
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
...
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: "kubeflow-pipelines-api-server Image Tags History"
type: "article"
unlisted: true
description: "Image Tags and History for the kubeflow-pipelines-api-server 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/kubeflow-pipelines-api-server/" >}}
{{< tab title="Variants" active=false url="/chainguard/chainguard-images/reference/kubeflow-pipelines-api-server/image_specs/" >}}
{{< tab title="Tags History" active=true url="/chainguard/chainguard-images/reference/kubeflow-pipelines-api-server/tags_history/" >}}
{{< tab title="Provenance" active=false url="/chainguard/chainguard-images/reference/kubeflow-pipelines-api-server/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 18th | `sha256:5d96190ca79599b204f6dd2bc1460e9789319985b5c1e43b80cf0a53d6af2cb9` |
| `latest` | September 18th | `sha256:c4e1a37a58c61c9f522685f17abbdad4da34b9cd093e319a3292fe45fd12529f` |

Loading

0 comments on commit ecf4e22

Please sign in to comment.