Skip to content

Commit 63ee423

Browse files
nacardinnacardin
authored
feat: org commands (#318)
1 parent 78116a3 commit 63ee423

File tree

10 files changed

+243
-15
lines changed

10 files changed

+243
-15
lines changed

‎docs/cloud/cli/admin-org.mdx

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
sidebar_position: 90
3+
title: "admin org"
4+
description: "CLI commands for managing an organization"
5+
---
6+
7+
The `fluvio cloud admin org` command is used manage an organization and its users.
8+
9+
```bash
10+
$ fluvio cloud admin org
11+
Organization management
12+
13+
Usage: fluvio-cloud admin org <COMMAND>
14+
15+
Commands:
16+
create Create a new organization
17+
user Manage users in the organization
18+
```
19+
20+
## `fluvio cloud admin org create`
21+
```bash
22+
$ fluvio cloud admin org create -h
23+
Create a new organization
24+
25+
Usage: fluvio-cloud admin org create --name <NAME> --display-name <DISPLAY_NAME>
26+
27+
Options:
28+
--name <NAME> organization name
29+
--display-name <DISPLAY_NAME> organization display name
30+
```
31+
32+
Example usage
33+
```bash
34+
$ fluvio cloud admin org create --name org1 --display-name "Organization 1"
35+
Created organization: Organization 1 (org1)
36+
```
37+
38+
## `fluvio cloud admin org user list`
39+
Lists all users in the organization
40+
41+
Example usage
42+
```bash
43+
$ fluvio cloud admin org user list
44+
USER NAME ROLE EMAIL FULL NAME
45+
self Owner me@example.com My Name
46+
```
47+
48+
## `fluvio cloud admin org user remove`
49+
```bash
50+
$ fluvio cloud admin org user remove -h
51+
Remove a user from the organization
52+
53+
Usage: fluvio-cloud admin org user remove <EMAIL>
54+
55+
Arguments:
56+
<EMAIL> email of the user to remove from the organization
57+
```
58+
59+
## `fluvio cloud admin org user invite`
60+
```bash
61+
$ fluvio cloud admin org user invite -h
62+
Invite a user to the organization
63+
64+
Usage: fluvio-cloud admin org user invite <EMAIL>
65+
66+
Arguments:
67+
<EMAIL> email of the user to invite
68+
```
69+
70+
Example usage
71+
```bash
72+
$ fluvio cloud admin org user invite invitee@example.com
73+
74+
An email has been sent to the user invitee@example.com with an invite code.
75+
You can also provide the invite code to the user manually.
76+
77+
Invite code: RBDSPL3RLNIKBI4JQRFKOSAG7R6RK35V
78+
```
79+
80+
## `fluvio cloud admin org user revoke`
81+
```bash
82+
$ fluvio cloud admin org user revoke -h
83+
Revoke a user invitation
84+
85+
Usage: fluvio-cloud admin org user revoke <INVITE_CODE>
86+
87+
Arguments:
88+
<INVITE_CODE> code of the invite
89+
```

‎docs/cloud/cli/cluster.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
sidebar_position: 20
3-
title: "cluster"
4-
description: "Cluster functions using the Fluvio CLI"
3+
title: cluster
4+
description: "Cluster functions using the Cloud CLI"
55
---
66

77
The `fluvio cloud cluster` family of commands is used to create, delete, and troubleshoot Fluvio clusters in cloud.

‎docs/cloud/cli/connector.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2+
sidebar_position: 30
23
title: connector
3-
weight: 101
44
description: "CLI commands for connector operations."
55
---
66

‎docs/cloud/cli/login.mdx

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
sidebar_position: 10
3+
title: login
4+
description: "CLI commands for organization membership"
5+
---
6+
7+
The `fluvio cloud login` command is used to login after signing up on [InfinyOn Cloud].
8+
9+
```bash
10+
$ fluvio cloud login -h
11+
Log into Infinyon Cloud with OAuth2 or email/password
12+
13+
Usage: fluvio-cloud login [OPTIONS]
14+
15+
Options:
16+
--email <EMAIL> Infinyon Cloud email to use for logging in
17+
--password <PASSWORD> Password to use when logging in (not recommended)
18+
--use-oauth2 Authenticate using OAuth 2.0 Device Code Flow. CLI will try to launch a web browser to log in interactively. If a web browser is not available, CLI
19+
will print URL for device code login
20+
```
21+
22+
[Infinyon Cloud]: https://infinyon.cloud/ui/signup

‎docs/cloud/cli/org.mdx

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
sidebar_position: 80
3+
title: org
4+
description: "CLI commands for organization membership"
5+
---
6+
7+
The `fluvio cloud org` command is used to select org context for cluster commands.
8+
Invitations to join other organization can be accepted or rejected using the `invite` subcommand.
9+
10+
```bash
11+
$ fluvio cloud org
12+
View and sync organizations
13+
14+
Usage: fluvio-cloud org <COMMAND>
15+
16+
Commands:
17+
list List all organizations
18+
select Select organization and sync clusters
19+
invite Invitations to join a new organization
20+
```
21+
22+
## `fluvio cloud org list`
23+
```bash
24+
$ fluvio cloud org list
25+
NAME DISPLAY-NAME
26+
self Personal
27+
* my-org My Organization
28+
```
29+
30+
## `fluvio cloud org select`
31+
```bash
32+
$ fluvio cloud org select -h
33+
Select organization and sync clusters
34+
35+
Usage: fluvio-cloud org select [ORG_NAME]
36+
37+
Arguments:
38+
[ORG_NAME] organization name
39+
```
40+
41+
Example usage
42+
```bash
43+
$ fluvio cloud org select
44+
? You are member of the following organizations. Which one would you like to use?
45+
Personal (self)
46+
> My Organization (my-org)
47+
48+
This organization has the following clusters:
49+
NAME ACTIVE STATUS VERSION SPU_COUNT
50+
my-cluster-1 true Installed 0.12.0 1
51+
52+
? Would you like to use cluster my-cluster-1 on this machine? yes
53+
54+
Downloading cluster config
55+
Registered sdf worker: my-cluster-1
56+
Switched to new profile: my-cluster-1
57+
```
58+
59+
## `fluvio cloud org invite`
60+
```bash
61+
$ fluvio cloud org invite
62+
Invitations to join a new organization
63+
64+
Usage: fluvio-cloud org invite <COMMAND>
65+
66+
Commands:
67+
accept Accept an invite
68+
reject Reject an invite
69+
help Print this message or the help of the given subcommand(s)
70+
```
71+
72+
## `fluvio cloud org invite accept`
73+
```bash
74+
$ fluvio cloud org invite accept -h
75+
Accept an invite
76+
77+
Usage: fluvio-cloud org invite accept <INVITE_CODE>
78+
79+
Arguments:
80+
<INVITE_CODE> code of the invite
81+
```
82+
83+
## `fluvio cloud org invite reject`
84+
```bash
85+
$ fluvio cloud org invite reject
86+
Reject an invite
87+
88+
Usage: fluvio-cloud org invite reject <INVITE_CODE>
89+
90+
Arguments:
91+
<INVITE_CODE> code of the invite
92+
```

‎docs/cloud/cli/overview.mdx

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,29 @@
11
---
22
sidebar_position: 1
3-
title: "Overview"
4-
description: "InfinyOn cloud CLI overview"
3+
title: Overview
4+
description: "InfinyOn Cloud CLI overview"
55
---
66

77
The InfinyOn cloud provides management via the CLI via the `fluvio cloud` set of commands.
88
`fluvio cloud` is part of the overall [Fluvio CLI].
99

1010
The commands include the following.
1111

12+
- [`fluvio cloud login`]
1213
- [`fluvio cloud cluster`]
1314
- [`fluvio cloud connector`]
14-
- [`fluvio cloud secret`]
15-
- [`fluvio cloud usage`]
1615
- [`fluvio cloud webhook`]
16+
- [`fluvio cloud secret`]
17+
- [`fluvio cloud remote`]
18+
- [`fluvio cloud org`]
19+
- [`fluvio cloud admin org`]
1720

1821
[Fluvio CLI]: fluvio/cli/overview.mdx
22+
[`fluvio cloud login`]: login.mdx
1923
[`fluvio cloud cluster`]: cluster.mdx
2024
[`fluvio cloud connector`]: connector.mdx
21-
[`fluvio cloud secret`]: secret.mdx
22-
[`fluvio cloud usage`]: usage.mdx
2325
[`fluvio cloud webhook`]: webhook.mdx
26+
[`fluvio cloud secret`]: secret.mdx
27+
[`fluvio cloud remote`]: remote.mdx
28+
[`fluvio cloud org`]: org.mdx
29+
[`fluvio cloud admin org`]: admin-org.mdx

‎docs/cloud/cli/remote.mdx

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
sidebar_position: 70
3+
title: remote
4+
description: "CLI commands for cloud mirroring"
5+
---
6+
7+
The `fluvio cloud remote export` command is used to generate metadata to set up mirroring with an external cluster.
8+
9+
```bash
10+
$ fluvio cloud remote export -h
11+
12+
Usage: fluvio-cloud remote export [OPTIONS] <REMOTE>
13+
14+
Arguments:
15+
<REMOTE>
16+
17+
Options:
18+
--file <FILE>
19+
```

‎docs/cloud/cli/secret.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2+
sidebar_position: 50
23
title: secret
3-
weight: 102
4-
description: "CLI commands for secrets management."
4+
description: "CLI commands for secrets management"
55
---
66

77
Fluvio cloud secrets are set via the CLI. Each secret is a named value with all secrets sharing a namespace per account. Connector configuration files can refer to secrets by name, and the cloud connector infrastructure will provision the connector with the named secrets.

‎docs/cloud/cli/usage.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2+
sidebar_position: 60
23
title: usage
3-
weight: 103
4-
description: "CLI commands to check your cluster usage status."
4+
description: "CLI commands to check your cluster usage status"
55
---
66

77
Query the CPU and memory usage of your SPUs.

‎docs/cloud/cli/webhook.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2+
sidebar_position: 40
23
title: webhook
3-
weight: 100
4-
description: "CLI commands for webhook operations."
4+
description: "CLI commands for webhook operations"
55
---
66

77
The `fluvio cloud webhook` family of commands is used to create, delete, and troubleshoot Webhooks in cloud.

0 commit comments

Comments
 (0)