Skip to content

Commit

Permalink
minor: Add Accounts & Billing section
Browse files Browse the repository at this point in the history
Signed-off-by: Vipul Gupta (@vipulgupta2048) <vipulgupta2048@gmail.com>
  • Loading branch information
vipulgupta2048 committed Jun 18, 2024
1 parent 962b39b commit b792e3e
Show file tree
Hide file tree
Showing 15 changed files with 105 additions and 94 deletions.
13 changes: 8 additions & 5 deletions config/navigation.txt
Original file line number Diff line number Diff line change
Expand Up @@ -60,19 +60,22 @@ Learn
[/learn/deploy/deploy-with-balena-button]

MANAGE
[/learn/manage/account]
[/learn/manage/organizations]
[/learn/manage/apps]
[/learn/manage/billing]
[/learn/manage/fleet-types]
[/learn/manage/device-statuses]
[/learn/manage/filters-tags]
[/learn/manage/ssh-access]
[/learn/manage/device-logs]
[/learn/manage/configuration]
[/learn/manage/variables]
[/learn/manage/actions]
[/learn/manage/support-access]

ACCOUNTS & BILLING
[/learn/accounts/account]
[/learn/accounts/organizations]
[/learn/accounts/billing]
[/learn/accounts/fleet-types]
[/learn/accounts/fleet-members]
[/learn/accounts/support-access]

MORE RESOURCES
[/learn/more/examples/labs-projects]
Expand Down
4 changes: 2 additions & 2 deletions config/redirects.txt
Original file line number Diff line number Diff line change
Expand Up @@ -224,8 +224,8 @@
/reference/api/resources/application /reference/api/resources/fleet/
/learn/manage/app-types/ /learn/manage/fleet-types/
/learn/manage/app-types /learn/manage/fleet-types/
/learn/welcome/support/ /learn/manage/support-access/ 301
/learn/welcome/support /learn/manage/support-access/ 301
/learn/welcome/support/ /learn/accounts/support-access/ 301
/learn/welcome/support /learn/accounts/support-access/ 301
/learn/welcome/core-concepts/ /learn/more/glossary/ 301
/learn/welcome/core-concepts /learn/more/glossary/ 301
/learn/welcome/glossary/ /learn/more/glossary/ 301
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,60 +56,8 @@ API keys can also be generated using the API, [CLI][cli-keys], and [Node.js][nod

## Fleet members

When a fleet needs to be shared with more than one user, the fleet owner can add new members. With paid accounts, it's possible to assign a level of access for a new member, based on the following types:
When a fleet needs to be shared with more than one user, the fleet owner can add new members. Checkout out [team management][team] in BalenaCloud to understand member types, how to add a member and more.

### Member types

| Member Type | [Add members][administrator] | Delete App | Add/Remove device | Manage provisioning keys | [Device specific actions][device-actions] | [Tags][tags] | [Variables][variables] | [SSH access][ssh] | [Push][deploy] | [Configuration][configuration] | [Fleet specific actions][fleet-actions] |
| ------------- |:-------------:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:|
| Administrator | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Developer | No | No | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Operator | No | No | Yes | Yes | Yes | Yes | Yes | Yes | No | No | No |
| Observer | No | No | No | No | No | No | No | No | No | No | No |

#### Administrator

A new fleet in balenaCloud can only be created by an [administrator][administrator] of an organization. Administrators are the only users who can add other fleet members or delete the fleet. Learn more about the [administrator role][administrator] in an organization.

#### Observer

Observers are given read-only access to the fleet and its devices. They are not able to modify, add, or remove any devices, nor are they able to perform device actions. This role can only be assigned by fleet owners on paid plans.

#### Operator

Operators have all the access given to observers, plus the ability to manage a fleet's devices. This means operators can add and remove devices, generate & revoke provisioning API keys, perform device actions, and modify device tags, metadata, and environment variables. Operators also have full [SSH access][ssh] to the fleet's devices. This role can only be assigned by fleet owners on paid plans.

#### Developer

Developers are given, in addition to the access provided to operators, the ability to manage fleet software. This includes creating new releases, modifying fleet variables, and downloading balenaOS images. This role is the closest to a fleet owner—developers can do everything owners can except for deleting the fleet or adding new members. The Developer role can be assigned by fleet owners on free or paid accounts.

### Add a fleet member

To add a new member to your fleet, click on the *Members* tab of the fleet:

<img alt="Members Tab" src="/img/common/app/members_tab.png" width="15%">

This brings up a list of all fleet members, if any have been assigned. Click on the *Add member* button in the top left:

<img alt="Create Application Member" src="/img/common/app/add_member.png" width="100%">

The *Add member* dialog has a dropdown with descriptions of the member types, as well as information about which types are available based on your billing plan. Choose a level of access, then enter the username or email address of the new member:

<img alt="Add Application Member" src="/img/common/app/member_dialog.png" width="60%">

__Note:__ Fleet members must have already [signed up][signup] for a {{ $names.company.lower }} account before they can be added to a fleet.

After you click *Add*, you will see the username of the new member in the list. From here, you can edit access levels or remove the user if necessary:

<img alt="List Application Members" src="/img/common/app/member_list.png" width="100%">

All users that have been added to a fleet will see that fleet in their dashboard, with an indicator to designate it has been shared by the fleet owner:

<img alt="Shared Application" src="/img/common/app/shared_app.png" width="40%">

Fleet members will have the option to remove themselves from a fleet by clicking on the members tab, selecting the checkbox by their name from the member list, clicking on the *Modify* button, and selecting *delete member*.

__Warning:__ If you remove your member access to a fleet, you will not be able to undo the action. Only the fleet owner will be able to restore your access.

## Two-factor Authentication

Expand Down Expand Up @@ -165,15 +113,6 @@ If you wish to delete your {{ $names.cloud.lower }} account, go to your [_Prefer

![Delete {{ $names.company.lower }} Account](/img/screenshots/delete-balena-account.png)

[ssh]:/learn/manage/ssh-access
[administrator]: /learn/manage/organizations/#managing-roles--access-in-an-organization
[device-actions]:/learn/manage/actions
[fleet-actions]:/learn/manage/actions/#fleet-specific-actions
[variables]:/learn/manage/serv-vars/
[configuration]:/learn/manage/configuration/
[deploy]:/learn/deploy/deployment/
[tags]:/learn/manage/filters-tags/

[signup]:{{ $links.dashboardUrl }}/signup
[login]:{{ $links.dashboardUrl }}/login
[prefs]:{{ $links.dashboardUrl }}/preferences?tab=details
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,6 @@ Users can determine which invoices are overdue under their organization's billin
[plans]:{{ $links.mainSiteUrl }}/pricing/
[device-settings]:/learn/manage/actions/#device-settings
[inactive]:#inactive-devices
[organizations]:/learn/manage/organizations/
[fleet-membership-types]: /learn/manage/account/#fleet-members
[fleet-types]:/learn/manage/fleet-types
[organizations]:/learn/accounts/organizations/
[fleet-membership-types]:/learn/accounts/fleet-members
[fleet-types]:/learn/accounts/fleet-types
69 changes: 69 additions & 0 deletions pages/learn/accounts/fleet-members.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# Fleet members

BalenaCloud offers the ability to collaborate with other users on the platform by inviting members to your fleets, apps or blocks and assigning them a varying degree of access as per your requirement using Member types. To invite members to your organization, refer to [organization management][organization-management].

When a fleet needs to be shared with more than one user, the fleet owner can add new members. With paid accounts, it's possible to assign a level of access for a new member, based on the following types:

### Member types

| Member Type | [Add members][administrator] | Delete App | Add/Remove device | Manage provisioning keys | [Device specific actions][device-actions] | [Tags][tags] | [Variables][variables] | [SSH access][ssh] | [Push][deploy] | [Configuration][configuration] | [Fleet specific actions][fleet-actions] |
| ------------- |:-------------:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:| ----:|
| Administrator | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Developer | No | No | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| Operator | No | No | Yes | Yes | Yes | Yes | Yes | Yes | No | No | No |
| Observer | No | No | No | No | No | No | No | No | No | No | No |

#### Administrator

A new fleet in balenaCloud can only be created by an [administrator][administrator] of an organization. Administrators are the only users who can add other fleet members or delete the fleet. Learn more about the [administrator role][administrator] in an organization.

#### Observer

Observers are given read-only access to the fleet and its devices. They are not able to modify, add, or remove any devices, nor are they able to perform device actions. This role can only be assigned by fleet owners on paid plans.

#### Operator

Operators have all the access given to observers, plus the ability to manage a fleet's devices. This means operators can add and remove devices, generate & revoke provisioning API keys, perform device actions, and modify device tags, metadata, and environment variables. Operators also have full [SSH access][ssh] to the fleet's devices. This role can only be assigned by fleet owners on paid plans.

#### Developer

Developers are given, in addition to the access provided to operators, the ability to manage fleet software. This includes creating new releases, modifying fleet variables, and downloading balenaOS images. This role is the closest to a fleet owner—developers can do everything owners can except for deleting the fleet or adding new members. The Developer role can be assigned by fleet owners on free or paid accounts.

### Add a fleet member

To add a new member to your fleet, click on the *Members* tab of the fleet:

<img alt="Members Tab" src="/img/common/app/members_tab.png" width="15%">

This brings up a list of all fleet members, if any have been assigned. Click on the *Add member* button in the top left:

<img alt="Create Application Member" src="/img/common/app/add_member.png" width="100%">

The *Add member* dialog has a dropdown with descriptions of the member types, as well as information about which types are available based on your billing plan. Choose a level of access, then enter the username or email address of the new member:

<img alt="Add Application Member" src="/img/common/app/member_dialog.png" width="60%">

__Note:__ Fleet members must have already [signed up][signup] for a {{ $names.company.lower }} account before they can be added to a fleet.

After you click *Add*, you will see the username of the new member in the list. From here, you can edit access levels or remove the user if necessary:

<img alt="List Application Members" src="/img/common/app/member_list.png" width="100%">

All users that have been added to a fleet will see that fleet in their dashboard, with an indicator to designate it has been shared by the fleet owner:

<img alt="Shared Application" src="/img/common/app/shared_app.png" width="40%">

Fleet members will have the option to remove themselves from a fleet by clicking on the members tab, selecting the checkbox by their name from the member list, clicking on the *Modify* button, and selecting *Delete member*.

__Warning:__ If you remove your member access to a fleet, you will not be able to undo the action. Only the fleet owner will be able to restore your access.

[ssh]:/learn/manage/ssh-access
[administrator]: /learn/accounts/organizations/#managing-roles--access-in-an-organization
[device-actions]:/learn/manage/actions
[fleet-actions]:/learn/manage/actions/#fleet-specific-actions
[variables]:/learn/manage/serv-vars/
[configuration]:/learn/manage/configuration/
[deploy]:/learn/deploy/deployment/
[tags]:/learn/manage/filters-tags/

[organization-management]:/learn/accounts/organizations/#granting-access-to-fleets
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ To collaborate with other users on a single fleet, you can refer to adding a [fl

[getting-started]:/installing/gettingStarted
[transferring-ownership]:/learn/manage/actions/#transfer-application-ownership
[developer]:/learn/manage/account/#developer
[observer]:/learn/manage/account/#observer
[operator]:/learn/manage/account/#operator
[add-fleet-member]:/learn/manage/account/#add-fleet-member
[developer]:/learn/accounts/fleet-members#developer
[observer]:/learn/accounts/fleet-members#observer
[operator]:/learn/accounts/fleet-members#operator
[add-fleet-member]:/learn/accounts/fleet-members#add-fleet-member
File renamed without changes.
4 changes: 2 additions & 2 deletions pages/learn/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ When it's finished building the device(s) will update as before. Remember anythi
**Enjoy balenafying all the things!**
[fleet-types]:/learn/manage/fleet-types
[fleet-types]:/learn/accounts/fleet-types
[architecture]:/reference/base-images/devicetypes/#machine-names-and-architectures
[balenablocks]:{{ $links.balenaHubUrl }}/blocks
[balenahub]:{{ $links.balenaHubUrl }}
Expand All @@ -278,7 +278,7 @@ When it's finished building the device(s) will update as before. Remember anythi
[support]:/support/
[supported-devices]:/reference/hardware/devices/
[terminal]:/learn/manage/ssh-access
[token]:/learn/manage/account/#access-tokens
[token]:/learn/accounts/#access-tokens
[variables]:/learn/manage/variables/
[balena-glossary]:/learn/more/glossary/
Expand Down
14 changes: 7 additions & 7 deletions pages/learn/manage/actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,12 +179,12 @@ __Info:__ If you have a device [preloaded][preload-devices] with an OS version l
[fleet-types]:/learn/manage/app-types
[persistent-storage]:/learn/develop/runtime/#persistent-storage
[purge-data]:#purge-data
[organization]:/learn/manage/organizations/
[administrator]:/learn/manage/organizations/#managing-roles--access-in-an-organization
[add-application-member]:/learn/manage/account/#add-an-application-member
[developer]:/learn/manage/account/#developer
[support-access]:/learn/manage/support-access
[inactive-devices]:/learn/manage/billing/#inactive-devices
[fleet-members]:/learn/manage/account/#fleet-members
[organization]:/learn/accounts/organizations/
[administrator]:/learn/accounts/organizations/#managing-roles--access-in-an-organization
[add-application-member]:/learn/accounts/#add-an-application-member
[developer]:/learn/accounts/fleet-members#developer
[support-access]:/learn/accounts/support-access
[inactive-devices]:/learn/accounts/billing/#inactive-devices
[fleet-members]:/learn/accounts/fleet-members
[docker-data-persistence-strategies]:https://docs.docker.com/storage/
[public-url]:/learn/develop/runtime/#public-device-urls
6 changes: 3 additions & 3 deletions pages/learn/manage/device-statuses.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ __Note:__ If the device is powered off or loses all network connectivity, it wil
If you find your device to be displaying a status which is unclear even with the above notes, visit the [device debugging masterclass][debugging-masterclass] for more information.


[deactivated]: /learn/manage/billing/#inactive-devices
[deactivated]: /learn/accounts/billing/#inactive-devices
[poll-interval]: /learn/manage/configuration/#variable-list
[device-provisioning]: /learn/welcome/primer/#device-provisioning
[preregistered]: /learn/more/masterclasses/advanced-cli/#52-preregistering-a-device
[fleet type]: /learn/manage/fleet-types
[preregistered]:/learn/more/masterclasses/advanced-cli/#52-preregistering-a-device
[fleet type]:/learn/accounts/fleet-types
[debugging-masterclass]:/learn/more/masterclasses/device-debugging
2 changes: 1 addition & 1 deletion pages/learn/more/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ A range of small form factor PCs from Intel.
### Organization (balena)
**(balena specific term)**
A group of members, teams, and fleets that is managed by one or more organization administrators.
[more](https://www.balena.io/docs/learn/manage/organizations/)
[more](https://www.balena.io/docs/learn/accounts/organizations/)

## P

Expand Down
2 changes: 1 addition & 1 deletion pages/learn/welcome/production-plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ For more information about common anti-patterns, see [Anti-patterns, or how to b
[local-mode]:/learn/develop/local-mode
[wifi-connect]:{{ $links.githubOS }}/wifi-connect
[supervisor-api]:/reference/supervisor/supervisor-api/#patch-v1-device-host-config
[collaborators]:/learn/manage/account/#fleet-members
[collaborators]:/learn/accounts/fleet-members
[ssh]:/learn/manage/ssh-access
[custom-logging]:{{ $links.blogSiteUrl }}/how-to-create-a-custom-logging-system-for-longer-log-retention/
[cli]:/reference/cli
Expand Down
4 changes: 2 additions & 2 deletions pages/reference/api/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,5 +115,5 @@ curl -X GET \
[odata]:https://www.odata.org/
[odata-docs]:https://www.odata.org/getting-started/basic-tutorial/
[resources]:/reference/api/resources/fleet
[tokens]:/learn/manage/account/#session-tokens
[api-keys]:/learn/manage/account/#api-keys
[tokens]:/learn/accounts/#session-tokens
[api-keys]:/learn/accounts/#api-keys
4 changes: 2 additions & 2 deletions tools/build-masterclass.sh
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ mkdir -p $masterclass_path
# Debugging Masterclass
mkdir -p $masterclass_path/debugging/ &

cd pages/learn/manage && $SCRIPT_DIR/extract-markdown.sh "Accessing your device" <support-access.md >access-device.md && mv access-device.md $masterclass_path/debugging/ &
cd pages/learn/accounts && $SCRIPT_DIR/extract-markdown.sh "Accessing your device" <support-access.md >access-device.md && mv access-device.md $masterclass_path/debugging/ &

cd pages/learn/manage && $SCRIPT_DIR/extract-markdown.sh "Granting Support Access to a Support Agent" <support-access.md >support-access-device.md && mv support-access-device.md $masterclass_path/debugging/ &
cd pages/learn/accounts && $SCRIPT_DIR/extract-markdown.sh "Granting Support Access to a Support Agent" <support-access.md >support-access-device.md && mv support-access-device.md $masterclass_path/debugging/ &

cd pages/faq/troubleshooting/ && $SCRIPT_DIR/extract-markdown.sh "Accessing a Device using a Gateway Device" <debugging-device-gateway.md >device-gateway-partial.md && mv device-gateway-partial.md $masterclass_path/debugging/ &

Expand Down

0 comments on commit b792e3e

Please sign in to comment.