Backport docs (#2334)

* Adds docs for Teams shared secrets (#2317)

* Adds docs for Teams shared secrets

* Mentions a shared secret can be added from a notebook

* Reorder groups in docs sidebar

* Docs for shared file storages (#2318)
This commit is contained in:
Hugo Baraúna 2023-11-10 13:05:11 -03:00 committed by GitHub
parent bb1cb42abd
commit e9022d600f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 71 additions and 1 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 102 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 69 KiB

View file

@ -0,0 +1,11 @@
# Intro to Livebook Teams
[Livebook Teams](https://livebook.dev/teams/?ref=docs) is a product that amplifies Livebook with features designed for teams and businesses.
It's currently in free beta. You can [join the beta waiting list here](https://livebook.dev/teams/?ref=docs) to get early access.
## Current features in the beta
- [Shared secrets management](shared_secrets.md)
- [Shared file storages](shared_file_storages.md)
- [Airgapped notebook deployment with Zero Trust Authentication](../deployment/docker.md#deploy-notebooks-as-applications)

View file

@ -0,0 +1,25 @@
# Shared file storages
## Overview
This feature allows your team to share the configuration of S3-compatible storages.
Livebook file storages are used to store notebooks and their files.
Whenever you add (update or detach) a file storage to your organization hub, Livebook Teams will synchronize that with the Livebook of every member of your organization.
![](assets/add_shared_file_storage.png)
## How it works
Here's a video showing how that feature works.
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/NkrTHShRCYE?si=9LhjlER91nyEbZxi" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
## Security strengths
Livebook Teams cannot access the credentials of your S3 (compatible) account.
Livebook encrypts your S3 credentials locally in your machine using your Teams key. Then, they're sent encrypted to Livebook Teams servers.
When a new synchronization is needed, Livebook Teams sends the encrypted credentials to the Livebook of team members, and their Livebook decrypts that in their local machines using the same Teams key.

View file

@ -0,0 +1,29 @@
# Shared secrets management
## Overview
This feature allows your team to share Livebook secrets among team members in an easy way.
Just add a secret to your organization hub, and Livebook Teams will synchronize it with the Livebook of every member of your organization.
![](assets/add_shared_secret.png)
You can also create such secrets directly from a notebook.
![](assets/add_shared_secret_from_notebook.png)
Shared secrets updates and deletions will also be synchronized.
## How it works
Here's a video showing how that feature works.
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/GENSmArO1AI?si=pvMJt1Ihr5UBCkPP" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
## Security strengths
Livebook Teams cannot access the plain text version of your organization's secrets.
Livebook encrypts your secrets locally in your machine using your Teams key. Then, the secret is sent encrypted to Livebook Teams servers.
When a new synchronization is needed, Livebook Teams sends the encrypted secret to the Livebook of team members, and their Livebook decrypts the secret in their local machines using the same Teams key.

View file

@ -194,7 +194,9 @@ defmodule Livebook.MixProject do
extra_section: "Guides",
extras: extras(),
filter_modules: fn mod, _ -> mod in [Livebook] end,
assets: Path.expand("./docs/images"),
groups_for_extras: [
"Livebook Teams": Path.wildcard("docs/teams/*"),
Deployment: Path.wildcard("docs/deployment/*")
]
]
@ -207,7 +209,10 @@ defmodule Livebook.MixProject do
"docs/deployment/docker.md",
"docs/deployment/cloudflare.md",
"docs/deployment/google_iap.md",
"docs/deployment/tailscale.md"
"docs/deployment/tailscale.md",
"docs/teams/intro_to_teams.md",
"docs/teams/shared_secrets.md",
"docs/teams/shared_file_storages.md"
]
end
end