Skip to content

Commit 5390f89

Browse files
committed
add doc
1 parent 7b1d228 commit 5390f89

File tree

1 file changed

+72
-0
lines changed

1 file changed

+72
-0
lines changed
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
subcategory: "Inference"
3+
page_title: "Scaleway: scaleway_inference_deployment"
4+
---
5+
6+
# Resource: scaleway_inference_deployment
7+
8+
Creates and manages Scaleway Managed Inference deployments.
9+
For more information, see [the documentation](https://www.scaleway.com/en/developers/api/inference/).
10+
11+
## Example Usage
12+
13+
### Basic
14+
15+
```terraform
16+
resource "scaleway_inference_deployment" "deployment" {
17+
name = "tf-inference-deployment"
18+
node_type = "L4"
19+
model_name = "meta/llama-3.1-8b-instruct:fp8"
20+
public_endpoint {
21+
is_enabled = true
22+
}
23+
accept_eula = true
24+
}
25+
```
26+
27+
## Argument Reference
28+
29+
- `model_name` - (Required) The model name to use for the deployment. Model names can be found in Console or using Scaleway's CLI (`scw inference model list`)
30+
- `node_type` - (Required) The node type to use for the deployment.
31+
- `name` - (Optional) TThe deployment name.
32+
- `accept_eula` - (Optional) Whether the deployment is accepting eula.
33+
- `tags` - (Optional) The tags associated with the deployment.
34+
- `min_size` - (Optional) The minimum size of the pool.
35+
- `max_size` - (Optional) The maximum size of the pool.
36+
- `private_endpoint` - (Optional) Configuration of the deployment's private endpoint.
37+
- `private_network_id` - (Optional) The ID of the private network to use.
38+
- `disable_auth` - (Optional) Disable the authentication on the endpoint.
39+
- `public_endpoint` - (Optional) Configuration of the deployment's private endpoint.
40+
- `is_enabled` - (Optional) Enable or disable public endpoint.
41+
- `disable_auth` - (Optional) Disable the authentication on the endpoint.
42+
43+
- `region` - (Defaults to [provider](../index.md#region) `region`) The [region](../guides/regions_and_zones.md#regions) in which the deployment is created.
44+
- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the deployment is associated with.
45+
46+
## Attributes Reference
47+
48+
In addition to all arguments above, the following attributes are exported:
49+
50+
- `id` - The ID of the deployment.
51+
- `model_id` - The model id used for the deployment.
52+
- `size` - The size of the pool.
53+
- `status` - The status of the deployment.
54+
- `created_at` - The date and time of the creation of the deployment.
55+
- `updated_at` - The date and time of the last update of the deployment.
56+
- `private_endpoint` - Private endpoint's attributes.
57+
- `id` - (Optional) The id of the private endpoint.
58+
- `url` - (Optional) The URL of the endpoint.
59+
- `public_endpoint` - (Optional) Public endpoint's attributes.
60+
- `id` - (Optional) The id of the public endpoint.
61+
- `url` - (Optional) The URL of the endpoint.
62+
63+
~> **Important:** Deployments' IDs are [regional](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{region}/{id}`, e.g. `fr-par/11111111-1111-1111-1111-111111111111`.
64+
65+
66+
## Import
67+
68+
Functions can be imported using, `{region}/{id}`, as shown below:
69+
70+
```bash
71+
terraform import scaleway_inference_deployment.deployment fr-par/11111111-1111-1111-1111-111111111111
72+
```

0 commit comments

Comments
 (0)