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.

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

release helm chart github action #2917

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/boring-cyborg.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ labelPRBasedOnFilePath:

# Add 'chart' to any changes within 'chart' folder or any subfolders
chart:
- chart/**/*
- charts/**/*

# Add 'docs' to any changes to `.md` files in root or within 'docs' folder, subfolders
docs:
Expand Down
40 changes: 40 additions & 0 deletions .github/workflows/chart-release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: chart-release

on:
push:
branches:
- main

jobs:
release:
# depending on default permission settings for your org (contents being read-only or read-write for workloads), you will have to add permissions
# see: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token
permissions:
contents: write
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Configure Git
run: |
git config user.name "$GITHUB_ACTOR"
git config user.email "[email protected]"

- name: Install Helm
uses: azure/setup-helm@v4
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

- name: add repos
run: |
helm repo add bitnami https://charts.bitnami.com/bitnami

- name: Run chart-releaser
uses: helm/[email protected]
with:
charts_dir: charts
env:
CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
4 changes: 2 additions & 2 deletions .github/workflows/test-chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ name: test-chart
on:
pull_request:
paths:
- 'chart/**'
- '!chart/**.md'
- 'charts/**'
- '!charts/**.md'

jobs:
lint-test-chart:
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ metadata.json
.java-version

# Dependent Helm charts
chart/charts/
marquez/charts/

# Dev
changes.txt
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ repos:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-yaml
exclude: ^chart/
exclude: ^charts/
- id: check-added-large-files

- repo: https:/jguttman94/pre-commit-gradle
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Marquez uses a _multi_-project structure and contains the following modules:
* [`api`](https:/MarquezProject/marquez/tree/main/api): core API used to collect metadata
* [`web`](https:/MarquezProject/marquez/tree/main/web): web UI used to view metadata
* [`clients`](https:/MarquezProject/marquez/tree/main/clients): clients that implement the HTTP [API](https://marquezproject.github.io/marquez/openapi.html)
* [`chart`](https:/MarquezProject/marquez/tree/main/chart): helm chart
* [`chart`](https:/MarquezProject/marquez/tree/main/charts/marquez): helm chart

> **Note:** The `integrations` module was removed in [`0.21.0`](https:/MarquezProject/marquez/blob/main/CHANGELOG.md#removed), so please use an OpenLineage [integration](https://openlineage.io/integration) to collect lineage events easily.

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion ct.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
remote: origin
target-branch: main
charts:
- chart
- charts/marquez
chart-repos:
- bitnami=https://charts.bitnami.com/bitnami
helm-extra-args: "--timeout 600s"
Expand Down
2 changes: 1 addition & 1 deletion docs/deployment-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Marquez uses [Helm](https://helm.sh) to manage deployments onto [Kubernetes](htt

### `TLS/HTTPS`

To enable HTTPS traffic when deploying Marquez onto Kubernetes, use the flag [`ingress.enabled`](https:/MarquezProject/marquez/tree/main/chart#ingress-parameters) to configure the ingress controller. To secure ingress traffic, use the [`ingress.tls`](https:/MarquezProject/marquez/tree/main/chart#ingress-parameters) section to define your TLS `secret` and `hosts` (see `ingress` in the chart's base [`values.yaml`](https:/MarquezProject/marquez/blob/main/chart/values.yaml#L183) for more details).
To enable HTTPS traffic when deploying Marquez onto Kubernetes, use the flag [`ingress.enabled`](https:/MarquezProject/marquez/tree/main/charts/marquez/#ingress-parameters) to configure the ingress controller. To secure ingress traffic, use the [`ingress.tls`](https:/MarquezProject/marquez/tree/main/chart#ingress-parameters) section to define your TLS `secret` and `hosts` (see `ingress` in the chart's base [`values.yaml`](https:/MarquezProject/marquez/blob/main/chart/values.yaml#L183) for more details).

## Database

Expand Down
6 changes: 3 additions & 3 deletions docs/running-on-aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Next, create an AWS RDS instance as outlined in the AWS RDS [documentation](http

1. Navigate to the AWS [RDS](https://console.aws.amazon.com/rds/home) page and create a PostgreSQL database, leaving the database template as **Production**.
2. Use `marquez` as the database identifier and set the master username to `marquez`.
3. Choose a master password to use later in your Helm deployment (see [password](https:/MarquezProject/marquez/blob/main/chart/values.yaml#L32) in `values.yaml`).
3. Choose a master password to use later in your Helm deployment (see [password](https:/MarquezProject/marquez/blob/main/charts/marquez/values.yaml#L32) in `values.yaml`).
4. Leave public access to the database **off**.
5. Choose the same VPC where your AWS EKS cluster resides.
6. In a separate tab, navigate to the AWS EKS cluster page and make note of the security group attached to your cluster.
Expand Down Expand Up @@ -82,7 +82,7 @@ Next, create an AWS RDS instance as outlined in the AWS RDS [documentation](http
1. Get Marquez:

```bash
$ git clone [email protected]:MarquezProject/marquez.git && cd chart
$ git clone [email protected]:MarquezProject/marquez.git && cd charts/marquez
```

2. Install Marquez:
Expand All @@ -97,7 +97,7 @@ Next, create an AWS RDS instance as outlined in the AWS RDS [documentation](http
--wait
```

> **Note:** To avoid overriding deployment settings via the command line, update the [marquez.db](https:/MarquezProject/marquez/blob/main/chart/values.yaml#L27) section of the Marquez Helm chart's `values.yaml` to include the AWS RDS `host`, `username`, and `password` in your deployment.
> **Note:** To avoid overriding deployment settings via the command line, update the [marquez.db](https:/MarquezProject/marquez/blob/main/charts/marquez/values.yaml#L27) section of the Marquez Helm chart's `values.yaml` to include the AWS RDS `host`, `username`, and `password` in your deployment.

3. Verify all the pods have come up correctly:

Expand Down
2 changes: 1 addition & 1 deletion docs/v2/docs/deployment/deployment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

## Helm Chart

Marquez uses [Helm](https://helm.sh) to manage deployments onto [Kubernetes](https://kubernetes.io) in a cloud environment. The chart and templates for the [HTTP API](https:/MarquezProject/marquez/tree/main/api) server and [Web UI](https:/MarquezProject/marquez/tree/main/web) are maintained in the Marquez [repository](https:/MarquezProject/marquez) and can be found in the [chart](https:/MarquezProject/marquez/tree/main/chart) directory. The chart's base `values.yaml` file includes an option to easily override deployment [settings](https:/MarquezProject/marquez/tree/main/chart#configuration).
Marquez uses [Helm](https://helm.sh) to manage deployments onto [Kubernetes](https://kubernetes.io) in a cloud environment. The chart and templates for the [HTTP API](https:/MarquezProject/marquez/tree/main/api) server and [Web UI](https:/MarquezProject/marquez/tree/main/web) are maintained in the Marquez [repository](https:/MarquezProject/marquez) and can be found in the [chart](https:/MarquezProject/marquez/tree/main/chart) directory. The chart's base `values.yaml` file includes an option to easily override deployment [settings](https:/MarquezProject/marquez/tree/main/charts/marquez#configuration).

> **Note:** The Marquez HTTP API server and Web UI images are publshed to [DockerHub](https://hub.docker.com/r/marquezproject/marquez).

Expand Down
6 changes: 3 additions & 3 deletions docs/v2/docs/deployment/running-on-aws.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Next, create an AWS RDS instance as outlined in the AWS RDS [documentation](http

1. Navigate to the AWS [RDS](https://console.aws.amazon.com/rds/home) page and create a PostgreSQL database, leaving the database template as **Production**.
2. Use `marquez` as the database identifier and set the master username to `marquez`.
3. Choose a master password to use later in your Helm deployment (see [password](https:/MarquezProject/marquez/blob/main/chart/values.yaml#L32) in `values.yaml`).
3. Choose a master password to use later in your Helm deployment (see [password](https:/MarquezProject/marquez/blob/main/charts/marquez/values.yaml#L32) in `values.yaml`).
4. Leave public access to the database **off**.
5. Choose the same VPC where your AWS EKS cluster resides.
6. In a separate tab, navigate to the AWS EKS cluster page and make note of the security group attached to your cluster.
Expand Down Expand Up @@ -82,7 +82,7 @@ Next, create an AWS RDS instance as outlined in the AWS RDS [documentation](http
1. Get Marquez:

```bash
$ git clone [email protected]:MarquezProject/marquez.git && cd chart
$ git clone [email protected]:MarquezProject/marquez.git && cd charts/marquez
```

2. Install Marquez:
Expand All @@ -97,7 +97,7 @@ Next, create an AWS RDS instance as outlined in the AWS RDS [documentation](http
--wait
```

> **Note:** To avoid overriding deployment settings via the command line, update the [marquez.db](https:/MarquezProject/marquez/blob/main/chart/values.yaml#L27) section of the Marquez Helm chart's `values.yaml` to include the AWS RDS `host`, `username`, and `password` in your deployment.
> **Note:** To avoid overriding deployment settings via the command line, update the [marquez.db](https:/MarquezProject/marquez/blob/main/charts/marquez/values.yaml#L27) section of the Marquez Helm chart's `values.yaml` to include the AWS RDS `host`, `username`, and `password` in your deployment.

3. Verify all the pods have come up correctly:

Expand Down
4 changes: 2 additions & 2 deletions new-version.sh
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,8 @@ fi
sed -i "" "s/version=.*/version=${RELEASE_VERSION}/g" gradle.properties

# (2) Bump version in helm chart
sed -i "" "s/^version:.*/version: ${RELEASE_VERSION}/g" ./chart/Chart.yaml
sed -i "" -E -e "/postgresql/,\$b" -e "s/tag:.*/tag: ${RELEASE_VERSION}/g" ./chart/values.yaml
sed -i "" "s/^version:.*/version: ${RELEASE_VERSION}/g" ./charts/marquez/Chart.yaml
sed -i "" -E -e "/postgresql/,\$b" -e "s/tag:.*/tag: ${RELEASE_VERSION}/g" ./charts/marquez/values.yaml

# (3) Bump version in scripts
sed -i "" "s/VERSION=.*/VERSION=${RELEASE_VERSION}/g" ./docker/up.sh
Expand Down
2 changes: 1 addition & 1 deletion proposals/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Proposals

Marquez uses a _multi_-project structure and contains the modules [`api`](https:/MarquezProject/marquez/tree/main/api), [`web`](https:/MarquezProject/marquez/tree/main/web), [`clients`](https:/MarquezProject/marquez/tree/main/clients), and [`chart`](https:/MarquezProject/marquez/tree/main/chart). Below, we describe the process for proposing, documenting, and implementing changes to Marquez.
Marquez uses a _multi_-project structure and contains the modules [`api`](https:/MarquezProject/marquez/tree/main/api), [`web`](https:/MarquezProject/marquez/tree/main/web), [`clients`](https:/MarquezProject/marquez/tree/main/clients), and [`chart`](https:/MarquezProject/marquez/tree/main/charts/marquez). Below, we describe the process for proposing, documenting, and implementing changes to Marquez.


## Submitting a Proposal for Review
Expand Down
2 changes: 1 addition & 1 deletion renovate.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,5 @@
"addLabels": ["dependencies", "renovate"]
}
],
"ignorePaths": ["**/chart/**", "**/dev/**"]
"ignorePaths": ["**/charts/**", "**/dev/**"]
}