From d2775687d1a49c1fa12917ea8e69cccea99231be Mon Sep 17 00:00:00 2001 From: Ben Rockwood Date: Wed, 24 Jan 2024 04:28:10 -0800 Subject: [PATCH] Add management of DockerHub mondoo/cnquery & mondoo/cnspec Descriptions (#424) * Add missing mondoo Docker Org overfile texts Signed-off-by: Ben Rockwood * Add action steps to update cnquery and cnspec Signed-off-by: Ben Rockwood * Version update for readmes Signed-off-by: Ben Rockwood * Allow manual invocation Signed-off-by: Ben Rockwood --------- Signed-off-by: Ben Rockwood --- .github/workflows/dockerhub_docs.yml | 17 +++++++++++++++++ dockerhub/mondoo/cnquery.md | 25 +++++++++++++++++++++++++ dockerhub/mondoo/cnspec.md | 25 +++++++++++++++++++++++++ 3 files changed, 67 insertions(+) create mode 100644 dockerhub/mondoo/cnquery.md create mode 100644 dockerhub/mondoo/cnspec.md diff --git a/.github/workflows/dockerhub_docs.yml b/.github/workflows/dockerhub_docs.yml index 4dcd9bdd..1541c6ce 100644 --- a/.github/workflows/dockerhub_docs.yml +++ b/.github/workflows/dockerhub_docs.yml @@ -1,6 +1,7 @@ name: Update Docker Hub docs on: + workflow_dispatch: push: branches: - main @@ -34,4 +35,20 @@ jobs: repository: mondoo/client readme-filepath: ./dockerhub/mondoo/client.md + - name: Update mondoo/cnquery DockerHub docs + uses: peter-evans/dockerhub-description@v3 + with: + username: ${{ secrets.DOCKER_USERNAME }} + password: ${{ secrets.DOCKER_PASSWORD }} + repository: mondoo/cnquery + readme-filepath: ./dockerhub/mondoo/cnquery.md + + - name: Update mondoo/cnspec DockerHub docs + uses: peter-evans/dockerhub-description@v3 + with: + username: ${{ secrets.DOCKER_USERNAME }} + password: ${{ secrets.DOCKER_PASSWORD }} + repository: mondoo/cnspec + readme-filepath: ./dockerhub/mondoo/cnspec.md + diff --git a/dockerhub/mondoo/cnquery.md b/dockerhub/mondoo/cnquery.md new file mode 100644 index 00000000..42cbedc9 --- /dev/null +++ b/dockerhub/mondoo/cnquery.md @@ -0,0 +1,25 @@ + +``` + ___ _ __ __ _ _ _ ___ _ __ _ _ + / __| '_ \ / _` | | | |/ _ \ '__| | | | +| (__| | | | (_| | |_| | __/ | | |_| | + \___|_| |_|\__, |\__,_|\___|_| \__, | + mondoo™ |_| |___/ +``` + +# Quick reference + +* Basic use: ```docker run mondoo/cnquery ``` +* Source Code: https://github.com/mondoohq/cnquery +* Release Notes: https://mondoo.com/releases/ +* Documentation: [mondoo.com/docs/cnquery/](https://mondoo.com/docs/cnquery/) +* Where to get help: [Mondoo Community GitHub Discussions](https://github.com/orgs/mondoohq/discussions) +* Dockerfile Source: https://github.com/mondoohq/cnquery/blob/main/Dockerfile +* Where to file issues: https://github.com/mondoohq/cnquery/issues +* Mondoo Client Binary Downloads (Non-Container): https://releases.mondoo.com/cnquery/ +* Supported Architectures: `amd64`, `i386`, `arm32v6`, `arm32v7`, and `arm64` + +# Supported tags +- `latest` - always pinned to the latest release +- `9` - always pinned to the latest release for a given major version +- `9.1.0` - always pinned to a specific release diff --git a/dockerhub/mondoo/cnspec.md b/dockerhub/mondoo/cnspec.md new file mode 100644 index 00000000..f9336536 --- /dev/null +++ b/dockerhub/mondoo/cnspec.md @@ -0,0 +1,25 @@ +``` + ___ _ __ ___ _ __ ___ ___ + / __| '_ \/ __| '_ \ / _ \/ __| +| (__| | | \__ \ |_) | __/ (__ + \___|_| |_|___/ .__/ \___|\___| + mondoo™ |_| +``` + + +# Quick reference + +* Basic use: ```docker run mondoo/cnspec ``` +* Source Code: https://github.com/mondoohq/cnspec +* Release Notes: https://mondoo.com/releases/ +* Documentation: [mondoo.com/docs/cnspec/](https://mondoo.com/docs/cnspec/) +* Where to get help: [Mondoo Community GitHub Discussions](https://github.com/orgs/mondoohq/discussions) +* Dockerfile Source: https://github.com/mondoohq/cnspec/blob/main/Dockerfile +* Where to file issues: https://github.com/mondoohq/cnspec/issues +* Binary Downloads (Non-Container): https://releases.mondoo.com/cnspec/ +* Supported Architectures: `amd64`, `i386`, `arm32v6`, `arm32v7`, and `arm64` + +# Supported tags +- `latest` - always pinned to the latest release +- `9` - always pinned to the latest release for a given major version +- `9.1.0` - always pinned to a specific release