# batou_ext - a library of components for batou
`batou_ext` master is now supporting Python3 and is depending on batou2. If you still want to use batou_ext with batou 1.x running Python2 you still can use the [batou1-py2](https://github.com/flyingcircusio/batou_ext/tree/batou1-py2) branch.
To add `batou_ext` to your deployment, add a like to the `requirements.txt` of your batou deployment::
```
batou_ext>=2.4
```
## Development and release process
* Changes should be accompanied with a changelog entry. Use `./changelog.sh` to create one.
* Releasing will create a tag and publishes the package to pypi. Use `./release-this.sh` to create a release.
## Bootstrapping of S3 buckets
Only applicable for administrators of the Flying Circus.
Install the `s3-bootstrap` feature:
```
batou_ext[s3-bootstrap]>=2.4.6
```
Then run
```
./appenv update-lockfile
./appenv run s3_bootstrap
```
The script will interactively walk you through the creation of
creating an [S3 bucket](https://wiki.flyingcircus.io/S3) and - if needed -
an access keypair and lifecycle rules.
On an activated virtualenv this can be tested with `python -m batou_ext.s3_bootstrap`.
## 2.4.7 (2024-04-29)
* Added component `batou_ext.http.HTTPServiceWatchdog` that adds a check to a systemd unit
whether a given URL is reachable (e.g. a `/health` endpoint). If the URL cannot be reached within
a certain interval, the service will be restarted. Further details are documented in the
docstring.
- Fix `SymlinkAndCleanup` async delete and allow custom extra arguments to `systemd run`.
## 2.4.6 (2024-04-23)
- OCI: Support registries where the docker login is different than the registry used in referencing containers.
- OCI: Improve change detection of remote images (required for docker.io)
- OCI: The nix file does not contain sensitive data, so don’t mark it as such.
- OCI: add support for extraOptions
* Added a script `s3_bootstrap` that interactively creates an S3 bucket (including a radosgw account & keys if needed). Will be installed with `batou_ext` if the `s3-bootstrap` extra is requested.
## 2.4.5 (2024-04-17)
- add an option to move mailhog log output (`stdout` + `stderr`) to a different namespace, e.g. "mailhog". see systemd.exec(5) for more information
- add an option to disable `stdout` logging for the mailhog service
- improve dectection of a versions file for versions updates
- fix the oci.Container verify method not throwing an updaterequired on changes to the docker container's environment file
- Add systemd-run async cleanup option for SymlinkAndCleanup removals
## 2.4.4 (2024-04-05)
- Change the behaviour of the batou_ext.versions updater to allow environments to share a branch
* Added a component `batou_ext.git.Remote` which allows to manipulate remotes of a git repository.
## 2.4.3 (2024-01-17)
- Improve output handling for the `PurgePackage` component. Will not appear like a fatal error in logs anymore when the package has been purged already or is not installed for another reason
## 2.4.2 (2023-12-08)
* Make it possible to add arbitrary additional configuration to a service created by a `SystemdTimer()`.
* Add `nixos.NixOSModule` to inject component attributes into .nix files.
## 2.4.1 (2023-11-16)
* Add `*.md` to the release, so it can actually be used.
## 2.4.0 (2023-11-16)
- Add release process with changelog (FC-33250).
Raw data
{
"_id": null,
"home_page": "https://github.com/flyingcircusio/batou_ext",
"name": "batou-ext",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "deployment",
"author": "Flying Circus <support@flyingcircus.io>",
"author_email": "support@flyingcircus.io",
"download_url": "https://files.pythonhosted.org/packages/0c/e3/62184a74a40f289a117f5b0568967e6e7a440e6435d45bb9be4df0eab2ab/batou_ext-2.4.7.tar.gz",
"platform": null,
"description": "# batou_ext - a library of components for batou\n\n`batou_ext` master is now supporting Python3 and is depending on batou2. If you still want to use batou_ext with batou 1.x running Python2 you still can use the [batou1-py2](https://github.com/flyingcircusio/batou_ext/tree/batou1-py2) branch.\n\nTo add `batou_ext` to your deployment, add a like to the `requirements.txt` of your batou deployment::\n\n```\nbatou_ext>=2.4\n```\n\n## Development and release process\n\n* Changes should be accompanied with a changelog entry. Use `./changelog.sh` to create one.\n\n* Releasing will create a tag and publishes the package to pypi. Use `./release-this.sh` to create a release.\n\n## Bootstrapping of S3 buckets\n\nOnly applicable for administrators of the Flying Circus.\n\nInstall the `s3-bootstrap` feature:\n\n```\nbatou_ext[s3-bootstrap]>=2.4.6\n```\n\nThen run\n\n```\n./appenv update-lockfile\n./appenv run s3_bootstrap\n```\n\nThe script will interactively walk you through the creation of\ncreating an [S3 bucket](https://wiki.flyingcircus.io/S3) and - if needed -\nan access keypair and lifecycle rules.\n\nOn an activated virtualenv this can be tested with `python -m batou_ext.s3_bootstrap`.\n\n\n\n## 2.4.7 (2024-04-29)\n\n\n* Added component `batou_ext.http.HTTPServiceWatchdog` that adds a check to a systemd unit\n whether a given URL is reachable (e.g. a `/health` endpoint). If the URL cannot be reached within\n a certain interval, the service will be restarted. Further details are documented in the\n docstring.\n\n- Fix `SymlinkAndCleanup` async delete and allow custom extra arguments to `systemd run`.\n\n\n## 2.4.6 (2024-04-23)\n\n\n- OCI: Support registries where the docker login is different than the registry used in referencing containers.\n\n- OCI: Improve change detection of remote images (required for docker.io)\n\n- OCI: The nix file does not contain sensitive data, so don\u2019t mark it as such.\n\n- OCI: add support for extraOptions\n\n* Added a script `s3_bootstrap` that interactively creates an S3 bucket (including a radosgw account & keys if needed). Will be installed with `batou_ext` if the `s3-bootstrap` extra is requested.\n\n\n## 2.4.5 (2024-04-17)\n\n\n- add an option to move mailhog log output (`stdout` + `stderr`) to a different namespace, e.g. \"mailhog\". see systemd.exec(5) for more information\n\n- add an option to disable `stdout` logging for the mailhog service\n\n- improve dectection of a versions file for versions updates\n\n- fix the oci.Container verify method not throwing an updaterequired on changes to the docker container's environment file\n\n- Add systemd-run async cleanup option for SymlinkAndCleanup removals\n\n\n## 2.4.4 (2024-04-05)\n\n\n- Change the behaviour of the batou_ext.versions updater to allow environments to share a branch\n\n* Added a component `batou_ext.git.Remote` which allows to manipulate remotes of a git repository.\n\n\n## 2.4.3 (2024-01-17)\n\n\n- Improve output handling for the `PurgePackage` component. Will not appear like a fatal error in logs anymore when the package has been purged already or is not installed for another reason\n\n\n## 2.4.2 (2023-12-08)\n\n\n* Make it possible to add arbitrary additional configuration to a service created by a `SystemdTimer()`.\n\n* Add `nixos.NixOSModule` to inject component attributes into .nix files.\n\n\n## 2.4.1 (2023-11-16)\n\n\n* Add `*.md` to the release, so it can actually be used.\n\n\n## 2.4.0 (2023-11-16)\n\n- Add release process with changelog (FC-33250).\n",
"bugtrack_url": null,
"license": "BSD (2-clause)",
"summary": "A library of components for batou.",
"version": "2.4.7",
"project_urls": {
"Homepage": "https://github.com/flyingcircusio/batou_ext"
},
"split_keywords": [
"deployment"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0ce362184a74a40f289a117f5b0568967e6e7a440e6435d45bb9be4df0eab2ab",
"md5": "95f23088fd1a65ddaa3004a346c13773",
"sha256": "f4de2a7dda7d0c621221cdcc9b1babd0835c1620271a6bca98b0dee705b8453c"
},
"downloads": -1,
"filename": "batou_ext-2.4.7.tar.gz",
"has_sig": false,
"md5_digest": "95f23088fd1a65ddaa3004a346c13773",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 84137,
"upload_time": "2024-04-29T08:52:25",
"upload_time_iso_8601": "2024-04-29T08:52:25.729545Z",
"url": "https://files.pythonhosted.org/packages/0c/e3/62184a74a40f289a117f5b0568967e6e7a440e6435d45bb9be4df0eab2ab/batou_ext-2.4.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-29 08:52:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "flyingcircusio",
"github_project": "batou_ext",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "batou-ext"
}
JSON
