You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-\(RE-15696\) Local Development - Add Grafana and remove redis mount [\#147](https://github.com/puppetlabs/vmpooler-deployment/pull/147) ([yachub](https://github.com/yachub))
- Bump jruby from 9.4.3.0-jdk11 to 9.4.5.0-jdk11 in /docker [\#149](https://github.com/puppetlabs/vmpooler-deployment/pull/149) ([dependabot[bot]](https://github.com/apps/dependabot))
Copy file name to clipboardExpand all lines: README.md
+16-20Lines changed: 16 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,11 +12,11 @@
12
12
-[Contributing](#contributing)
13
13
-[License](#license)
14
14
15
-
This repo contains Dockerfiles and a Helm chart that can be used to deploy [VMPooler](https://github.com/puppetlabs/vmpooler). The Release Engineering team at Puppet uses the code here as part of operating our VMPooler instances.
15
+
Contains Dockerfiles and a Helm chart that are used to deploy [VMPooler](https://github.com/puppetlabs/vmpooler).
16
16
17
17
## VMPooler Components
18
18
19
-
The docker image gnerated and hosted by this project contain the following VMPooler components:
19
+
The docker image contains these VMPooler components:
-[VMPooler Google CloudDNS Plugin](https://github.com/puppetlabs/vmpooler-dns-google-clouddns)
@@ -26,34 +26,34 @@ The docker image gnerated and hosted by this project contain the following VMPoo
26
26
27
27
## Docker Registry
28
28
29
-
The GitHub Actions in this repository publish images to GitHub Packages. You can browse the VMPooler containers[here](https://github.com/puppetlabs/vmpooler-deployment/pkgs/container/vmpooler-deployment%2Fvmpooler).
29
+
GitHub Actions publishes images to GitHub Packages. Browse the VMPooler containers: https://github.com/puppetlabs/vmpooler-deployment/pkgs/container/vmpooler-deployment%2Fvmpooler
30
30
31
-
The vmpooler officially released docker image tags use a semantic version, where the version increments correlate to the increments in any of the gems at `docker/Gemfile`.
31
+
The vmpooler released docker image tags use semantic versioning; the version increments correlate to the increments in any of the gems at `docker/Gemfile`.
32
32
33
33
Image tags starting with `pr<PULL REQUEST NUMBER>-<GIT SHA>` are generated when opening and pushing to a pull request and will periodically be cleaned up.
34
34
35
35
## Helm Repository
36
36
37
-
The `docs/` folder in this repository represents a Helm repository served via GitHub Pages at https://puppetlabs.github.io/vmpooler-deployment/
37
+
The `docs` folder represents a Helm repository served via GitHub Pages at https://puppetlabs.github.io/vmpooler-deployment
1. Become familiar with the configuration file `docker/vmpooler.yaml` as described in [VMPooler](https://github.com/puppetlabs/vmpooler) Core.
56
-
- The default configuration file only enables the dummy provider built into [VMPooler](https://github.com/puppetlabs/vmpooler) Core. See each project below for documentation on how to use provider specific options:
56
+
- The default configuration file enables the dummy provider built into [VMPooler](https://github.com/puppetlabs/vmpooler) Core. See each project for documentation on how to use provider specific options:
3. Run `./update-gemfile-lock` to update the `Gemfile.lock`
82
82
4. Run `docker compose build && docker compose up`.
83
83
84
-
When a dependency Helm chart is updated, be sure to run `./update-chart-lock` to update the lockfile, otherwise the test and release workflows will fail.
84
+
When a dependency Helm chart is updated, always run `./update-chart-lock` to update the lockfile, otherwise the test and release workflows will fail.
85
85
86
86
### Docker Compose URLs
87
87
88
-
These are the default ports used in the docker compose file, to change them edit the `ports` key under the desired service in either `docker/docker-compose.yml` or `docker/docker-compose.local.yml`.
88
+
These are the default ports used in the docker compose file. To change them edit the `ports` key under the service in either `docker/docker-compose.yml` or `docker/docker-compose.local.yml`.
89
89
90
90
Tracing data is sent to the Jaeger instance, a prometheus server scrapes metrics, and both are pre-configured in Grafana as datasources for easy visualization and history of data.
91
91
@@ -115,22 +115,18 @@ Artifactory Example:
115
115
116
116
Create a GitHub tag and release, publish a new docker image, and helm chart by opening a release prep pull request and running the release action below.
117
117
118
-
**NOTE**: Due to the GitHub limitation that does not allow any method of bypassing status checks on a protected branch, the process below will technically publish the helm chart pointing to a nonexistent docker tag until the release workflow is run.
118
+
**NOTE**: Due to the GitHub limitation that does not allow any method of bypassing status checks on a protected branch, the process below will publish the helm chart pointing to a nonexistent docker tag until the release workflow is run.
119
119
120
-
1. Bump the "appVersion" key in`helm-charts/vmpooler/Chart.yaml` appropriately based on changes to `docker/Gemfile` and `docker/Gemfile.lock`in merged pull requests since the last release.
120
+
1. Increment the "appVersion" key in`helm-charts/vmpooler/Chart.yaml` appropriately based on changes to `docker/Gemfile` and `docker/Gemfile.lock`in merged pull requests since the last release.
121
121
- This key pertains to the docker tag that will be pushed upon release.
122
-
2. Bump the "version" key in`helm-charts/vmpooler/Chart.yaml` appropriately based on changes to the chart itself and increments of the "appVersion"in merged pull requests since the last release.
122
+
2. Increment the "version" key in`helm-charts/vmpooler/Chart.yaml` appropriately based on changes to the chart itself and increments of the "appVersion"in merged pull requests since the last release.
123
123
- This key pertains to the helm chart verison that will be pushed upon release.
124
124
3. Run `./update-changelog` to update `CHANGELOG.md`.
125
125
4. Run `./build-chart` to package the new chart and update the repo index.
126
-
5. Commit and push changes to a new branch,then open a pull request against `main` and be sure to add the "maintenance" label.
126
+
5. Commit and push changes to a new branch then open a pull request against `main` and be sure to add the "maintenance" label.
127
127
6. After the pull request is approved and merged, then navigate to Actions --> Docker and Helm Release --> run workflow --> Branch: main --> Run workflow.
128
128
- This action will push a tagged docker image to the GitHub container registry and helm chart to GitHub pages.
129
129
130
-
## Contributing
131
-
132
-
We welcome and encourage contributions!
133
-
134
130
## License
135
131
136
132
vmpooler-deployment is distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html). See the [LICENSE](LICENSE) file for more details.
0 commit comments