Skip to content

Commit

Permalink
Prepare for new release
Browse files Browse the repository at this point in the history
  • Loading branch information
jertel committed May 17, 2021
1 parent cd6416c commit 8642c72
Show file tree
Hide file tree
Showing 7 changed files with 22 additions and 16 deletions.
20 changes: 13 additions & 7 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,26 +9,32 @@
## Other changes
- None

# Upcoming Release
# 2.1.0

## Breaking changes
- TheHive alerter refactoring - [#142](https://github.com/jertel/elastalert2/pull/142) - @ferozsalam
- See the updated documentation for changes required to alert formatting
- Dockerfile refactor for performance and size improvements - [#102](https://github.com/jertel/elastalert2/pull/102) - @jgregmac
- Dockerfile base image changed from `python/alpine` to `python/slim-buster` to take advantage of pre-build python wheels, accelerate build times, and reduce image size. If you have customized an image, based on jertel/elastalert2, you may need to make adjustments.
- Default base path changed to `/opt/elastalert` in the Dockerfile and in Helm charts. Update your volume binds accordingly.
- Dockerfile now runs as a non-root user "elastalert". Ensure your volumes are accessible by this non-root user.
- System packages removed from the Dockerfile: All dev packages, cargo, libmagic. Image size reduced to 250Mb.
- `tmp` files and dev packages removed from the final container image.
- TheHive alerter refactoring - [#142](https://github.com/jertel/elastalert2/pull/142) - @ferozsalam
- See the updated documentation for changes required to alert formatting

## New features
- Added support for alerting via Amazon Simple Email System (SES) - [#105](https://github.com/jertel/elastalert2/pull/105) - @nsano-rururu
- Support a footer in alert text - [#133](https://github.com/jertel/elastalert2/pull/133) - @nsano-rururu
- Support extra message features for Slack and Mattermost - [#140](https://github.com/jertel/elastalert2/pull/140) - @nsano-rururu
- Support for environment variable substitutions in yaml config files - [#149](https://github.com/jertel/elastalert2/pull/149) - @archfz
- Support for multiple rules directories and fix `..data` Kubernetes/Openshift recursive directories in FileRulesLoader [#157](https://github.com/jertel/elastalert2/pull/157) - @mrfroggg
- Support environment variable substition in yaml files - [#149](https://github.com/jertel/elastalert2/pull/149) - @archfz
- Update schema.yaml and enhance documentation for Email alerter - [#144](https://github.com/jertel/elastalert2/pull/144) - @nsano-rururu
- Default Email alerter to use port 25, and require http_post_url for HTTP Post alerter - [#143](https://github.com/jertel/elastalert2/pull/143) - @nsano-rururu
- Support extra message features for Slack and Mattermost - [#140](https://github.com/jertel/elastalert2/pull/140) - @nsano-rururu
- Support a footer in alert text - [#133](https://github.com/jertel/elastalert2/pull/133) - @nsano-rururu
- Added support for alerting via Amazon Simple Email System (SES) - [#105](https://github.com/jertel/elastalert2/pull/105) - @nsano-rururu

## Other changes
- Begin alerter refactoring to split large source code files into smaller files - [#161](https://github.com/jertel/elastalert2/pull/161) - @ferozsalam
- Update contribution guidelines with additional instructions for local testing - [#147](https://github.com/jertel/elastalert2/pull/147), [#148](https://github.com/jertel/elastalert2/pull/148) - @ferozsalam
- Add more unit test coverage - [#108](https://github.com/jertel/elastalert2/pull/108) - @nsano-rururu
- Update documentation: describe limit_execution, correct alerters list - [#107](https://github.com/jertel/elastalert2/pull/107) - @fberrez
- Fix issue with testing alerts that contain Jinja templates - [#101](https://github.com/jertel/elastalert2/pull/101) - @jertel
- Updated all references of Elastalert to use the mixed case ElastAlert, as that is the most prevalent formatting found in the documentation.

Expand Down
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,9 @@ Maintainers, when creating a new release, follow the procedure below:
- [setup.py](setup.py): Match the version to the new release version
- [Chart.yaml](chart/elastalert2/Chart.yaml): Match chart version and the app version to the new release version (typically keep them in sync)
- [values.yaml](chart/elastalert2/values.yaml): Match the default image version to the new release version.
- [README.md](chart/elastalert2/README.md): Match the default image version to the new release version.
- [CHANGELOG.md](CHANGELOG.md): This must contain all PRs and any other relevent notes about this release.
- [Chart README.md](chart/elastalert2/README.md): Match the default image version to the new release version.
- [Project README.md](README.md): Match the default image version to the new release version.
- [CHANGELOG.md](CHANGELOG.md): This must contain all PRs and any other relevent notes about this release
3. Publish a [new][1] release.
- The title (and tag) of the release will be the same value as the new version determined in step 1.
- Paste the new version change notes from CHANGELOG.md into the description field.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Please see our [contributing guidelines][6].

If you're interested in a pre-built Docker image check out the [elastalert2][2] project on Docker Hub.

Be aware that the `latest` tag of the image represents the latest commit into the master branch. If you prefer to upgrade more slowly you will need utilize a versioned tag, such as `2.0.4` instead, or `2` if you are comfortable with always using the latest released version of ElastAlert 2.
Be aware that the `latest` tag of the image represents the latest commit into the master branch. If you prefer to upgrade more slowly you will need utilize a versioned tag, such as `2.1.0` instead, or `2` if you are comfortable with always using the latest released version of ElastAlert 2.

A properly configured config.yaml file must be mounted into the container during startup of the container. Use the [example file][1] provided as a template, and once saved locally to a file such as `/tmp/elastalert.yaml`, run the container as follows:

Expand Down
5 changes: 2 additions & 3 deletions chart/elastalert2/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
apiVersion: v1
description: Automated rule-based alerting for Elasticsearch
name: elastalert2
version: 2.0.4
appVersion: 2.0.4
version: 2.1.0
appVersion: 2.1.0
home: https://github.com/jertel/elastalert2
sources:
- https://github.com/jertel/elastalert2
maintainers:
- name: jertel
email: [email protected]
engine: gotpl
2 changes: 1 addition & 1 deletion chart/elastalert2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The command removes all the Kubernetes components associated with the chart and
| Parameter | Description | Default |
|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|---------------------------------|
| `image.repository` | docker image | jertel/elastalert2 |
| `image.tag` | docker image tag | 2.0.4 |
| `image.tag` | docker image tag | 2.1.0 |
| `image.pullPolicy` | image pull policy | IfNotPresent |
| `podAnnotations` | Annotations to be added to pods | {} |
| `command` | command override for container | `NULL` |
Expand Down
2 changes: 1 addition & 1 deletion chart/elastalert2/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ image:
# docker image
repository: jertel/elastalert2
# docker image tag
tag: 2.0.4
tag: 2.1.0
pullPolicy: IfNotPresent

resources: {}
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
base_dir = os.path.dirname(__file__)
setup(
name='elastalert2',
version='2.0.4',
version='2.1.0',
description='Automated rule-based alerting for Elasticsearch',
setup_requires='setuptools',
license='Apache 2.0',
Expand Down

0 comments on commit 8642c72

Please sign in to comment.