ITQ/submariner-charts
1
0
Fork 0
mirror of https://github.com/submariner-io/submariner-charts.git synced 2026-09-20 21:30:35 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix Markdown linting errros in README

Browse Source 
Signed-off-by: Daniel Farrell <dfarrell@redhat.com>
This commit is contained in:
Daniel Farrell
2020-10-21 11:06:52 -04:00
committed by Thomas Pantelis
parent 3ac4e14664
commit 4461924636
1 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+10 -10
View File
@@ -1,17 +1,17 @@
# submariner-charts # submariner-charts
Please see https://github.com/submariner-io/submariner for more information. This is only a supporting repository for Submariner Please see the [Helm docs on Submariner's website](https://submariner.io/deployment/helm/).
# Dev workflow. ## Dev workflow
### Prerequisites ### Prerequisites
- [helm] - [helm]
- [docker] or [podman] - [docker] or [podman]
### Create a fork and checkout. ### Create a fork and checkout
[Create a fork] of the original repository, clone it locally and checkout a new branch from master. [Create a fork] of the original repository, clone it locally and checkout a new branch from master.
Example: Example:
@@ -31,12 +31,12 @@ Before serving the modified charts, the charts must be packaged for local usage.
helm package ./submariner helm package ./submariner
helm package ./submariner-k8s-broker helm package ./submariner-k8s-broker
``` ```
Note: if you just installed helm, you have to init the helm, by running Note: if you just installed helm, you have to init the helm, by running
```bash ```bash
helm init --client-only helm init --client-only
``` ```
Serve the packaged charts through a local helm repository: Serve the packaged charts through a local helm repository:
@@ -44,8 +44,8 @@ Serve the packaged charts through a local helm repository:
docker run -d --rm --name helm-repo -p 8080:8080 -v $PWD:/charts -e DEBUG=true -e STORAGE=local -e STORAGE_LOCAL_ROOTDIR=/charts chartmuseum/chartmuseum docker run -d --rm --name helm-repo -p 8080:8080 -v $PWD:/charts -e DEBUG=true -e STORAGE=local -e STORAGE_LOCAL_ROOTDIR=/charts chartmuseum/chartmuseum
``` ```
or or
```bash ```bash
sudo podman run -d --rm --name helm-repo -p 8080:8080 -v $PWD:/charts -e DEBUG=true -e STORAGE=local -e STORAGE_LOCAL_ROOTDIR=/charts chartmuseum/chartmuseum sudo podman run -d --rm --name helm-repo -p 8080:8080 -v $PWD:/charts -e DEBUG=true -e STORAGE=local -e STORAGE_LOCAL_ROOTDIR=/charts chartmuseum/chartmuseum
``` ```
@@ -93,7 +93,7 @@ Search the new repo for submariner charts:
helm search -l test-repo helm search -l test-repo
``` ```
### Modify submariner e2e tests helm deployment script to use your local test-repo. ### Modify submariner e2e tests helm deployment script to use your local test-repo
You can test your helm-charts with e2e tests from the [shipyard](https://github.com/submariner-io/shipyard) repository. You can test your helm-charts with e2e tests from the [shipyard](https://github.com/submariner-io/shipyard) repository.
In the file `scripts/shared/lib/deploy_helm` change the line from: In the file `scripts/shared/lib/deploy_helm` change the line from:
@@ -102,7 +102,7 @@ In the file `scripts/shared/lib/deploy_helm` change the line from:
helm repo add submariner-latest https://submariner-io.github.io/submariner-charts/charts helm repo add submariner-latest https://submariner-io.github.io/submariner-charts/charts
``` ```
to to
```bash ```bash
internal_ip=$(docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' helm-repo) internal_ip=$(docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' helm-repo)