Skip to content

Commit 8a51006

Browse files
authored
feat: org how-to-collab (#323)
1 parent 0df8079 commit 8a51006

File tree

1 file changed

+96
-0
lines changed

1 file changed

+96
-0
lines changed
Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
---
2+
title: "Collaborate using Organizations"
3+
description: "A short guide on colaboration using organizations"
4+
sidebar_position: 4
5+
---
6+
7+
Organizations allow teams to collaborate by sharing access to clusters and private hub packages.
8+
9+
The user that creates an organziaton becomes its owner and all invited users are considered members. Cluster creation/deletion and user management is limited to the owner.
10+
Members have permission to perform all other operations.
11+
12+
At the moment access control within an organization is not configurable.
13+
Therefore, in cases where you need to segment access to resources, we recommend that you create an organization per segment.
14+
15+
Members of an organization may publish InfinyOn Hub packages to be made availabile to the organization.
16+
Any private packages published to this organization will be available to all of its clusters and users.
17+
18+
### Create an organization
19+
20+
The `fluvio cloud admin org create` command will walk you though creating an org and creating its first cluster.
21+
22+
```bash
23+
$ fluvio cloud admin org create --name my-org --display-name MyOrganization
24+
Created organization: MyOrganization (my-org)
25+
26+
? Would you like to select the newly created organization? Yes
27+
28+
? This organization has no clusters yet. Would you like to create one? Yes
29+
30+
? Would you like auto-generate a name for this cluster? Yes
31+
32+
Creating cluster...
33+
Starting unified-platypus... Done!
34+
Downloading cluster config
35+
Registered sdf worker: unified-platypus
36+
Switched to new profile: unified-platypus
37+
```
38+
39+
### Invite teammates
40+
41+
The invited teammate will have access to the new cluster created in your organization.
42+
43+
```bash
44+
$ fluvio cloud admin org user invite my.first.teammate@example.com
45+
46+
An email has been sent to the user my.first.teammate@example.com with an invite code.
47+
You can also provide the invite code to the user manually.
48+
49+
Invite code: RBDSPL3RLNIKBI4JQRFKOSAG7R6RK35V
50+
```
51+
52+
You may continue adding additional teammates using this command.
53+
54+
55+
### Accepting an invite and joining the organization
56+
57+
As the person being invited to join, you will receive an email with an invitation code.
58+
If you do not already have an [InfinyOn Cloud] user account you will be prompted to create one.
59+
60+
Log in with the [Cloud CLI]
61+
62+
```bash
63+
$ fluvio cloud login
64+
Infinyon Cloud email: my.first.teammate@example.com
65+
Password: **********
66+
67+
Logged in successfully as Teammate 1 (my.first.teammate@example.com)
68+
```
69+
70+
Accept the invitation using the code from the organization owner
71+
```
72+
$ fluvio cloud org invite accept P2Z4EDA6G2ETE7IFNZP75F6GC7A4H3EY
73+
You have successfully joined to the MyOrganization (my-org) organization
74+
```
75+
76+
Select the newly join organization to use the shared cluster
77+
```
78+
$ fluvio cloud org select my-org
79+
Selected organization: MyOrganization (my-org).
80+
Cluster actions will be performed in this organization.
81+
82+
This organization has the following clusters:
83+
ID ACTIVE STATE VERSION SPU_COUNT
84+
unified-platypus true Installed 0.14.0 1
85+
86+
? Would you like to use cluster unified-platypus on this machine? Yes
87+
88+
Downloading cluster config
89+
Registered sdf worker: unified-platypus
90+
Switched to new profile: unified-platypus
91+
```
92+
93+
The Fluvio profile is now loaded on to the teammate's machine and can be used by the Fluvio CLI and other Fluvio client applications.
94+
95+
[InfinyOn Cloud]: https://infinyon.cloud
96+
[Cloud CLI]: cloud/cli/overview.mdx

0 commit comments

Comments
 (0)