Skip to content

Commit 8634e1d

Browse files
IlyaasKIlyaasK
committed
Add generated Terraform docs
1 parent 372e649 commit 8634e1d

6 files changed

Lines changed: 196 additions & 0 deletions

File tree

‎docs/data-sources/extension.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "kernel_extension Data Source - Kernel"
4+
subcategory: ""
5+
description: |-
6+
Lookup durable Kernel extension metadata.
7+
---
8+
9+
# kernel_extension (Data Source)
10+
11+
Lookup durable Kernel extension metadata.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Optional
19+
20+
- `id` (String) Extension ID.
21+
- `name` (String) Extension name for exact lookup.
22+
- `project_id` (String) Project to look the extension up in. Defaults to the provider `project_id`; when neither is set, the API key's project binding determines the project.
23+
24+
### Read-Only
25+
26+
- `created_at` (String) Extension creation timestamp.
27+
- `last_used_at` (String) Timestamp the extension was last used, if ever.
28+
- `size_bytes` (Number) Extension archive size in bytes.

‎docs/data-sources/profile.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "kernel_profile Data Source - Kernel"
4+
subcategory: ""
5+
description: |-
6+
Lookup durable Kernel profile metadata.
7+
---
8+
9+
# kernel_profile (Data Source)
10+
11+
Lookup durable Kernel profile metadata.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Optional
19+
20+
- `id` (String) Profile ID.
21+
- `name` (String) Profile name for exact lookup.
22+
- `project_id` (String) Project to look the profile up in. Defaults to the provider `project_id`; when neither is set, the API key's project binding determines the project.
23+
24+
### Read-Only
25+
26+
- `created_at` (String) Profile creation timestamp.

‎docs/data-sources/project.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "kernel_project Data Source - Kernel"
4+
subcategory: ""
5+
description: |-
6+
Lookup durable Kernel project metadata.
7+
---
8+
9+
# kernel_project (Data Source)
10+
11+
Lookup durable Kernel project metadata.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Optional
19+
20+
- `id` (String) Project ID. If both id and name are omitted, the provider project_id is used.
21+
- `name` (String) Project name for exact lookup.
22+
23+
### Read-Only
24+
25+
- `created_at` (String) Project creation timestamp.
26+
- `status` (String) Project status.
27+
- `updated_at` (String) Project update timestamp.

‎docs/data-sources/proxy.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "kernel_proxy Data Source - Kernel"
4+
subcategory: ""
5+
description: |-
6+
Lookup durable Kernel proxy metadata.
7+
---
8+
9+
# kernel_proxy (Data Source)
10+
11+
Lookup durable Kernel proxy metadata.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Optional
19+
20+
- `id` (String) Proxy ID.
21+
- `name` (String) Proxy name for exact lookup.
22+
- `project_id` (String) Project to look the proxy up in. Defaults to the provider `project_id`; when neither is set, the API key's project binding determines the project.
23+
24+
### Read-Only
25+
26+
- `protocol` (String) Proxy protocol.
27+
- `type` (String) Proxy type.

‎docs/index.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "Kernel Provider"
4+
description: |-
5+
Kernel Terraform provider for durable Kernel infrastructure configuration.
6+
---
7+
8+
# Kernel Provider
9+
10+
Kernel Terraform provider for durable Kernel infrastructure configuration.
11+
12+
13+
14+
<!-- schema generated by tfplugindocs -->
15+
## Schema
16+
17+
### Optional
18+
19+
- `api_key` (String, Sensitive) Kernel API key. May also be set with the `KERNEL_API_KEY` environment variable.
20+
- `base_url` (String) Kernel API base URL, intended for testing against non-production environments. May also be set with the `KERNEL_BASE_URL` environment variable.
21+
- `project_id` (String) Default Kernel project for project-scoped resources and data sources. Resources may override it with their own `project_id`. When neither is set, the API key's project binding determines the project; to run unscoped, leave both unset. May also be set with the `KERNEL_PROJECT_ID` environment variable.

‎docs/resources/browser_pool.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "kernel_browser_pool Resource - Kernel"
4+
subcategory: ""
5+
description: |-
6+
Kernel browser pool durable configuration.
7+
---
8+
9+
# kernel_browser_pool (Resource)
10+
11+
Kernel browser pool durable configuration.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `size` (Number) Number of browsers to maintain in the pool.
21+
22+
### Optional
23+
24+
- `chrome_policy` (String) JSON object of Chrome enterprise policy overrides. Stored as written; key order and whitespace are ignored when detecting changes.
25+
- `extension_ids` (List of String) Ordered extension IDs to load into browsers created by this pool.
26+
- `fill_rate_per_minute` (Number) Percentage of the pool to fill per minute.
27+
- `headless` (Boolean) Launch browsers using a headless image.
28+
- `kiosk_mode` (Boolean) Launch browsers in kiosk mode.
29+
- `name` (String) Optional browser pool name. Must be unique within the project.
30+
- `profile_id` (String) Optional profile ID to load for browsers created by this pool.
31+
- `project_id` (String) Project this browser pool belongs to. Defaults to the provider `project_id` when unset; when neither is set, the API key's project binding determines the project. Once created the pool keeps its project, and changing this attribute replaces the pool.
32+
- `proxy_id` (String) Optional proxy ID to use for browsers created by this pool.
33+
- `start_url` (String) Optional URL to navigate to when a browser is warmed into the pool.
34+
- `stealth` (Boolean) Launch browsers in stealth mode.
35+
- `timeout_seconds` (Number) Default idle timeout in seconds for acquired browsers.
36+
- `viewport` (Attributes) Optional browser viewport. (see [below for nested schema](#nestedatt--viewport))
37+
38+
### Read-Only
39+
40+
- `id` (String) Unique browser pool identifier.
41+
42+
<a id="nestedatt--viewport"></a>
43+
### Nested Schema for `viewport`
44+
45+
Required:
46+
47+
- `height` (Number) Browser window height in pixels.
48+
- `width` (Number) Browser window width in pixels.
49+
50+
Optional:
51+
52+
- `refresh_rate` (Number) Optional display refresh rate in Hz.
53+
54+
## Import
55+
56+
Import is supported using the following syntax:
57+
58+
The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
59+
60+
```shell
61+
# The bare form resolves the project like create: the provider default,
62+
# else the API key's binding.
63+
terraform import kernel_browser_pool.example <browser-pool-id>
64+
65+
# The project-qualified form imports a pool from a specific project.
66+
terraform import kernel_browser_pool.example <project-id>/<browser-pool-id>
67+
```

0 commit comments

Comments
 (0)