Skip to content
This repository has been archived by the owner on Feb 2, 2021. It is now read-only.

Commit

Permalink
Document and template "customers_secret" option
Browse files Browse the repository at this point in the history
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
  • Loading branch information
alexellis committed Feb 25, 2020
1 parent 5906a00 commit 0d72394
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 2 deletions.
7 changes: 7 additions & 0 deletions USER_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -357,6 +357,12 @@ You can start out by using the Staging issuer, then switch to the production iss

> Note if you want to switch from the staging TLS certificates to production certificates, see the appendix.

### Use a Kubernetes secret instead of a customers URL (optional)

If you want to keep your list of users private, you can use a Kubernetes secret instead.

Set `customers_secret:` to `true` and then edit the two secrets `customers` and `of-customers`.

### Enable dockerfile language support (optional)

If you are planning on building functions using the `dockerfile` template you need to set `enable_dockerfile_lang: true`.
Expand Down Expand Up @@ -458,6 +464,7 @@ http://system.example.com/dashboard/<username>

Just replace `<username>` with your GitHub account.
> If you have enabled OAuth you only need to navigate to system.example.com

## Trigger a build

Now you can install your GitHub app on a repo, run `faas-cli new` and then rename the YAML file to `stack.yml` and do a `git push`. Your OpenFaaS Cloud cluster will build and deploy the functions found in that GitHub repo.
Expand Down
2 changes: 1 addition & 1 deletion templates/edge-auth-dep.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ spec:
- name: private_key_path
value: "/var/secrets/private/key"
- name: customers_path
value: "/var/secrets/of-customers/of-customers"
value: "{{.OFCustomersSecretPath}}"
# Update for your configuration:
- name: client_secret # this can also be provided via a secret named of-client-secret
value: ""
Expand Down
2 changes: 1 addition & 1 deletion templates/gitlab.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ functions:
read_debug: true
installation_tag: "openfaas-cloud"
gitlab_instance: "{{.GitLabInstance}}"
customers_path: {{.CustomersSecretPath}}
customers_path: "{{.CustomersSecretPath}}"
environment_file:
- gateway_config.yml
secrets:
Expand Down

0 comments on commit 0d72394

Please sign in to comment.