mirror of
https://gitlab.fabcity.hamburg/software/fab-city-os-core-chart.git
synced 2024-09-20 04:18:52 +02:00
added helm chart release notes
This commit is contained in:
parent
3077b3cff9
commit
b51c572134
|
@ -5,6 +5,11 @@ First of all, thank you for contributing to FabCityOS! The goal of this document
|
||||||
- [Assumptions](#assumptions)
|
- [Assumptions](#assumptions)
|
||||||
- [How to Contribute](#how-to-contribute)
|
- [How to Contribute](#how-to-contribute)
|
||||||
- [Development Workflow](#development-workflow)
|
- [Development Workflow](#development-workflow)
|
||||||
|
- [Realease the chart](#realease-the-chart)
|
||||||
|
- [Install the helm push plugin](#install-the-helm-push-plugin)
|
||||||
|
- [Add the Gitlab repository](#add-the-gitlab-repository)
|
||||||
|
- [Build a package](#build-a-package)
|
||||||
|
- [Push the package to Gitlab](#push-the-package-to-gitlab)
|
||||||
- [Git Guidelines](#git-guidelines)
|
- [Git Guidelines](#git-guidelines)
|
||||||
- [Release Process (for internal team only)](#release-process-for-internal-team-only)
|
- [Release Process (for internal team only)](#release-process-for-internal-team-only)
|
||||||
|
|
||||||
|
@ -38,7 +43,7 @@ In order to use the different tools on this repository, you will first need to:
|
||||||
|
|
||||||
- [Optional: Use the Nix Package Manager](https://nix.dev/tutorials/install-nix). This will allow you to make use of the [nixpkgs](https://github.com/NixOS/nixpkgs), automatically managing all required dependencies from the [`nix shell env`](shell.nix). In addition you also need the [nixpkgs: direnv](https://search.nixos.org/packages?query=direnv) for automatic environment selection.
|
- [Optional: Use the Nix Package Manager](https://nix.dev/tutorials/install-nix). This will allow you to make use of the [nixpkgs](https://github.com/NixOS/nixpkgs), automatically managing all required dependencies from the [`nix shell env`](shell.nix). In addition you also need the [nixpkgs: direnv](https://search.nixos.org/packages?query=direnv) for automatic environment selection.
|
||||||
|
|
||||||
```bash
|
```sh
|
||||||
k3d cluster create --config k3d-fcoscore-dev.yaml
|
k3d cluster create --config k3d-fcoscore-dev.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -50,7 +55,7 @@ helm install --dry-run fcoscore .
|
||||||
|
|
||||||
You can install and test the Helm chart by running:
|
You can install and test the Helm chart by running:
|
||||||
|
|
||||||
```bash
|
```sh
|
||||||
helm install fcoscore .
|
helm install fcoscore .
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -62,13 +67,13 @@ watch -n 1 kubectl get all --all-namespaces
|
||||||
|
|
||||||
An easy way to access your FabCityOS instance and test that it is up and running is by using port-forwarding. This can be achieved by running:
|
An easy way to access your FabCityOS instance and test that it is up and running is by using port-forwarding. This can be achieved by running:
|
||||||
|
|
||||||
```bash
|
```sh
|
||||||
kubectl port-forward --namespace default svc/fcoscore 7700:7700
|
kubectl port-forward --namespace default svc/fcoscore 7700:7700
|
||||||
```
|
```
|
||||||
|
|
||||||
Finally, to uninstall the chart, run:
|
Finally, to uninstall the chart, run:
|
||||||
|
|
||||||
```bash
|
```sh
|
||||||
helm uninstall fcoscore
|
helm uninstall fcoscore
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -84,7 +89,7 @@ helm install --dry-run fcoscore .
|
||||||
|
|
||||||
Each PR should pass the linter to be accepted.
|
Each PR should pass the linter to be accepted.
|
||||||
|
|
||||||
```bash
|
```sh
|
||||||
# Linter
|
# Linter
|
||||||
helm lint .
|
helm lint .
|
||||||
```
|
```
|
||||||
|
@ -92,7 +97,7 @@ helm lint .
|
||||||
Each PR should also check if the generated file `manifests/fcoscore.yaml` is updated with the new modifications.
|
Each PR should also check if the generated file `manifests/fcoscore.yaml` is updated with the new modifications.
|
||||||
You can generated the manifest with the command line:
|
You can generated the manifest with the command line:
|
||||||
|
|
||||||
```bash
|
```sh
|
||||||
helm template fcoscore . | grep -v 'helm.sh/chart:\|app.kubernetes.io/managed-by:' > manifests/FabCityOS.yaml
|
helm template fcoscore . | grep -v 'helm.sh/chart:\|app.kubernetes.io/managed-by:' > manifests/FabCityOS.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -104,6 +109,32 @@ Or just by comment the PR:
|
||||||
|
|
||||||
Additionally, the CI will run a test to check if there are changes introduced to the charts. If changes were introduced, it will require you to update the Chart version.
|
Additionally, the CI will run a test to check if there are changes introduced to the charts. If changes were introduced, it will require you to update the Chart version.
|
||||||
|
|
||||||
|
### Realease the chart
|
||||||
|
|
||||||
|
#### Install the helm push plugin
|
||||||
|
|
||||||
|
```sh
|
||||||
|
helm plugin install https://github.com/chartmuseum/helm-push
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Add the Gitlab repository
|
||||||
|
|
||||||
|
```sh
|
||||||
|
helm repo add --username <username> --password <access_token> fabcity-os-core-chart https://gitlab.fabcity.hamburg/api/v4/projects/248/packages/helm/alpha
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Build a package
|
||||||
|
|
||||||
|
```sh
|
||||||
|
helm package .
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Push the package to Gitlab
|
||||||
|
|
||||||
|
```sh
|
||||||
|
helm cm-push fcoscore-0.0.1.tgz fabcity-os-core-chart
|
||||||
|
```
|
||||||
|
|
||||||
## Git Guidelines
|
## Git Guidelines
|
||||||
|
|
||||||
### Git Branches <!-- omit in toc -->
|
### Git Branches <!-- omit in toc -->
|
||||||
|
|
Loading…
Reference in a new issue