Skip to content

Commit

Permalink
Updating For 2.0.5 release (#339)
Browse files Browse the repository at this point in the history
* Updating For 2.0.5 release

* Fixing Snyk CI
  • Loading branch information
nniehoff authored Nov 29, 2023
1 parent 371ae47 commit b20d579
Show file tree
Hide file tree
Showing 22 changed files with 95 additions and 62 deletions.
69 changes: 35 additions & 34 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -63,40 +63,41 @@ jobs:
# with:
# sarif_file: "checkov.sarif"

snyk-security-check:
name: "Snyk Security Scanning"
runs-on: "ubuntu-22.04"
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
steps:
- name: "Checkout"
uses: "actions/checkout@v4"
- uses: "azure/setup-helm@v3"
- run: "mkdir template_output"
- run: "helm repo add bitnami https://charts.bitnami.com/bitnami"
- run: "helm dependency update charts/nautobot"
- run: "helm template -n testing -f charts/nautobot/linter_values_minimum.yaml -f charts/nautobot/linter_values.yaml charts/nautobot --output-dir=./template_output/test-postgresql"
- run: "helm template -n testing -f charts/nautobot/linter_values_minimum.yaml -f charts/nautobot/linter_values.yaml -f charts/nautobot/linter_values_mysql.yaml charts/nautobot --output-dir=./template_output/test-mysql"
- run: "helm template -n testing -f charts/nautobot/linter_values_minimum.yaml -f charts/nautobot/linter_values.yaml -f charts/nautobot/linter_values_postgresql_ha.yaml charts/nautobot --output-dir=./template_output/test-postgresql-ha"
- run: "helm template -n testing -f charts/nautobot/linter_values_minimum.yaml charts/nautobot --output-dir=./template_output/test-defaults"
- name: "Run Snyk to check template files for security issues"
# Snyk can be used to break the build when it detects security issues.
# In this case we want to upload the issues to GitHub Code Scanning
continue-on-error: true
uses: "snyk/actions/iac@master"
env:
# In order to use the Snyk Action you will need to have a Snyk API token.
# More details in https://github.com/snyk/actions#getting-your-snyk-token
SNYK_TOKEN: "${{ secrets.SNYK_TOKEN }}"
with:
# Add the path to the configuration file that you would like to test.
# For example `deployment.yaml` for a Kubernetes deployment manifest
# or `main.tf` for a Terraform configuration file
file: "./template_output"
- name: "Upload result to GitHub Code Scanning"
uses: "github/codeql-action/upload-sarif@v2"
with:
sarif_file: "snyk.sarif"
# Disabling Snyk for now see https://github.com/nautobot/helm-charts/issues/340
# snyk-security-check:
# name: "Snyk Security Scanning"
# runs-on: "ubuntu-22.04"
# env:
# GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
# steps:
# - name: "Checkout"
# uses: "actions/checkout@v4"
# - uses: "azure/setup-helm@v3"
# - run: "mkdir template_output"
# - run: "helm repo add bitnami https://charts.bitnami.com/bitnami"
# - run: "helm dependency update charts/nautobot"
# - run: "helm template -n testing -f charts/nautobot/linter_values_minimum.yaml -f charts/nautobot/linter_values.yaml charts/nautobot --output-dir=./template_output/test-postgresql"
# - run: "helm template -n testing -f charts/nautobot/linter_values_minimum.yaml -f charts/nautobot/linter_values.yaml -f charts/nautobot/linter_values_mysql.yaml charts/nautobot --output-dir=./template_output/test-mysql"
# - run: "helm template -n testing -f charts/nautobot/linter_values_minimum.yaml -f charts/nautobot/linter_values.yaml -f charts/nautobot/linter_values_postgresql_ha.yaml charts/nautobot --output-dir=./template_output/test-postgresql-ha"
# - run: "helm template -n testing -f charts/nautobot/linter_values_minimum.yaml charts/nautobot --output-dir=./template_output/test-defaults"
# - name: "Run Snyk to check template files for security issues"
# # Snyk can be used to break the build when it detects security issues.
# # In this case we want to upload the issues to GitHub Code Scanning
# continue-on-error: true
# uses: "snyk/actions/iac@master"
# env:
# # In order to use the Snyk Action you will need to have a Snyk API token.
# # More details in https://github.com/snyk/actions#getting-your-snyk-token
# SNYK_TOKEN: "${{ secrets.SNYK_TOKEN }}"
# with:
# # Add the path to the configuration file that you would like to test.
# # For example `deployment.yaml` for a Kubernetes deployment manifest
# # or `main.tf` for a Terraform configuration file
# file: "./template_output"
# - name: "Upload result to GitHub Code Scanning"
# uses: "github/codeql-action/upload-sarif@v2"
# with:
# sarif_file: "snyk.sarif"

kubescape-security-check:
name: "Kubescape Security Scanning"
Expand Down
15 changes: 15 additions & 0 deletions .github/workflows/release-chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,18 @@ jobs:
with:
token: "${{ secrets.GITHUB_TOKEN }}"
dependencies: "bitnami,https://charts.bitnami.com/bitnami"

publish-oci:
runs-on: "ubuntu-22.04"
steps:
- name: "Publish Helm charts to OCI"
uses: "appany/[email protected]"
with:
name: "nautobot"
repository: "nautobot/helm-charts"
tag: "${{ github.ref }}"
path: "charts/nautobot"
registry: "ghcr.io"
registry_username: "${{ secrets.REGISTRY_USERNAME }}"
registry_password: "${{ secrets.REGISTRY_PASSWORD }}"
update_dependencies: false
3 changes: 2 additions & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ repos:
rev: "3.0.0"
hooks:
- id: "markdownlint"
language_version: "3.1.4"
args:
- "--ignore-front-matter"
- "docs/"
Expand All @@ -42,7 +43,7 @@ repos:
- id: "helmlint"

- repo: "https://github.com/adrienverge/yamllint.git"
rev: "v1.32.0"
rev: "v1.33.0"
hooks:
- id: "yamllint"
args:
Expand Down
14 changes: 7 additions & 7 deletions charts/nautobot/Chart.lock
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
dependencies:
- name: redis
repository: oci://registry-1.docker.io/bitnamicharts
version: 18.0.4
version: 18.4.0
- name: postgresql
repository: oci://registry-1.docker.io/bitnamicharts
version: 12.12.4
version: 12.12.10
- name: postgresql-ha
repository: oci://registry-1.docker.io/bitnamicharts
version: 11.9.4
version: 11.9.8
- name: mariadb
repository: oci://registry-1.docker.io/bitnamicharts
version: 13.1.3
- name: rabbitmq
repository: oci://registry-1.docker.io/bitnamicharts
version: 12.1.5
version: 12.5.4
- name: common
repository: oci://registry-1.docker.io/bitnamicharts
version: 2.11.1
digest: sha256:3806eb6003a65f010929a2d51fda545f976ffaaa21ba20ec4de39c69cffb88df
generated: "2023-09-21T07:38:38.691332-06:00"
version: 2.13.3
digest: sha256:bb3c3e05c521aa73d1b97c2e45ff36f0ca5824fad5c8039add4dcbbc8072d087
generated: "2023-11-28T15:10:01.439123-07:00"
24 changes: 11 additions & 13 deletions charts/nautobot/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ annotations:
artifacthub.io/prerelease: "false"
artifacthub.io/images: |
- name: nautobot
image: ghcr.io/nautobot/nautobot:1.6.2-py3.11
image: ghcr.io/nautobot/nautobot:2.0.5-py3.11
artifacthub.io/links: |
- name: Nautobot Documentation
url: https://docs.nautobot.com/
Expand All @@ -31,26 +31,24 @@ annotations:
url: https://raw.githubusercontent.com/nautobot/nautobot/develop/nautobot/docs/media/ss_plugin_chatops.png
artifacthub.io/changes: |
- kind: fixed
description: Fixed #306 Bug: configured prometheus backend not possible
description: Fixed #338 Allow Nautobot to Scale to 0
- kind: fixed
description: Fixed #316 Concurrency int breaks deployment
- kind: fixed
description: Fixed #255 Switch dependencies to OCI
description: Fixed #335 Use Nautobot 2.0 by default
- kind: changed
description: Upgraded Nautobot from 1.5.23 to 1.6.2
description: Upgraded Nautobot from 1.6.2 to 2.0.5
- kind: changed
description: Upgraded Mariadb subchart from 12.2.5 to 13.1.3
description: Upgraded Bitnami Common subchart from 2.11.1 to 2.13.3
- kind: changed
description: Upgraded PostgreSQL subchart from 12.5.7 to 12.12.4
description: Upgraded PostgreSQL subchart from 12.12.4 to 12.12.10
- kind: changed
description: Upgraded PostgreSQL-HA subchart from 11.7.5 to 11.9.4
description: Upgraded PostgreSQL-HA subchart from 11.9.4 to 11.9.8
- kind: changed
description: Upgraded RabbitMQ subchart from 12.0.1 to 12.1.5
description: Upgraded RabbitMQ subchart from 12.1.5 to 12.5.4
- kind: changed
description: Upgraded Redis subchart from 17.11.5 to 18.0.4
description: Upgraded Redis subchart from 18.0.4 to 18.4.0
apiVersion: "v2"
appVersion: "1.6.2"
version: "2.0.4"
appVersion: "2.0.5"
version: "2.0.5"
dependencies:
- condition: "redis.enabled"
name: "redis"
Expand Down
4 changes: 2 additions & 2 deletions charts/nautobot/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# nautobot

![Version: 2.0.4](https://img.shields.io/badge/Version-2.0.4-informational?style=flat-square) ![AppVersion: 1.6.2](https://img.shields.io/badge/AppVersion-1.6.2-informational?style=flat-square)
![Version: 2.0.5](https://img.shields.io/badge/Version-2.0.5-informational?style=flat-square) ![AppVersion: 2.0.5](https://img.shields.io/badge/AppVersion-2.0.5-informational?style=flat-square)

Nautobot is a Network Source of Truth and Network Automation Platform.

Expand Down Expand Up @@ -270,7 +270,7 @@ The `mariadb.*` values configure the upstream chart from Bitnami. Please see th
| <a name="nautobot.image.pullSecrets">[nautobot.image.pullSecrets](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L49)</a> | []string | `[]` | List of secret names to be used as image [pull secrets](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/), common to all deployments |
| <a name="nautobot.image.registry">[nautobot.image.registry](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L41)</a> | string | `"ghcr.io"` | Nautobot image registry, common to all deployments |
| <a name="nautobot.image.repository">[nautobot.image.repository](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L43)</a> | string | `"nautobot/nautobot"` | Nautobot image name, common to all deployments |
| <a name="nautobot.image.tag">[nautobot.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L45)</a> | string | `"1.6.2-py3.11"` | Nautobot image tag, common to all deployments |
| <a name="nautobot.image.tag">[nautobot.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L45)</a> | string | `"2.0.5-py3.11"` | Nautobot image tag, common to all deployments |
| <a name="nautobot.initContainers">[nautobot.initContainers](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L203)</a> | [][Container](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container) | `[]` | [[ref](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/)] Add additional init containers to the Nautobot server pods |
| <a name="nautobot.lifecycleHooks">[nautobot.lifecycleHooks](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L175)</a> | [Lifecycle](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle) | `{}` | lifecycleHooks for the Nautobot container(s) to automate configuration before or after startup |
| <a name="nautobot.livenessProbe">[nautobot.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L61)</a> | [Probe](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle-1) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes)] Nautobot liveness probe |
Expand Down
Binary file removed charts/nautobot/charts/common-2.11.1.tgz
Binary file not shown.
Binary file added charts/nautobot/charts/common-2.13.3.tgz
Binary file not shown.
Binary file added charts/nautobot/charts/postgresql-12.12.10.tgz
Binary file not shown.
Binary file removed charts/nautobot/charts/postgresql-12.12.4.tgz
Binary file not shown.
Binary file removed charts/nautobot/charts/postgresql-ha-11.9.4.tgz
Binary file not shown.
Binary file added charts/nautobot/charts/postgresql-ha-11.9.8.tgz
Binary file not shown.
Binary file removed charts/nautobot/charts/rabbitmq-12.1.5.tgz
Binary file not shown.
Binary file added charts/nautobot/charts/rabbitmq-12.5.4.tgz
Binary file not shown.
Binary file removed charts/nautobot/charts/redis-18.0.4.tgz
Binary file not shown.
Binary file added charts/nautobot/charts/redis-18.4.0.tgz
Binary file not shown.
2 changes: 1 addition & 1 deletion charts/nautobot/values.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@
},
"replicaCount": {
"type": "integer",
"minimum": 1
"minimum": 0
},
"revisionHistoryLimit": {
"type": "integer",
Expand Down
2 changes: 1 addition & 1 deletion charts/nautobot/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ nautobot:
# -- Nautobot image name, common to all deployments
repository: "nautobot/nautobot"
# -- Nautobot image tag, common to all deployments
tag: "1.6.2-py3.11"
tag: "2.0.5-py3.11"
# -- [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/), common to all deployments valid values: `Always`, `Never`, or `IfNotPresent`
pullPolicy: "Always"
# -- ([]string) List of secret names to be used as image [pull secrets](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/), common to all deployments
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ The `mariadb.*` values configure the upstream chart from Bitnami. Please see th
| <a name="nautobot.image.pullSecrets">[nautobot.image.pullSecrets](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L49)</a> | []string | `[]` | List of secret names to be used as image [pull secrets](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/), common to all deployments |
| <a name="nautobot.image.registry">[nautobot.image.registry](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L41)</a> | string | `"ghcr.io"` | Nautobot image registry, common to all deployments |
| <a name="nautobot.image.repository">[nautobot.image.repository](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L43)</a> | string | `"nautobot/nautobot"` | Nautobot image name, common to all deployments |
| <a name="nautobot.image.tag">[nautobot.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L45)</a> | string | `"1.6.2-py3.11"` | Nautobot image tag, common to all deployments |
| <a name="nautobot.image.tag">[nautobot.image.tag](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L45)</a> | string | `"2.0.5-py3.11"` | Nautobot image tag, common to all deployments |
| <a name="nautobot.initContainers">[nautobot.initContainers](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L203)</a> | [][Container](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Container) | `[]` | [[ref](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/)] Add additional init containers to the Nautobot server pods |
| <a name="nautobot.lifecycleHooks">[nautobot.lifecycleHooks](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L175)</a> | [Lifecycle](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle) | `{}` | lifecycleHooks for the Nautobot container(s) to automate configuration before or after startup |
| <a name="nautobot.livenessProbe">[nautobot.livenessProbe](https://github.com/nautobot/helm-charts/blob/main/charts/nautobot/values.yaml#L61)</a> | [Probe](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#lifecycle-1) | See values.yaml | [[ref](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#configure-probes)] Nautobot liveness probe |
Expand Down
18 changes: 18 additions & 0 deletions docs/release-notes/version-2.x.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,24 @@
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## 2.0.5 - 2023-11-29

+/- 2.0.5
This release of the helm-chart includes an upgrade to Nautobot 2.x. While this is a non-breaking change for the helm chart this is a significant change to Nautobot and care should be taken during the upgrade, please see the [Nautobot 2.0 Release Notes](https://docs.nautobot.com/projects/core/en/stable/release-notes/version-2.0/) and [upgrading from 1.x instructions](https://docs.nautobot.com/projects/core/en/stable/user-guide/administration/upgrading/from-v1/upgrading-from-nautobot-v1/).

### Fixed

* [#338](https://github.com/nautobot/helm-charts/issues/338) Allow Nautobot to Scale to 0
* [#335](https://github.com/nautobot/helm-charts/issues/335) Use Nautobot 2.0 by default

### Changed

* Upgraded Bitnami Common subchart from 2.11.1 to 2.13.3
* Upgraded PostgreSQL subchart from 12.12.4 to 12.12.10
* Upgraded PostgreSQL-HA subchart from 11.9.4 to 11.9.8
* Upgraded RabbitMQ subchart from 12.1.5 to 12.5.4
* Upgraded Redis subchart from 18.0.4 to 18.4.0

## 2.0.4 - 2023-09-21

### Fixed
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
mkdocs==1.5.3
mkdocs-material==9.4.8
mkdocs-material==9.4.14
mkdocs-version-annotations==1.0.0
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ invoke = "*"
# Rendering docs to HTML
mkdocs = "~1.5.3"
# Material for MkDocs theme
mkdocs-material = "9.4.8"
mkdocs-material = "9.4.14"
# Render custom markdown for version added/changed/remove notes
mkdocs-version-annotations = "1.0.0"

Expand Down

0 comments on commit b20d579

Please sign in to comment.