Skip to content

Recommend use of the wait command, improve formatting #76

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.

Sign up for GitHub

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

Merged
caugustus-sourcegraph merged 1 commit into from
Mar 17, 2022
+17 −7
Merged

Recommend use of the wait command, improve formatting #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 7 additions & 2 deletions charts/sourcegraph/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
## Installation

Add the Sourcegraph charts repo to Helm:

```sh
helm repo add sourcegraph https://sourcegraph.github.io/deploy-sourcegraph-helm/
```
Expand All @@ -39,8 +39,11 @@ The install command would then be:
### Setting a namespace

By default, helm installs the chart into your active namespace. To install to a separate namespace, use the `--namespace` flag. For example:

`helm install --namespace new-namespace <name> sourcegraph/sourcegraph`

Or if using an override file:

`helm install --namespace new-namespace -f <your-override-file.yaml> <name> sourcegraph/sourcegraph`

If the namespace does not already exist, add the `--create-namespace` flag to create it during installation.
Expand Down Expand Up @@ -342,7 +345,9 @@ To upgrade to a new version of the helm chart:
1. (Optional) Review the changes that will be applied (`helm template` or `helm diff`, see [Reviewing changes](#reviewing-changes))

1. Install the new version:<br>
`helm upgrade --install -f <your-override-file.yaml> <name> --version <version> sourcegraph/sourcegraph`
`helm upgrade --install --wait -f <your-override-file.yaml> <name> --version <version> sourcegraph/sourcegraph`

The `--wait` flag is optional and can be removed if you do not want to wait for the upgraded resources to become healthy.

## Versioning

Expand Down
15 changes: 10 additions & 5 deletions charts/sourcegraph/README.md.gotmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!--
DO NOT EDIT README.md directly.
README.md is automatically generated from README.md.gotmpl
<!--
DO NOT EDIT README.md directly.
README.md is automatically generated from README.md.gotmpl
-->

# Sourcegraph Helm Chart
Expand All @@ -13,7 +13,7 @@
## Installation

Add the Sourcegraph charts repo to Helm:

```sh
helm repo add sourcegraph https://sourcegraph.github.io/deploy-sourcegraph-helm/
```
Expand All @@ -39,8 +39,11 @@ The install command would then be:
### Setting a namespace

By default, helm installs the chart into your active namespace. To install to a separate namespace, use the `--namespace` flag. For example:

`helm install --namespace new-namespace <name> sourcegraph/sourcegraph`

Or if using an override file:

`helm install --namespace new-namespace -f <your-override-file.yaml> <name> sourcegraph/sourcegraph`

If the namespace does not already exist, add the `--create-namespace` flag to create it during installation.
Expand Down Expand Up @@ -99,7 +102,9 @@ To upgrade to a new version of the helm chart:
1. (Optional) Review the changes that will be applied (`helm template` or `helm diff`, see [Reviewing changes](#reviewing-changes))

1. Install the new version:<br>
`helm upgrade --install -f <your-override-file.yaml> <name> --version <version> sourcegraph/sourcegraph`
`helm upgrade --install --wait -f <your-override-file.yaml> <name> --version <version> sourcegraph/sourcegraph`

The `--wait` flag is optional and can be removed if you do not want to wait for the upgraded resources to become healthy.

## Versioning

Expand Down