Skip to content

Commit acc37ce

Browse files
committed
doc(apple-silicon): add runner ressource
1 parent d9e5de0 commit acc37ce

File tree

3 files changed

+87
-248
lines changed

3 files changed

+87
-248
lines changed
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
subcategory: "Apple Silicon"
3+
page_title: "Scaleway: scaleway_apple_silicon_runner"
4+
---
5+
6+
# Resource: scaleway_apple_silicon_runner
7+
8+
Creates and manages Scaleway Apple silicon runners.
9+
10+
## Example Usage
11+
12+
```terraform
13+
resource "scaleway_apple_silicon_runner" "main" {
14+
name = "my-github-runner"
15+
ci_provider = "github"
16+
url = "https://github.com/my-org/my-repo"
17+
token = "my-token"
18+
labels = ["updated"]
19+
}
20+
```
21+
22+
## Argument Reference
23+
24+
- `ci_provider` - (Required) The CI/CD provider for the runner. Must be either 'github' or 'gitlab'
25+
- `token` - (Required) The token used to authenticate the runner to run
26+
- `url` - (Required) The URL of the runner to run
27+
- `labels` - (Optional) A list of labels that should be applied to the runner. Only for github provider
28+
- `name` - (Optional) The name of the runner
29+
- `project_id` - (Optional) The project_id you want to attach the resource to
30+
- `zone` - (Optional) The zone of the runner
31+
32+
## Attributes Reference
33+
34+
- `id` - The ID of the runner.
35+
- `status` - The status of the runner
36+
37+
## Import
38+
39+
Runner can be imported using the `{zone}/{id}`, e.g.
40+
41+
```bash
42+
terraform import scaleway_apple_silicon_runner.main fr-par-1/11111111-1111-1111-1111-111111111111
43+
```

internal/services/applesilicon/testdata/runner-basic-github.cassette.yaml

Lines changed: 0 additions & 248 deletions
This file was deleted.
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
{{- /*gotype: github.com/hashicorp/terraform-plugin-docs/internal/provider.ResourceTemplateType */ -}}
2+
---
3+
subcategory: "Apple Silicon"
4+
page_title: "Scaleway: scaleway_apple_silicon_runner"
5+
---
6+
7+
# Resource: scaleway_apple_silicon_runner
8+
9+
Creates and manages Scaleway Apple silicon runners.
10+
11+
## Example Usage
12+
13+
```terraform
14+
resource "scaleway_apple_silicon_runner" "main" {
15+
name = "my-github-runner"
16+
ci_provider = "github"
17+
url = "https://github.com/my-org/my-repo"
18+
token = "my-token"
19+
labels = ["updated"]
20+
}
21+
```
22+
23+
## Argument Reference
24+
25+
- `ci_provider` - (Required) The CI/CD provider for the runner. Must be either 'github' or 'gitlab'
26+
- `token` - (Required) The token used to authenticate the runner to run
27+
- `url` - (Required) The URL of the runner to run
28+
- `labels` - (Optional) A list of labels that should be applied to the runner. Only for github provider
29+
- `name` - (Optional) The name of the runner
30+
- `project_id` - (Optional) The project_id you want to attach the resource to
31+
- `zone` - (Optional) The zone of the runner
32+
33+
## Attributes Reference
34+
35+
- `id` - The ID of the runner.
36+
- `status` - The status of the runner
37+
38+
## Import
39+
40+
Runner can be imported using the `{zone}/{id}`, e.g.
41+
42+
```bash
43+
terraform import scaleway_apple_silicon_runner.main fr-par-1/11111111-1111-1111-1111-111111111111
44+
```

0 commit comments

Comments
 (0)