Skip to content

Commit 295c654

Browse files
docs: Update docs for cloud modules (dagger#10293)
* docs: Update docs for cloud modules Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Updated text Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Update text Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Added steps and images Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Added missing image Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Apply suggestions from code review Co-authored-by: Matias Pan <gh@matiaspan.dev> Signed-off-by: vikram-dagger <112123850+vikram-dagger@users.noreply.github.com> * Updated text and images Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Updated images Signed-off-by: Vikram Vaswani <vikram@dagger.io> * Updated images Signed-off-by: Vikram Vaswani <vikram@dagger.io> --------- Signed-off-by: Vikram Vaswani <vikram@dagger.io> Signed-off-by: vikram-dagger <112123850+vikram-dagger@users.noreply.github.com> Co-authored-by: Matias Pan <gh@matiaspan.dev>
1 parent ac9380e commit 295c654

12 files changed

Lines changed: 88 additions & 9 deletions

docs/current_docs/configuration/cloud.mdx

Lines changed: 72 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,15 @@ Dagger Cloud requires a GitHub or Google account for identity verification. If y
1515
Dagger Cloud requires Dagger v0.11 or higher.
1616
:::
1717

18-
## Traces
18+
## Organizations
19+
20+
A Dagger Cloud "organization" refers to a group of member accounts linked to a single team.
21+
22+
A member account grants a person access to log in to a Dagger Cloud organization to diagnose workflow failures and collaborate on changes. Deleting a member of a Dagger Cloud organization will not remove their runs and changes from Dagger Cloud.
23+
24+
:::important
25+
You must hold the `Admin` role of a Dagger Cloud organization to administer members. You cannot change a member's role. Please contact Dagger Support via the in-app messenger for assistance if you need to change a member's role.
26+
:::
1927

2028
### Create a Dagger Cloud organization
2129

@@ -35,7 +43,7 @@ Dagger Cloud requires Dagger v0.11 or higher.
3543

3644
1. You will then enter your payment information. After your free 14 day trial completes, you will be automatically subscribed to the Dagger Cloud Team plan.
3745

38-
1. Click `Go to dashboard`. The next step walks you through how to send telemetry to Dagger Cloud.
46+
## Traces
3947

4048
### Connect to Dagger Cloud
4149

@@ -72,7 +80,7 @@ export DAGGER_CLOUD_TOKEN={your token}
7280

7381
To connect to Dagger Cloud from a CI environment, you require a Dagger Cloud token. Dagger Cloud creates this token automatically when you sign up.
7482

75-
To find your token, navigate to the organization settings page using the cogwheel icon in the top navigation bar. Under the `Tokens` sub-menu, click the eye icon to view the token. You can also use this URL pattern: `https://v3.dagger.cloud/{Your Org Name}/settings?tab=Tokens`
83+
To find your token, navigate to the settings page using the cogwheel icon in the top navigation bar. Under the `Tokens` sub-menu, click the eye icon to view the token. You can also use this URL pattern: `https://v3.dagger.cloud/{Your Org Name}/settings?tab=Tokens`
7684

7785
![Get token](/img/current_docs/configuration/get-token.png)
7886

@@ -200,16 +208,71 @@ Dagger Cloud automatically detects if the traces produced by your workflows orig
200208
a CI system and a public repository. When both conditions are met, Dagger Cloud allows
201209
public access to these traces without requiring an invitation to the organization.
202210

203-
To modify this default setting, navigate to the organization settings page using the cogwheel icon in the top navigation bar. Under the `Visibility` sub-menu, click the eye icon to toggle public access to trace data as needed.
211+
To modify this default setting, navigate to the organization page using the cogwheel icon in the top navigation bar. Under the `Visibility` sub-menu, click the eye icon to toggle public access to trace data as needed.
204212

205213
![public traces](/img/current_docs/api/public-traces.png)
206214

207-
## Organizations
215+
## Modules
208216

209-
A member account grants a person access to log in to a Dagger Cloud organization to diagnose workflow failures and collaborate on changes. Deleting a member of a Dagger Cloud organization will not remove their runs and changes from Dagger Cloud.
217+
Dagger Cloud lets you see all your organization's modules in one place, with metadata like engine versions, descriptions, and linked repositories. Module information and activity is automatically synced from GitHub.
210218

211-
:::important
212-
You must hold the `Admin` role of a Dagger Cloud organization to administer members. You cannot change a member's role. Please contact Dagger Support via the in-app messenger for assistance if you need to change a member's role. This functionality is coming soon.
219+
### Add modules
220+
221+
Dagger Cloud scans your specified repositories for Dagger modules, showing them automatically in Dagger Cloud.
222+
223+
:::info
224+
You must be signed in to Dagger Cloud with GitHub.
225+
:::
226+
227+
To initiate this process, navigate to the organization page using the cogwheel icon in the top navigation bar and select the `Git Sources` sub-menu. Click `Install the GitHub Application` to add a GitHub account or organization.
228+
229+
![Module repository setup](/img/current_docs/configuration/cloud-modules-target.png)
230+
231+
You will be directed to install the Dagger Cloud GitHub application and select the GitHub accounts and repositories to add.
232+
233+
![Module repository setup](/img/current_docs/configuration/cloud-modules-install-app.png)
234+
235+
Complete the process and then, once the GitHub account or organization appears in the Dagger Cloud user interface, click `Enable module scanning` to have Dagger Cloud begin scanning for Dagger modules. You can enable module scanning for multiple GitHub organizations. Each one can be enabled on a single Dagger organization.
236+
237+
![Module repository setup](/img/current_docs/configuration/cloud-modules-map.png)
238+
239+
The `Scan Results` section at the bottom of the page maintains a record of scans and their status.
240+
241+
![Module scans](/img/current_docs/configuration/cloud-modules-scans.png)
242+
243+
### Manage and inspect modules
244+
245+
Once your modules have been added, you can start using Dagger Cloud to manage them.
246+
247+
Access the modules dashboard from the `Modules` menu item in the top navigation bar to see a list of available modules.
248+
249+
![Module list](/img/current_docs/configuration/cloud-modules-list.png)
250+
251+
You can view your entire list of modules by selecting the `All Modules` tab. If you wish to curate and organize this list, you can create custom views of modules filtered by team, service, or domain. To create a custom view, click the `+` icon.
252+
253+
![Module filter](/img/current_docs/configuration/cloud-modules-filter.png)
254+
255+
Select a module to see detailed information on its activity and API.
256+
257+
- API: View detailed API documentation for each module, including its installation command, functions, arguments and return values
258+
259+
![Module API](/img/current_docs/configuration/cloud-modules-api.png)
260+
261+
- Activity: See a list of commits, sorted by date
262+
263+
![Module activity](/img/current_docs/configuration/cloud-modules-activity.png)
264+
265+
- Dependencies and dependents: Trace dependencies and dependents of your module
266+
267+
![Module dependencies](/img/current_docs/configuration/cloud-modules-deps.png)
268+
269+
- Traces: List traces triggered by a module
270+
271+
![Module traces](/img/current_docs/configuration/cloud-modules-traces.png)
272+
273+
274+
:::tip
275+
This information is available for all versions of the module; use the version selector in the top bar to switch between versions.
213276
:::
214277

215278
## Roles and permissions
@@ -227,6 +290,6 @@ You cannot change a member's role at this time. Please contact Dagger via the su
227290

228291
## Cache pruning
229292

230-
Within a Dagger Cloud organization, it is possible to prune the Dagger Cloud cache for a specific token. Navigate to the organization settings page using the cogwheel icon in the top navigation bar, select the `Tokens` sub-menu, and click the broom icon for the corresponding token.
293+
Within a Dagger Cloud organization, it is possible to prune the Dagger Cloud cache for a specific token. Navigate to the organization page using the cogwheel icon in the top navigation bar, select the `Tokens` sub-menu, and click the broom icon for the corresponding token.
231294

232295
![Get token](/img/current_docs/configuration/prune-cache.png)

docs/current_docs/features/modules.mdx

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,21 @@ async def ci(self, source: dagger.Directory) -> str:
4242
return await dag.trivy().scan_container(dag.container().from_(ref))
4343
```
4444

45+
## Dagger Cloud
46+
47+
Modules integrate seamlessly with Dagger Cloud, which offers a collaborative environment to manage modules, visualize dependencies, and trace executions.
48+
49+
- A dedicated "Modules" tab in Dagger Cloud: See all your organization’s modules in one place, with metadata like engine versions, descriptions, and linked repositories, automatically pulled and synced from GitHub.
50+
- Views for better organization: Create filtered views of modules by team, service, or domain.
51+
- Documentation: See API documentation for each module and version, directly in the Dagger Cloud dashboard.
52+
- Version-aware navigation: View active branches and tags, ordered by recency.
53+
- Supply chain visibility: See exactly which modules your code depends on, and which depend on yours. This upstream/downstream awareness helps eliminate breakage and fosters stronger collaboration between teams.
54+
- Trace-to-module linkage: Trace failed runs or AI workflows back to the exact module versions that caused them.
55+
56+
![Module list](/img/current_docs/configuration/cloud-modules-list.png)
57+
58+
## The Daggerverse
59+
4560
To make it easier to search and consume Dagger modules, the [Daggerverse](https://daggerverse.dev) is a free service run by Dagger, which indexes all publicly available Dagger modules. These might be Dagger modules developed by your team, your organization or the broader Dagger community. By importing and reusing these Dagger modules in your workflows and across your teams, you can significantly speed up development.
4661

4762
## Learn more
@@ -50,4 +65,5 @@ To make it easier to search and consume Dagger modules, the [Daggerverse](https:
5065
- [Call a remote module](../api/remote-modules.mdx)
5166
- [Understand module structure](../api/module-structure.mdx)
5267
- [Publish a module](../api/daggerverse.mdx)
68+
- [Use modules in Dagger Cloud](../configuration/cloud.mdx#modules)
5369
- [Find modules in the Daggerverse](https://daggerverse.dev)
109 KB
Loading
196 KB
Loading
182 KB
Loading
30.4 KB
Loading
76.7 KB
Loading
220 KB
Loading
170 KB
Loading
27.9 KB
Loading

0 commit comments

Comments
 (0)