Skip to content

Commit 2b1576a

Browse files
weltekialexellis
authored andcommitted
Document static license support for the pro CLI plugin
Add pro plugin installation and activation instructions to the CLI install page, including static license and GitHub activation methods. Update deployment and SSO pages to reference the central install page instead of duplicating instructions. Signed-off-by: Han Verstraete (OpenFaaS Ltd) <han@openfaas.com>
1 parent de3b5bc commit 2b1576a

File tree

3 files changed

+51
-34
lines changed

3 files changed

+51
-34
lines changed

docs/cli/install.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,54 @@ $version = (Invoke-WebRequest "https://api.github.com/repos/openfaas/faas-cli/re
5656
(New-Object System.Net.WebClient).DownloadFile("https://github.com/openfaas/faas-cli/releases/download/$version/faas-cli.exe", "faas-cli.exe")
5757
```
5858

59+
## Pro plugin
60+
61+
The OpenFaaS Pro CLI plugin provides additional features for the faas-cli including [SSO and OIDC authentication](/openfaas-pro/sso/cli).
62+
63+
> Note: The pro plugin is available for [OpenFaaS Standard & For Enterprises](https://openfaas.com/pricing/) customers and requires activation.
64+
65+
Download the pro plugin:
66+
67+
```bash
68+
faas-cli plugin get pro
69+
```
70+
71+
### Activate with a static license
72+
73+
If you have a static JWT license for the CLI, you can enable the plugin without any interactive steps. This is the recommended approach for CI/CD pipelines and air-gapped environments.
74+
75+
Save the license to the default location. Run the following, then paste in your license, hit enter once, then Control + D to save the file.
76+
77+
```bash
78+
mkdir -p ~/.openfaas
79+
cat > ~/.openfaas/LICENSE_CLI
80+
```
81+
82+
Once the license is in place, the plugin is enabled automatically and no additional flags or environment variables are needed.
83+
84+
The license can also be provided through alternative sources. They are resolved in the following priority order:
85+
86+
1. `--license` flag — literal JWT string
87+
2. `--license-file` flag — path to a file containing the JWT
88+
3. `OPENFAAS_LICENSE` environment variable
89+
4. Default file at `$HOME/.openfaas/LICENSE_CLI`
90+
91+
Contact the OpenFaaS team to obtain a static license for the CLI.
92+
93+
### Activate with GitHub
94+
95+
For customers who have a GitHub organisation, you will need to send the OpenFaaS team an email with the name of the organisation, and make sure you can log into your account.
96+
97+
```bash
98+
faas-cli pro enable
99+
```
100+
101+
A browser will open with a device challenge, once completed, the CLI will be enabled.
102+
103+
!!! note "Does your team not have a GitHub organisation available?"
104+
105+
If your organisation does not use GitHub, or you are not a member of its GitHub organisation, you can use a [static license](#activate-with-a-static-license) instead.
106+
59107
## Environment variable overrides
60108

61109
Several overrides exist which will be used by default if set and no other command-line flag has been set.

docs/deployment/pro.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -206,16 +206,9 @@ Learn more:
206206

207207
### OpenFaaS Pro CLI
208208

209-
The OpenFaaS Pro CLI provides additional functionality on top of faas-cli, such as build-time secrets, and a `local-run` command to try out functions without deploying them.
209+
The OpenFaaS Pro CLI plugin provides additional features for the faas-cli including SSO and OIDC authentication.
210210

211-
```bash
212-
faas-cli plugin get pro
213-
faas-cli pro enable
214-
```
215-
216-
You'll need a GitHub account in your company's GitHub organisation to use this feature. If you cannot get one for some reason, or use GitLab, please let us know and we'll provide an alternative mechanism to activate the CLI.
217-
218-
See also: [faas-cli installation](/cli/install)
211+
See: [Pro plugin installation](/cli/install/#pro-plugin)
219212

220213
### Function Builder API
221214

docs/openfaas-pro/sso/cli.md

Lines changed: 1 addition & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,12 @@
22

33
For customers who have enabled IAM for OpenFaaS, OIDC can be used to authenticate the CLI. An initial token will be obtained from your Identity Provider (IdP) and then it will be exchanged for an OpenFaaS access token.
44

5-
You'll need to start off by installing the faas-cli, if you don't have it yet, [it's available on GitHub](https://github.com/openfaas/faas-cli/releases).
5+
You'll need to start off by installing the faas-cli and the pro plugin. See: [CLI Installation](/cli/install) and [Pro plugin](/cli/install/#pro-plugin).
66

77
!!! note "Do you want to run faas-cli from a server instead of as a human user?"
88

99
SSO and OIDC are primarily designed for interactive use by a human user in front of a keyboard, with a web-browser available. If you need to use an OAuth token to authenticate server-to-server, then you you'll need to create a new OAuth client in your IdP, and then use the `--client-secret` flag with the `faas-cli pro auth` command.
1010

11-
### Download the pro plugin
12-
13-
First, download the `pro` plugin which enables SSO using OIDC:
14-
15-
```bash
16-
faas-cli plugin get pro
17-
```
18-
19-
### Enable the plugin
20-
21-
Only authorized use of the plugin is permitted, so you will need to enable it now.
22-
23-
Next, for customers who have a GitHub organisation, you will need to send the OpenFaaS team an email with the name of the organisation, and make sure you can log into your account.
24-
25-
```bash
26-
faas-cli pro enable
27-
```
28-
29-
A browser will open with a device challenge, once completed, the CLI will be enabled.
30-
31-
!!! note "Does your team not have a GitHub organisation available?"
32-
33-
If your organisation does not use GitHub, or you are not a member of its GitHub organisation, there is an alternative approach to enabling the plugin. Email the OpenFaaS team for the details.
34-
3511
### Log into the gateway using SSO
3612

3713
Now you can log into the gateway using one of the defined JwtIssuers for your installation. If you have not defined a JwtIssuer yet, then see the overview post here: [Walkthrough of Identity and Access Management (IAM) for OpenFaaS](https://www.openfaas.com/blog/walkthrough-iam-for-openfaas/).

0 commit comments

Comments
 (0)