Skip to content

Commit 3c24b68

Browse files
authored
docs: update quickstart (#1627)
Signed-off-by: Miguel Martinez <[email protected]>
1 parent e1b9dc5 commit 3c24b68

File tree

4 files changed

+23
-5
lines changed

4 files changed

+23
-5
lines changed

docs/docs/getting-started/installation.md renamed to docs/docs/getting-started/installation.mdx

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ title: Installation
66
import Image from "@theme/IdealImage";
77
import Tabs from "@theme/Tabs";
88
import TabItem from "@theme/TabItem";
9+
import EarlyAccess from "../partials/_early-access-callout.mdx";
910

1011
Chainloop is comprised of two main components
1112

@@ -64,9 +65,9 @@ cd chainloop && make -C app/cli build
6465
</TabItem>
6566
</Tabs>
6667

67-
## Deploy Chainloop
68+
## Deploy Chainloop Server components
6869

69-
**To run a Chainloop instance** on your Kubernetes cluster follow [these instructions](/guides/deployment/k8s).
70+
<EarlyAccess />
7071

7172
## Configure CLI
7273

@@ -88,6 +89,13 @@ Authenticate to the Control Plane by running
8889
$ chainloop auth login
8990
```
9091

92+
Once logged in, your next step would be to create a Chainloop organization. Think of organizations as workspaces or namespaces.
93+
94+
```bash
95+
$ chainloop organization create --name my-organization
96+
# INF Organization "my-organization" created!
97+
```
98+
9199
That's all!
92100

93101
Welcome to Chainloop!
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
:::info
2+
By default, the Chainloop CLI comes pre-configured to talk to Chainloop's platform instance, which is currently on early access. To get an account, please request access [here](https://app.chainloop.dev/request-access), and we'll get back to you shortly.
3+
4+
Alternatively, you can run your instance of Chainloop through our labs [docker-compose setup](https://github.com/chainloop-dev/chainloop/tree/main/devel#labs-environments) or in Kubernetes following [this guide](/guides/deployment/k8s/).
5+
:::
Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,14 @@ sidebar_position: 3
33
title: Quickstart
44
---
55

6+
import EarlyAccess from "./partials/_early-access-callout.mdx";
7+
68
# Quickstart
79

810
This quickstart will guide you through the process of installing the Chainloop CLI and performing your first attestation.
911

12+
<EarlyAccess />
13+
1014
1. Install CLI by running:
1115

1216
```bash
@@ -20,10 +24,11 @@ This quickstart will guide you through the process of installing the Chainloop C
2024
chainloop auth login
2125
```
2226

23-
Once logged in and will have access to any operation with the controlplane, like for example inspecting your organization
27+
Once logged in, your next step would be to create a Chainloop organization. Think of organizations as workspaces or namespaces. To create an organization with a random suffix, run:
2428

2529
```bash
26-
chainloop organization describe
30+
chainloop organization create --name quickstart-$((RANDOM % 90000 + 10000))
31+
# INF Organization "quickstart-10122" created!
2732
```
2833

2934
3. Create API Token to perform the attestation process:

docs/docs/reference/attestations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ INF push completed
246246
Attestation Digest: sha256:8a0b3a9db0372fdf571dbe85c8a9b5202f473ca97e9dbcdf77c3f9b423ea3b9c
247247
```
248248

249-
Contract-less and auto-discovery and two features that walk hand by hand. They compose a new way of adding pieces of evidences to an existing contract in a frictionless way. You can see it in action in our [quickstart](../quickstart.md) guide.
249+
Contract-less and auto-discovery and two features that walk hand by hand. They compose a new way of adding pieces of evidences to an existing contract in a frictionless way. You can see it in action in our [quickstart](../quickstart.mdx) guide.
250250

251251
## Remote State
252252

0 commit comments

Comments
 (0)