Skip to content

Commit

Permalink
Merge pull request #324 from bitovi/docs/tools-versions
Browse files Browse the repository at this point in the history
Docs: Describe the latest tools Versioning
  • Loading branch information
arm4b authored Oct 13, 2022
2 parents 3c3be10 + 8ec782d commit 9f0b850
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions docs/versioning.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
# Versioning

## Tools
We package the latest versions of the tools that are available at a release time for the [official BitOps Docker images](#official-images). Check out [BitOps Releases](https://github.com/bitovi/bitops/releases)
to understand which versions are currently shipped.
> If you need specific versions or tools, you can [build your own image](plugins.md#creating-your-own-bitops-image)
with the [custom plugins](plugins.md#creating-your-own-plugin).

## Images
BitOps Docker images are packaged and hosted on [Docker Hub](https://hub.docker.com/r/bitovi/bitops).
Here is how these images are named, versioned and tagged.

Expand All @@ -8,7 +16,7 @@ Here is how these images are named, versioned and tagged.
* A version tag containing `omnibus` points to the default image that includes recommended DevOps tools.
* A version tag containing `base` refers to a minimal image with no other tools. You can build a [custom BitOps image](plugins.md) from it.

## Official Images
### Official Images
To clear up any potential confusion regarding the versioning of the [`bitovi/bitops`](https://hub.docker.com/r/bitovi/bitops) image, we use the following table.

| Image Name | PreInstalled Tools| Docker image name | Supported Cloud provider | Additional stable image tags | Development image tags (`main` branch) |
Expand All @@ -21,7 +29,7 @@ To clear up any potential confusion regarding the versioning of the [`bitovi/bit
| | | | | | |
| base | BitOps source | `bitovi/bitops:2.0.0-base` | - | `base` | `dev-base` |

## Version Pinning
### Image tag pinning
* We always recommend pinning the stable version of BitOps to avoid any breaking changes like `bitovi/bitops:2.0.0`.
* If the security is higher priority for you, use sha256 digest like `bitovi/bitops:sha256:82becede498899ec668628e7cb0ad87b6e1c371cb8a1e597d83a47fac21d6af3`.

Expand Down

0 comments on commit 9f0b850

Please sign in to comment.