Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor improvements to docs #259

Merged
merged 1 commit into from
Mar 7, 2024
Merged

Minor improvements to docs #259

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docker/README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ toc::[]
[[available-images]]
## Available images

* `killbill/base:latest`: shared base image with Tomcat and KPM inside Ubuntu 20.04 LTS.
* `killbill/killbill:latest`: empty base Kill Bill image. It runs `kpm install` on startup before running Kill Bill. If no custom `kpm.yml` file is specified, the latest version of Kill Bill and the KPM plugin are downloaded.
* `killbill/killbill:0.X.Y`: image with a specific version of Kill Bill installed and the KPM plugin.
* `killbill/kaui:latest`: empty base Kaui image. It runs `kpm install` on startup before running Kaui. If no custom `kpm.yml` file is specified, the latest version of Kaui is downloaded.
* `killbill/kaui:0.X.Y`: image with a specific version of Kaui installed.
* `killbill/killbill:build`: official build environment for all published Kill Bill artifacts (useful for developers).
* `killbill/base:latest`: Shared base image with Tomcat and KPM inside Ubuntu 20.04 LTS. It also contains Ansible and our playbooks from https://github.com/killbill/killbill-cloud. It starts Tomcat on startup.
* `killbill/killbill:latest`: Empty base Kill Bill image. Includes the `killbill-flyway` utility. It runs `kpm install` on startup. If no custom `kpm.yml` file is specified, the latest version of Kill Bill is downloaded.
* `killbill/killbill:0.X.Y`: Image with a specific version of Kill Bill installed.
* `killbill/kaui:latest`: Empty base Kaui image. It runs `kpm install` on startup. If no custom `kpm.yml` file is specified, the latest version of Kaui is downloaded.
* `killbill/kaui:0.X.Y`: Image with a specific version of Kaui installed.
* `killbill/killbill:build`: Official build environment for all published Kill Bill artifacts (useful for developers).

[[tips-and-tricks]]
### Tips and tricks
Expand Down Expand Up @@ -46,7 +46,7 @@ For PostgreSQL support specifically, you need to specify `KAUI_DB_ADAPTER=postgr

[[changes-since-0.24.7]]
## Changes since 0.24.7
* Tomcat has been updated from 8.5.* to 9.0.*
* Tomcat has been updated from *8.5.x* to *9.0.x*

[[changes-since-0.22.27]]
## Changes since 0.22.27
Expand Down
6 changes: 4 additions & 2 deletions docker/templates/base/latest/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# killbill/base image

The base image contains Ansible and our playbooks from https://github.com/killbill/killbill-cloud.
Shared base image with Tomcat, JDK and KPM inside Ubuntu 20.04 LTS. It also contains Ansible and our playbooks from https://github.com/killbill/killbill-cloud.

By default, the latest version of `master` is checked-out at build time, but this can be configured through the `KILLBILL_CLOUD_VERSION` build argument, e.g.:
To build this docker image:

```
docker build -t killbill/base:latest --build-arg KILLBILL_CLOUD_VERSION=<some_branch> .
```

Here `<some_branch>` specifies the branch of the `killbill-cloud` repo that should be [checked-out](https://github.com/killbill/killbill-cloud/blob/05b8447850be6c2f547acef2817d4d31b81a11cd/docker/templates/base/latest/Dockerfile#L61) at build time. If the `KILLBILL_CLOUD_VERSION` argument is not specified, the `master` branch is used.
Loading