Skip to content
This repository has been archived by the owner on Nov 1, 2022. It is now read-only.

Various documentation fixes #22

Merged
merged 2 commits into from
Aug 13, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Helm Operator

[![CircleCI](https://circleci.com/gh/fluxcd/helm-operator.svg?style=svg)](https://circleci.com/gh/fluxcd/helm-operator)
[![GoDoc](https://godoc.org/github.com/fluxcd/helm-operator?status.svg)](https://godoc.org/github.com/fluxcd/flux)
[![GoDoc](https://godoc.org/github.com/fluxcd/helm-operator?status.svg)](https://godoc.org/github.com/fluxcd/helm-operator)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link is broken now but should be available tomorrow as GoDoc only looks for new packages once a day.

[![Documentation](https://img.shields.io/badge/latest-documentation-informational)](https://docs.fluxcd.io/en/latest/)

The Helm Operator provides an extension to [Flux](https://github.com/fluxcd/flux)
Expand Down Expand Up @@ -58,12 +58,12 @@ be interested in the following:

If you have any questions about Helm Operator and continuous delivery:

- Read [the Helm Operator docs](https://github.com/fluxcd/flux/tree/master/docs).
- Read [the Helm Operator docs](https://docs.fluxcd.io/projects/helm-operator/).
- Invite yourself to the <a href="https://slack.cncf.io" target="_blank">CNCF community</a>
slack and ask a question on the [#flux](https://cloud-native.slack.com/messages/flux/)
channel.
- To be part of the conversation about Helm Operator's development, join the
[flux-dev mailing list](https://lists.cncf.io/g/cncf-flux-dev).
- [File an issue.](https://github.com/fluxcd/flux/issues/new)
- [File an issue.](https://github.com/fluxcd/helm-operator/issues/new)

Your feedback is always welcome!
4 changes: 2 additions & 2 deletions docs/faq.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Frequently asked questions

### I'm using SSL between Helm and Tiller. How can I configure Flux to use the certificate?
### I'm using SSL between Helm and Tiller. How can I configure the operator to use the certificate?

When installing Flux, you can supply the CA and client-side certificate using the `helmOperator.tls` options,
more details [here](https://github.com/fluxcd/flux/blob/master/chart/flux/README.md#installing-weave-flux-helm-operator-and-helm-with-tls-enabled).
more details [here](./tutorials/get-started.md).

### I've deleted a HelmRelease file from Git. Why is the Helm release still running on my cluster?

Expand Down
8 changes: 4 additions & 4 deletions docs/references/helmrelease-custom-resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Each release of a chart is declared by a `HelmRelease`
resource. The schema for these resources is given in [the custom
resource definition](https://github.com/fluxcd/flux/blob/master/deploy-helm/flux-helm-release-crd.yaml). They
resource definition](https://github.com/fluxcd/helm-operator/blob/master/deploy/flux-helm-release-crd.yaml). They
look like this:

```yaml
Expand Down Expand Up @@ -263,7 +263,7 @@ As a workaround, you can mount a `repositories.yaml` file with
authentication already configured, into the operator container.

> **Note:** When using a custom `repositories.yaml` the
[default](https://github.com/fluxcd/flux/blob/master/docker/helm-repositories.yaml)
[default](https://github.com/fluxcd/helm-operator/blob/master/docker/helm-repositories.yaml)
that ships with the operator is overwritten. This means that for any
repository you want to make use of you should manually add an entry to
your `repositories.yaml` file.
Expand Down Expand Up @@ -294,7 +294,7 @@ kubectl create secret generic flux-helm-repositories --from-file=./repositories.
Lastly, mount that secret into the container. This can be done by
setting `helmOperator.configureRepositories.enable` to `true` for the
flux Helm release, or as shown in the commented-out sections of the
[example deployment](https://github.com/fluxcd/flux/blob/master/deploy-helm/helm-operator-deployment.yaml).
[example deployment](https://github.com/fluxcd/helm-operator/blob/master/deploy/helm-operator-deployment.yaml).

#### Azure ACR repositories

Expand Down Expand Up @@ -323,7 +323,7 @@ access.

To provide an SSH key, put the key in a secret under the entry
`identity`, and mount it into the operator container as shown in the
[example deployment](https://github.com/fluxcd/flux/blob/master/deploy-helm/helm-operator-deployment.yaml).
[example deployment](https://github.com/fluxcd/helm-operator/blob/master/deploy/helm-operator-deployment.yaml).
The default ssh_config expects an identity file at
`/etc/fluxd/ssh/identity`, which is where it'll be if you just
uncomment the blocks from the example.
Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Troubleshooting

Also see the [issues labeled with
`FAQ`](https://github.com/fluxcd/flux/labels/FAQ), which often
`question`](https://github.com/fluxcd/helm-operator/labels/question), which often
explain workarounds.

## Error creating helm client: failed to append certificates from file: /etc/fluxd/helm-ca/ca.crt
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ helm upgrade --install \
--set helmOperator.tls.secretName=helm-client \
--set helmOperator.tls.caContent="$(cat ./tls/ca.pem)" \
flux \
fluxcd/flux
fluxcd/helm-operator
```

> **Note:**
Expand Down