Skip to content

Commit 1950f63

Browse files
feat: Add image for OpenSearch Dashboards (#1248)
* add image for OpenSearch Dashboards including the securityDashboards plugin * add changelog entry * add boil config for opensearch-dashboards * fix build args for boil * wip: add sbom generation with cdxgen * remove debug code from Dockerfile * address feedback on PR * fix vector image tag * address feedback on PR & download nodejs as tar.gz instead of tar.xz * fix update-readme-badges * download node from stackable mirror * add opensearch-dashboardsto various lists * wip: opensearch-dashboards plugins * fix(opensearch-dashboards): Fix the version arguments * fix(opensearch-dashboards): Fix the installation of the plugins * fix whitespace errors * add comment on tar usage * update issue template to use boil instead of bake * fix hadolint * remove unused copy instruction * update bake reference in workflow * fix boil syntax * remove unnecessary grep --------- Co-authored-by: Siegfried Weber <mail@siegfriedweber.net>
1 parent 0667811 commit 1950f63

File tree

79 files changed

+1074
-3
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+1074
-3
lines changed

.github/ISSUE_TEMPLATE/early-pre-release.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ Part of <https://github.com/stackabletech/issues/issues/xxx>.
5656
- [ ] [Create issue from template: update-product-nifi.md](https://github.com/stackabletech/docker-images/issues/new?template=update-product-nifi.md)
5757
- [ ] [Create issue from template: update-product-opa.md](https://github.com/stackabletech/docker-images/issues/new?template=update-product-opa.md)
5858
- [ ] [Create issue from template: update-product-opensearch.md](https://github.com/stackabletech/docker-images/issues/new?template=update-product-opensearch.md)
59+
- [ ] [Create issue from template: update-product-opensearch-dashboards.md](https://github.com/stackabletech/docker-images/issues/new?template=update-product-opensearch-dashboards.md)
5960
- [ ] [Create issue from template: update-product-spark.md](https://github.com/stackabletech/docker-images/issues/new?template=update-product-spark.md)
6061
- [ ] [Create issue from template: update-product-superset.md](https://github.com/stackabletech/docker-images/issues/new?template=update-product-superset.md)
6162
- [ ] [Create issue from template: update-product-trino.md](https://github.com/stackabletech/docker-images/issues/new?template=update-product-trino.md)
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
name: Update OpenSearch Dashboards
3+
about: >-
4+
This template contains instructions specific to updating this product and/or
5+
container image(s).
6+
title: >-
7+
chore(opensearch-dashboards): Update major/minor|patch versions for YY.M.X
8+
labels: []
9+
# Currently, projects cannot be assigned via front-matter.
10+
projects: ['stackabletech/10']
11+
assignees: ''
12+
---
13+
14+
Part of <https://github.com/stackabletech/docker-images/issues/xxx>.
15+
16+
<!--
17+
This gives hints to the person doing the work.
18+
Add/Change/Remove anything that isn't applicable anymore
19+
-->
20+
- Add: `x.x.x`
21+
- Remove: `y.y.y`
22+
23+
> [!TIP]
24+
> Please add the `scheduled-for/YY.M.X` label, and add to the [Stackable Engineering][1] project.
25+
>
26+
> [1]: https://github.com/orgs/stackabletech/projects/10
27+
28+
## Update tasks
29+
30+
- [ ] Update `boil-config.toml` to reflect the agreed upon versions in the spreadsheet (including the removal of old versions).
31+
- [ ] Update other dependencies if applicable (eg: security-plugin, etc).
32+
- [ ] Check other operators (getting_started / kuttl / supported-versions) for usage of the versions. Add the PR(s) to the list below.
33+
- [ ] Update the version in demos. Add the PR(s) to the list below.
34+
35+
## Related Pull Requests
36+
37+
> [!TIP]
38+
> Delete any items that do not apply so that all applicable items can be checked.
39+
> For example, if you add release notes to the documentation repository, you do not need the latter two criteria.
40+
41+
- _Link to the docker-images PR (product update)_
42+
- _Link to the operator PR (getting_started / kuttl / supported-versions)_
43+
- _Link to any other operator PRs (getting_started / kuttl)_
44+
- _Link to demo PR (raise against the `main` branch)_
45+
- _Link to the Release Notes PR in the documentation repo (if not a comment below)_
46+
47+
## Acceptance
48+
49+
> [!TIP]
50+
> This list should be completed by the assignee(s), once respective PRs have been merged. Once all items have been
51+
> checked, the issue can be moved into _Development: Done_.
52+
53+
- [ ] Can build image (either locally, or in CI)
54+
- [ ] Kuttl smoke tests passes (either locally, or in CI)
55+
- [ ] Release notes added to documentation and linked as a PR above
56+
- [ ] Release notes written in a comment below
57+
- [ ] Applicable `release-note` label added to this issue
58+
59+
<details>
60+
<summary>Testing instructions</summary>
61+
62+
```shell
63+
# Where x.y.z is the new version added in this PR
64+
boil build opensearch-dashboards=x.y.z --strip-architecture --load
65+
66+
kind load docker-image oci.stackable.tech/sdp/opensearch-dashboards:x.y.z-stackable0.0.0-dev
67+
68+
# Change directory into the opensearch repository and update the
69+
# product version in tests/test-definition.yaml (once there is an integration test for opensearch-dashboards)
70+
./scripts/run-tests --test-suite smoke-latest # or similar
71+
```
72+
73+
</details>
74+
75+
_Please consider updating this template if these instructions are wrong, or
76+
could be made clearer._
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: Build OpenSearch Dashboards
3+
run-name: |
4+
Build OpenSearch Dashboards (attempt #${{ github.run_attempt }})
5+
6+
on:
7+
workflow_dispatch:
8+
schedule:
9+
- cron: '0 0 2/2 * *' # https://crontab.guru/#0_0_2/2_*_*
10+
push:
11+
branches: [main]
12+
tags:
13+
- "[0-9][0-9].[0-9]+.[0-9]+"
14+
- "[0-9][0-9].[0-9]+.[0-9]+-rc[0-9]+"
15+
paths:
16+
# To check dependencies, run this ( you will need to consider transitive dependencies)
17+
# cargo boil build PRODUCT -d
18+
- opensearch-dashboards/**
19+
- vector/**
20+
- stackable-base/**
21+
- stackable-devel/**
22+
- .github/actions/**
23+
- .github/workflows/build_opensearch_dashboards.yaml
24+
- .github/workflows/reusable_build_image.yaml
25+
26+
jobs:
27+
build_image:
28+
name: Reusable Workflow
29+
uses: ./.github/workflows/reusable_build_image.yaml
30+
secrets:
31+
harbor-robot-secret: ${{ secrets.HARBOR_ROBOT_SDP_GITHUB_ACTION_BUILD_SECRET }}
32+
slack-token: ${{ secrets.SLACK_CONTAINER_IMAGE_TOKEN }}
33+
with:
34+
product-name: opensearch-dashboards
35+
sdp-version: ${{ github.ref_type == 'tag' && github.ref_name || '0.0.0-dev' }}
36+
registry-namespace: sdp

.github/workflows/preflight.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ jobs:
6767
- omid
6868
- opa
6969
- opensearch
70+
- opensearch-dashboards
7071
- spark-k8s
7172
- superset
7273
- trino

.scripts/update_feature_tracker_db.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ PRODUCT_CODE_NAMES=(
3434
kafka
3535
nifi
3636
opensearch
37+
opensearch-dashboards
3738
spark-k8s
3839
superset
3940
trino

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ All notable changes to this project will be documented in this file.
1111
- opensearch: Use build-repo.stackable.tech instead of Maven Central ([#1222]).
1212
- opensearch: Add the `opensearch-prometheus-exporter` plugin to the image ([#1223]).
1313
- opensearch: Replace the demo configuration of the OpenSearch Security plugin with a minimal one ([#1228]).
14+
- opensearch-dashboards: Add an image for Opensearch Dashboards with version `3.1.0` ([#1248]).
1415
- nifi: Backport NIFI-14848 to NiFi ([#1225]).
1516
- stackable-base: Add cert-tools ([#1247]).
1617
- kafka: Add jackson xml dataformat for Kafka 4.0.0 ([#1262]).
@@ -68,6 +69,7 @@ All notable changes to this project will be documented in this file.
6869
[#1228]: https://github.com/stackabletech/docker-images/pull/1228
6970
[#1230]: https://github.com/stackabletech/docker-images/pull/1230
7071
[#1247]: https://github.com/stackabletech/docker-images/pull/1247
72+
[#1248]: https://github.com/stackabletech/docker-images/pull/1248
7173
[#1253]: https://github.com/stackabletech/docker-images/pull/1253
7274
[#1258]: https://github.com/stackabletech/docker-images/pull/1258
7375
[#1262]: https://github.com/stackabletech/docker-images/pull/1262

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@ This repository contains Dockerfiles and scripts to build base images for use wi
88
| [![Build Airflow]][build_airflow.yaml] | [![Build Druid]][build_druid.yaml] | [![Build Hadoop]][build_hadoop.yaml] | [![Build HBase]][build_hbase.yaml] |
99
| [![Build Hive]][build_hive.yaml] | [![Build Java Base]][build_java-base.yaml] | [![Build Java Development]][build_java-devel.yaml] | [![Build Kafka Testing Tools]][build_kafka-testing-tools.yaml] |
1010
| [![Build Kafka]][build_kafka.yaml] | [![Build Krb5]][build_krb5.yaml] | [![Build NiFi]][build_nifi.yaml] | [![Build Omid]][build_omid.yaml] |
11-
| [![Build OPA]][build_opa.yaml] | [![Build OpenSearch]][build_opensearch.yaml] | [![Build Spark Connect Client]][build_spark-connect-client.yaml] | [![Build Spark K8s]][build_spark-k8s.yaml] |
12-
| [![Build Stackable Base]][build_stackable-base.yaml] | [![Build Superset]][build_superset.yaml] | [![Build Testing Tools]][build_testing-tools.yaml] | [![Build Tools]][build_tools.yaml] |
13-
| [![Build Trino CLI]][build_trino-cli.yaml] | [![Build Trino]][build_trino.yaml] | [![Build Vector]][build_vector.yaml] | [![Build ZooKeeper]][build_zookeeper.yaml] |
11+
| [![Build OPA]][build_opa.yaml] | [![Build OpenSearch]][build_opensearch.yaml] | [![Build OpenSearch Dashboards]][build_opensearch_dashboards.yaml] | [![Build Spark Connect Client]][build_spark-connect-client.yaml] |
12+
| [![Build Spark K8s]][build_spark-k8s.yaml] | [![Build Stackable Base]][build_stackable-base.yaml] | [![Build Superset]][build_superset.yaml] | [![Build Testing Tools]][build_testing-tools.yaml] |
13+
| [![Build Tools]][build_tools.yaml] | [![Build Trino CLI]][build_trino-cli.yaml] | [![Build Trino]][build_trino.yaml] | [![Build Vector]][build_vector.yaml] |
14+
| [![Build ZooKeeper]][build_zookeeper.yaml] | | | |
1415
<!-- end:badges -->
1516

1617
## Prerequisites
@@ -79,6 +80,8 @@ preflight check container oci.stackable.tech/sdp/<IMAGE>:<VERSION>-stackable<REL
7980
[build_opa.yaml]: https://github.com/stackabletech/docker-images/actions/workflows/build_opa.yaml
8081
[Build OpenSearch]: https://github.com/stackabletech/docker-images/actions/workflows/build_opensearch.yaml/badge.svg
8182
[build_opensearch.yaml]: https://github.com/stackabletech/docker-images/actions/workflows/build_opensearch.yaml
83+
[Build OpenSearch Dashboards]: https://github.com/stackabletech/docker-images/actions/workflows/build_opensearch_dashboards.yaml/badge.svg
84+
[build_opensearch_dashboards.yaml]: https://github.com/stackabletech/docker-images/actions/workflows/build_opensearch_dashboards.yaml
8285
[Build Spark Connect Client]: https://github.com/stackabletech/docker-images/actions/workflows/build_spark-connect-client.yaml/badge.svg
8386
[build_spark-connect-client.yaml]: https://github.com/stackabletech/docker-images/actions/workflows/build_spark-connect-client.yaml
8487
[Build Spark K8s]: https://github.com/stackabletech/docker-images/actions/workflows/build_spark-k8s.yaml/badge.svg

0 commit comments

Comments
 (0)