Skip to content

Commit dbf559c

Browse files
KiraLempereur-SpaceliftKiraLempereur-Spacelift
authored
Update Run and Intent docs (#1032)
* Update Run and Intent documentation Overall improvements to Run and Intent documentation for flow, clarity, and formatting. * Update run state list Turned list into a table to include whether each state is terminal and/or passive * Update run-promotion.md
1 parent 0c690b8 commit dbf559c

13 files changed

+600
-673
lines changed

‎docs/concepts/intent/README.md‎

Lines changed: 163 additions & 206 deletions
Large diffs are not rendered by default.

‎docs/concepts/intent/handy-commands-and-prompts.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# Handy Commands & Prompts
1+
# Handy commands & prompts
22

3-
**Add MCP server (CLI):**
3+
## Add MCP server (CLI)
44

55
```bash
66
claude mcp add intent-mcp -t http https://<account-name>.app.spacelift.io/intent/mcp
77
```
88

9-
**Auth & status:**
9+
## Auth & status
1010

1111
- `/mcp` → select **intent-mcp** → log in → verify **connected**
1212

13-
**Project management (via prompts):**
13+
## Project management (via prompts)
1414

1515
```text
1616
Create a project called "my-project".
@@ -19,7 +19,7 @@ List my projects and their lock status.
1919
Unlock the current project.
2020
```
2121

22-
**Resources (via prompts):**
22+
## Resources (via prompts)
2323

2424
```text
2525
Create two resources — one very long random string and a cute pet.
@@ -29,7 +29,7 @@ List resources in this project.
2929
Delete the random resources we created earlier.
3030
```
3131

32-
**Import (via prompts):**
32+
## Import (via prompts)
3333

3434
```text
3535
List SSM parameters in my account and import them into the project.

‎docs/concepts/intent/setting-up-azure-and-gcp-credentials.md‎

Lines changed: 60 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,84 @@
11
# Setting up Azure and GCP credentials for Spacelift Intent
22

3-
## Azure credencials
3+
## Azure credentials
44

5-
- Get tenant id:
5+
1. Get your tenant id.
66

7-
```jsx
8-
$ az account show --query 'tenantId'`
9-
"<YOUR-TENANT-ID>"
10-
```
7+
```jsx
8+
$ az account show --query 'tenantId'`
9+
"<YOUR-TENANT-ID>"
10+
```
1111

12-
- Get subscription id:
12+
2. Get your subscription id.
1313

14-
```jsx
15-
$ az account subscription list --query '[].{name:displayName,id:id}'
16-
[ ... , { "id": "<YOUR-SUBSCRIPTION-ID>", "name": "..." }, ... ]
17-
```
14+
```jsx
15+
$ az account subscription list --query '[].{name:displayName,id:id}'
16+
[ ... , { "id": "<YOUR-SUBSCRIPTION-ID>", "name": "..." }, ... ]
17+
```
1818

19-
- Optionally - create a role (role.json):
19+
3. Optionally, create a role (role.json).
2020

21-
```jsx
22-
{
23-
"Name": "example-role”,
24-
"IsCustom": true,
25-
"Description": "example-role",
26-
"Actions": [
27-
"Microsoft.Resources/subscriptions/<ACTIONS…>"
28-
],
29-
"NotActions": [],
30-
"DataActions": [],
31-
"NotDataActions": [],
32-
"AssignableScopes": [
33-
"/subscriptions/<YOUR-SUBSCRIPTION-ID>"
34-
]
35-
}
21+
```jsx
22+
{
23+
"Name": "example-role”,
24+
"IsCustom": true,
25+
"Description": "example-role",
26+
"Actions": [
27+
"Microsoft.Resources/subscriptions/<ACTIONS…>"
28+
],
29+
"NotActions": [],
30+
"DataActions": [],
31+
"NotDataActions": [],
32+
"AssignableScopes": [
33+
"/subscriptions/<YOUR-SUBSCRIPTION-ID>"
34+
]
35+
}
3636
37-
$ az role definition create --role-definition role.json
38-
```
37+
$ az role definition create --role-definition role.json
38+
```
3939

40-
- Create service principal:
40+
4. Create a service principal.
4141

42-
```jsx
43-
$ az ad sp create-for-rbac --name "example-name" --role "example-role" --scopes "/subscriptions/<YOUR-SUBSCRIPTION-ID>"
44-
{
45-
"appId": "<YOUR-CLIENT-ID>",
46-
"displayName": "example-name",
47-
"password": "<YOUR-CLIENT-PASSWORD>",
48-
"tenant": "<YOUR-TENANT-ID>"
49-
}
50-
```
42+
```jsx
43+
$ az ad sp create-for-rbac --name "example-name" --role "example-role" --scopes "/subscriptions/<YOUR-SUBSCRIPTION-ID>"
44+
{
45+
"appId": "<YOUR-CLIENT-ID>",
46+
"displayName": "example-name",
47+
"password": "<YOUR-CLIENT-PASSWORD>",
48+
"tenant": "<YOUR-TENANT-ID>"
49+
}
50+
```
5151

52-
- Get client id and client password from above and setup env vars:
52+
5. Get client id and client password from above and setup env vars.
5353

54-
```jsx
55-
ARM_CLIENT_ID="<YOUR-CLIENT-ID>"
56-
ARM_CLIENT_SECRET="<YOUR-CLIENT-PASSWORD>"
57-
ARM_TENANT_ID="<YOUR-TENANT-ID>"
58-
ARM_SUBSCRIPTION_ID="<YOUR-SUBSCRIPTION-ID>"
59-
```
54+
```jsx
55+
ARM_CLIENT_ID="<YOUR-CLIENT-ID>"
56+
ARM_CLIENT_SECRET="<YOUR-CLIENT-PASSWORD>"
57+
ARM_TENANT_ID="<YOUR-TENANT-ID>"
58+
ARM_SUBSCRIPTION_ID="<YOUR-SUBSCRIPTION-ID>"
59+
```
6060

61-
![Azure environment setup](../../assets/screenshots/spacelift-intent/setting-up-azure-and-gpc/Screenshot_2025-10-22_at_13.48.03.png)
61+
![Azure environment setup](<../../assets/screenshots/spacelift-intent/setting-up-azure-and-gpc/Screenshot_2025-10-22_at_13.48.03.png>)
6262

63-
## Google credencials
63+
## Google credentials
6464

65-
We need to follow [docs](../../getting-started/integrate-cloud/GCP.md) - with slightly change (file path to `spacelift.oidc` and `gcp.json`):
65+
Configuring Google credentials for Intent follows the same steps as [setting up GCP](../../getting-started/integrate-cloud/GCP.md) for Spacelift, with only a slight change to the file paths for `spacelift.oidc` and `gcp.json`.
6666

67-
![Spacelift docs on GCP](../../assets/screenshots/spacelift-intent/setting-up-azure-and-gpc/Screenshot_2025-10-22_at_13.55.08.png)
67+
![Spacelift docs on GCP](<../../assets/screenshots/spacelift-intent/setting-up-azure-and-gpc/Screenshot_2025-10-22_at_13.55.08.png>)
6868

69-
Setup OIDC file location (intent workspace is in `/app` instead of `/mnt/workspace`):
69+
1. When setting up the OIDC file location, use `/app/spacelift.oidc` instead of `/mnt/workspace/spacelift.oidc`.
7070

71-
![Spacelift docs on GCP](../../assets/screenshots/spacelift-intent/setting-up-azure-and-gpc/Screenshot_2025-10-22_at_13.50.34.png)
71+
![Spacelift docs on GCP](<../../assets/screenshots/spacelift-intent/setting-up-azure-and-gpc/Screenshot_2025-10-22_at_13.50.34.png>)
7272

73-
Setup JSON configuration (`/app` as well):
73+
2. When setting up the JSON configuration, use `/app/spacelift.oidc` as well.
7474

75-
![Spacelift docs on GCP](../../assets/screenshots/spacelift-intent/setting-up-azure-and-gpc/Screenshot_2025-10-22_at_13.52.29.png)
75+
![Spacelift docs on GCP](<../../assets/screenshots/spacelift-intent/setting-up-azure-and-gpc/Screenshot_2025-10-22_at_13.52.29.png>)
7676

77-
At the end we need:
77+
3. At the end we need:
7878

79-
- `GOOGLE_APPLICATION_CREDENCIALS=<pointing-to-JSON-configuration-file>`
80-
- `GOOGLE_PROJECT=<project name>` (optional)
81-
- `gcp.json` - JSON configuration file
82-
- `spacelift.oidc` will be automatically mounted.
79+
- `GOOGLE_APPLICATION_CREDENTIALS=<pointing-to-JSON-configuration-file>`.
80+
- `GOOGLE_PROJECT=<project name>` (optional).
81+
- `gcp.json` (JSON configuration file).
82+
- `spacelift.oidc` will be automatically mounted.
8383

84-
![GCP env configuration](../../assets/screenshots/spacelift-intent/setting-up-azure-and-gpc/Screenshot_2025-10-22_at_14.02.56.png)
84+
![GCP env configuration](<../../assets/screenshots/spacelift-intent/setting-up-azure-and-gpc/Screenshot_2025-10-22_at_14.02.56.png>)

0 commit comments

Comments
 (0)