From 8b86abc32986d4103908a04a1e1d55bcf121d3ca Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 16 Mar 2022 08:58:50 +0100 Subject: [PATCH] Bump github.com/hashicorp/terraform-plugin-docs from 0.6.0 to 0.7.0 (#105) * Bump github.com/hashicorp/terraform-plugin-docs from 0.6.0 to 0.7.0 Bumps [github.com/hashicorp/terraform-plugin-docs](https://github.com/hashicorp/terraform-plugin-docs) from 0.6.0 to 0.7.0. - [Release notes](https://github.com/hashicorp/terraform-plugin-docs/releases) - [Changelog](https://github.com/hashicorp/terraform-plugin-docs/blob/main/CHANGELOG.md) - [Commits](https://github.com/hashicorp/terraform-plugin-docs/compare/v0.6.0...v0.7.0) --- updated-dependencies: - dependency-name: github.com/hashicorp/terraform-plugin-docs dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] * fixes Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Mahmoud Ismail --- CHANGELOG.md | 2 +- .../aws_instance_profile_policy.md | 20 +- ...zure_user_assigned_identity_permissions.md | 18 +- docs/data-sources/backup.md | 16 +- docs/data-sources/backups.md | 20 +- docs/data-sources/cluster.md | 218 ++++++++-------- docs/data-sources/clusters.md | 224 ++++++++--------- docs/data-sources/instance_type.md | 12 +- docs/data-sources/instance_types.md | 16 +- docs/data-sources/version.md | 22 +- docs/index.md | 2 +- docs/resources/backup.md | 24 +- docs/resources/cluster.md | 232 +++++++++--------- docs/resources/cluster_from_backup.md | 230 ++++++++--------- go.mod | 2 +- go.sum | 4 +- 16 files changed, 531 insertions(+), 531 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 51b01a6..fe71da7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,7 +12,7 @@ ENHANCEMENTS: * resource/hopsworksai_cluster: Add `collect_logs` attribute to enable pushing services' logs to AWS CloudWatch. * resource/hopsworksai_cluster: Add `head/node_id` readonly attribute to retrieve the corresponding aws/azure instance id of the head node. * dependencies: Bump hashicorp/terraform-plugin-sdk/v2 from 2.10.1 to 2.11.0 -* dependencies: Bump hashicorp/terraform-plugin-docs from 0.5.1 to 0.6.0 +* dependencies: Bump hashicorp/terraform-plugin-docs from 0.5.1 to 0.7.0 FEATURES: diff --git a/docs/data-sources/aws_instance_profile_policy.md b/docs/data-sources/aws_instance_profile_policy.md index a2baa78..099dcd5 100644 --- a/docs/data-sources/aws_instance_profile_policy.md +++ b/docs/data-sources/aws_instance_profile_policy.md @@ -34,18 +34,18 @@ data "hopsworksai_aws_instance_profile_policy" "policy" { ### Optional -- **bucket_name** (String) Limit permissions to this S3 bucket. -- **cluster_id** (String) Limit docker repository permissions to the cluster id. -- **eks_cluster_name** (String) Limit permissions to eks cluster. -- **enable_backup** (Boolean) Add permissions required to allow creating backups of your clusters. Defaults to `true`. -- **enable_cloud_watch** (Boolean) Add permissions required to allow collecting your cluster logs using cloud watch. Defaults to `true`. -- **enable_eks_and_ecr** (Boolean) Add permissions required to enable access to Amazon EKS and ECR from within your Hopsworks cluster. Defaults to `true`. -- **enable_storage** (Boolean) Add permissions required to allow Hopsworks clusters to read and write from and to your aws S3 buckets. Defaults to `true`. -- **enable_upgrade** (Boolean, Deprecated) Add permissions required to enable upgrade to newer versions of Hopsworks. Defaults to `false`. These permissions are not required anymore to upgrade from version 2.4.0 and onwards. -- **id** (String) The ID of this resource. +- `bucket_name` (String) Limit permissions to this S3 bucket. +- `cluster_id` (String) Limit docker repository permissions to the cluster id. +- `eks_cluster_name` (String) Limit permissions to eks cluster. +- `enable_backup` (Boolean) Add permissions required to allow creating backups of your clusters. Defaults to `true`. +- `enable_cloud_watch` (Boolean) Add permissions required to allow collecting your cluster logs using cloud watch. Defaults to `true`. +- `enable_eks_and_ecr` (Boolean) Add permissions required to enable access to Amazon EKS and ECR from within your Hopsworks cluster. Defaults to `true`. +- `enable_storage` (Boolean) Add permissions required to allow Hopsworks clusters to read and write from and to your aws S3 buckets. Defaults to `true`. +- `enable_upgrade` (Boolean, Deprecated) Add permissions required to enable upgrade to newer versions of Hopsworks. Defaults to `false`. These permissions are not required anymore to upgrade from version 2.4.0 and onwards. +- `id` (String) The ID of this resource. ### Read-Only -- **json** (String) The instance profile policy in JSON format. +- `json` (String) The instance profile policy in JSON format. diff --git a/docs/data-sources/azure_user_assigned_identity_permissions.md b/docs/data-sources/azure_user_assigned_identity_permissions.md index 6bb5929..77dcc16 100644 --- a/docs/data-sources/azure_user_assigned_identity_permissions.md +++ b/docs/data-sources/azure_user_assigned_identity_permissions.md @@ -29,17 +29,17 @@ data "hopsworksai_azure_user_assigned_identity_permissions" "permissions" { ### Optional -- **enable_aks_and_acr** (Boolean) Add permissions required to enable access to Azure AKS and ACR from within your Hopsworks cluster. Defaults to `false`. -- **enable_backup** (Boolean) Add permissions required to allow creating backups of your clusters. Defaults to `true`. -- **enable_storage** (Boolean) Add permissions required to allow Hopsworks clusters to read and write from and to your azure storage accounts. Defaults to `true`. -- **enable_upgrade** (Boolean, Deprecated) Add permissions required to enable upgrade to newer versions of Hopsworks. Defaults to `false`. These permissions are not required anymore to upgrade from version 2.4.0 and onwards. -- **id** (String) The ID of this resource. +- `enable_aks_and_acr` (Boolean) Add permissions required to enable access to Azure AKS and ACR from within your Hopsworks cluster. Defaults to `false`. +- `enable_backup` (Boolean) Add permissions required to allow creating backups of your clusters. Defaults to `true`. +- `enable_storage` (Boolean) Add permissions required to allow Hopsworks clusters to read and write from and to your azure storage accounts. Defaults to `true`. +- `enable_upgrade` (Boolean, Deprecated) Add permissions required to enable upgrade to newer versions of Hopsworks. Defaults to `false`. These permissions are not required anymore to upgrade from version 2.4.0 and onwards. +- `id` (String) The ID of this resource. ### Read-Only -- **actions** (List of String) The actions permissions. -- **data_actions** (Set of String) The data actions permissions. -- **not_actions** (List of String) The not actions permissions. -- **not_data_actions** (Set of String) The not data actions permissions. +- `actions` (List of String) The actions permissions. +- `data_actions` (Set of String) The data actions permissions. +- `not_actions` (List of String) The not actions permissions. +- `not_data_actions` (Set of String) The not data actions permissions. diff --git a/docs/data-sources/backup.md b/docs/data-sources/backup.md index bbc1256..c856732 100644 --- a/docs/data-sources/backup.md +++ b/docs/data-sources/backup.md @@ -23,19 +23,19 @@ data "hopsworksai_backup" "backup" { ### Required -- **backup_id** (String) The backup id. +- `backup_id` (String) The backup id. ### Optional -- **id** (String) The ID of this resource. +- `id` (String) The ID of this resource. ### Read-Only -- **backup_name** (String) The name to attach to this backup. -- **cloud_provider** (String) The backup cloud provider. -- **cluster_id** (String) The id of the cluster for which you want to create a backup. -- **creation_date** (String) The creation date of the backup. The date is represented in RFC3339 format. -- **state** (String) The backup state. -- **state_message** (String) The backup state message. +- `backup_name` (String) The name to attach to this backup. +- `cloud_provider` (String) The backup cloud provider. +- `cluster_id` (String) The id of the cluster for which you want to create a backup. +- `creation_date` (String) The creation date of the backup. The date is represented in RFC3339 format. +- `state` (String) The backup state. +- `state_message` (String) The backup state message. diff --git a/docs/data-sources/backups.md b/docs/data-sources/backups.md index c9275d8..985b2a0 100644 --- a/docs/data-sources/backups.md +++ b/docs/data-sources/backups.md @@ -29,24 +29,24 @@ data "hopsworksai_backups" "backups" { ### Optional -- **cluster_id** (String) The id of the cluster to retrieve its backups. If not set, all the backups are retrieved. -- **id** (String) The ID of this resource. +- `cluster_id` (String) The id of the cluster to retrieve its backups. If not set, all the backups are retrieved. +- `id` (String) The ID of this resource. ### Read-Only -- **backups** (List of Object) The list of backups sorted based on creation date with latest created backup first. (see [below for nested schema](#nestedatt--backups)) +- `backups` (List of Object) The list of backups sorted based on creation date with latest created backup first. (see [below for nested schema](#nestedatt--backups)) ### Nested Schema for `backups` Read-Only: -- **backup_id** (String) -- **backup_name** (String) -- **cloud_provider** (String) -- **cluster_id** (String) -- **creation_date** (String) -- **state** (String) -- **state_message** (String) +- `backup_id` (String) +- `backup_name` (String) +- `cloud_provider` (String) +- `cluster_id` (String) +- `creation_date` (String) +- `state` (String) +- `state_message` (String) diff --git a/docs/data-sources/cluster.md b/docs/data-sources/cluster.md index 1eb0b9b..0c2c636 100644 --- a/docs/data-sources/cluster.md +++ b/docs/data-sources/cluster.md @@ -23,70 +23,70 @@ data "hopsworksai_clusters" "cluster" { ### Required -- **cluster_id** (String) The Id of the cluster. +- `cluster_id` (String) The Id of the cluster. ### Optional -- **id** (String) The ID of this resource. +- `id` (String) The ID of this resource. ### Read-Only -- **activation_state** (String) The current activation state of the cluster. -- **attach_public_ip** (Boolean) Attach or do not attach a public ip to the cluster. This can be useful if you intend to create a cluster in a private network. -- **autoscale** (List of Object) Setup auto scaling. (see [below for nested schema](#nestedatt--autoscale)) -- **aws_attributes** (List of Object) The configurations required to run the cluster on Amazon AWS. (see [below for nested schema](#nestedatt--aws_attributes)) -- **azure_attributes** (List of Object) The configurations required to run the cluster on Microsoft Azure. (see [below for nested schema](#nestedatt--azure_attributes)) -- **backup_retention_period** (Number) The validity of cluster backups in days. If set to 0 cluster backups are disabled. -- **collect_logs** (Boolean) Push services' logs to AWS cloud watch. -- **creation_date** (String) The creation date of the cluster. The date is represented in RFC3339 format. -- **deactivate_hopsworksai_log_collection** (Boolean) Allow Hopsworks.ai to collect services logs to help diagnose issues with the cluster. By deactivating this option, you will not be able to get full support from our teams. -- **head** (List of Object) The configurations of the head node of the cluster. (see [below for nested schema](#nestedatt--head)) -- **init_script** (String) A bash script that will run on all nodes during their initialization (must start with #!/usr/bin/env bash) -- **issue_lets_encrypt_certificate** (Boolean) Enable or disable issuing let's encrypt certificates. This can be used to disable issuing certificates if port 80 can not be open. -- **managed_users** (Boolean) Enable or disable Hopsworks.ai to manage your users. -- **name** (String) The name of the cluster, must be unique. -- **open_ports** (List of Object) Open the required ports to communicate with one of the Hopsworks services. (see [below for nested schema](#nestedatt--open_ports)) -- **os** (String) The operating system to use for the instances. Supported systems are ubuntu in all regions and centos in some specific regions -- **rondb** (List of Object) Setup a cluster with managed RonDB. (see [below for nested schema](#nestedatt--rondb)) -- **run_init_script_first** (Boolean) Run the init script before any other node initialization. WARNING if your initscript interfere with the following node initialization the cluster may not start properly. Make sure that you know what you are doing. -- **ssh_key** (String) The ssh key name that will be attached to this cluster. -- **start_date** (String) The starting date of the cluster. The date is represented in RFC3339 format. -- **state** (String) The current state of the cluster. -- **tags** (Map of String) The list of custom tags to be attached to the cluster. -- **update_state** (String) The action you can use to start or stop the cluster. -- **upgrade_in_progress** (List of Object) Information about ongoing cluster upgrade if any. (see [below for nested schema](#nestedatt--upgrade_in_progress)) -- **url** (String) The url generated to access the cluster. -- **version** (String) The version of the cluster. For existing clusters, you can change this attribute to upgrade to a newer version of Hopsworks. If the upgrade process ended up in an error state, you can always rollback to the old version by resetting this attribute to the old version. -- **workers** (Set of Object) The configurations of worker nodes. You can add as many as you want of this block to create workers with different configurations. (see [below for nested schema](#nestedatt--workers)) +- `activation_state` (String) The current activation state of the cluster. +- `attach_public_ip` (Boolean) Attach or do not attach a public ip to the cluster. This can be useful if you intend to create a cluster in a private network. +- `autoscale` (List of Object) Setup auto scaling. (see [below for nested schema](#nestedatt--autoscale)) +- `aws_attributes` (List of Object) The configurations required to run the cluster on Amazon AWS. (see [below for nested schema](#nestedatt--aws_attributes)) +- `azure_attributes` (List of Object) The configurations required to run the cluster on Microsoft Azure. (see [below for nested schema](#nestedatt--azure_attributes)) +- `backup_retention_period` (Number) The validity of cluster backups in days. If set to 0 cluster backups are disabled. +- `collect_logs` (Boolean) Push services' logs to AWS cloud watch. +- `creation_date` (String) The creation date of the cluster. The date is represented in RFC3339 format. +- `deactivate_hopsworksai_log_collection` (Boolean) Allow Hopsworks.ai to collect services logs to help diagnose issues with the cluster. By deactivating this option, you will not be able to get full support from our teams. +- `head` (List of Object) The configurations of the head node of the cluster. (see [below for nested schema](#nestedatt--head)) +- `init_script` (String) A bash script that will run on all nodes during their initialization (must start with #!/usr/bin/env bash) +- `issue_lets_encrypt_certificate` (Boolean) Enable or disable issuing let's encrypt certificates. This can be used to disable issuing certificates if port 80 can not be open. +- `managed_users` (Boolean) Enable or disable Hopsworks.ai to manage your users. +- `name` (String) The name of the cluster, must be unique. +- `open_ports` (List of Object) Open the required ports to communicate with one of the Hopsworks services. (see [below for nested schema](#nestedatt--open_ports)) +- `os` (String) The operating system to use for the instances. Supported systems are ubuntu in all regions and centos in some specific regions +- `rondb` (List of Object) Setup a cluster with managed RonDB. (see [below for nested schema](#nestedatt--rondb)) +- `run_init_script_first` (Boolean) Run the init script before any other node initialization. WARNING if your initscript interfere with the following node initialization the cluster may not start properly. Make sure that you know what you are doing. +- `ssh_key` (String) The ssh key name that will be attached to this cluster. +- `start_date` (String) The starting date of the cluster. The date is represented in RFC3339 format. +- `state` (String) The current state of the cluster. +- `tags` (Map of String) The list of custom tags to be attached to the cluster. +- `update_state` (String) The action you can use to start or stop the cluster. +- `upgrade_in_progress` (List of Object) Information about ongoing cluster upgrade if any. (see [below for nested schema](#nestedatt--upgrade_in_progress)) +- `url` (String) The url generated to access the cluster. +- `version` (String) The version of the cluster. For existing clusters, you can change this attribute to upgrade to a newer version of Hopsworks. If the upgrade process ended up in an error state, you can always rollback to the old version by resetting this attribute to the old version. +- `workers` (Set of Object) The configurations of worker nodes. You can add as many as you want of this block to create workers with different configurations. (see [below for nested schema](#nestedatt--workers)) ### Nested Schema for `autoscale` Read-Only: -- **gpu_workers** (List of Object) (see [below for nested schema](#nestedobjatt--autoscale--gpu_workers)) -- **non_gpu_workers** (List of Object) (see [below for nested schema](#nestedobjatt--autoscale--non_gpu_workers)) +- `gpu_workers` (List of Object) (see [below for nested schema](#nestedobjatt--autoscale--gpu_workers)) +- `non_gpu_workers` (List of Object) (see [below for nested schema](#nestedobjatt--autoscale--non_gpu_workers)) ### Nested Schema for `autoscale.gpu_workers` Read-Only: -- **disk_size** (Number) -- **downscale_wait_time** (Number) -- **instance_type** (String) -- **max_workers** (Number) -- **min_workers** (Number) -- **spot_config** (List of Object) (see [below for nested schema](#nestedobjatt--autoscale--gpu_workers--spot_config)) -- **standby_workers** (Number) +- `disk_size` (Number) +- `downscale_wait_time` (Number) +- `instance_type` (String) +- `max_workers` (Number) +- `min_workers` (Number) +- `spot_config` (List of Object) (see [below for nested schema](#nestedobjatt--autoscale--gpu_workers--spot_config)) +- `standby_workers` (Number) ### Nested Schema for `autoscale.gpu_workers.spot_config` Read-Only: -- **fall_back_on_demand** (Boolean) -- **max_price_percent** (Number) +- `fall_back_on_demand` (Boolean) +- `max_price_percent` (Number) @@ -95,21 +95,21 @@ Read-Only: Read-Only: -- **disk_size** (Number) -- **downscale_wait_time** (Number) -- **instance_type** (String) -- **max_workers** (Number) -- **min_workers** (Number) -- **spot_config** (List of Object) (see [below for nested schema](#nestedobjatt--autoscale--non_gpu_workers--spot_config)) -- **standby_workers** (Number) +- `disk_size` (Number) +- `downscale_wait_time` (Number) +- `instance_type` (String) +- `max_workers` (Number) +- `min_workers` (Number) +- `spot_config` (List of Object) (see [below for nested schema](#nestedobjatt--autoscale--non_gpu_workers--spot_config)) +- `standby_workers` (Number) ### Nested Schema for `autoscale.non_gpu_workers.spot_config` Read-Only: -- **fall_back_on_demand** (Boolean) -- **max_price_percent** (Number) +- `fall_back_on_demand` (Boolean) +- `max_price_percent` (Number) @@ -119,21 +119,21 @@ Read-Only: Read-Only: -- **bucket_name** (String) -- **ecr_registry_account_id** (String) -- **eks_cluster_name** (String) -- **instance_profile_arn** (String) -- **network** (List of Object) (see [below for nested schema](#nestedobjatt--aws_attributes--network)) -- **region** (String) +- `bucket_name` (String) +- `ecr_registry_account_id` (String) +- `eks_cluster_name` (String) +- `instance_profile_arn` (String) +- `network` (List of Object) (see [below for nested schema](#nestedobjatt--aws_attributes--network)) +- `region` (String) ### Nested Schema for `aws_attributes.network` Read-Only: -- **security_group_id** (String) -- **subnet_id** (String) -- **vpc_id** (String) +- `security_group_id` (String) +- `subnet_id` (String) +- `vpc_id` (String) @@ -142,26 +142,26 @@ Read-Only: Read-Only: -- **acr_registry_name** (String) -- **aks_cluster_name** (String) -- **location** (String) -- **network** (List of Object) (see [below for nested schema](#nestedobjatt--azure_attributes--network)) -- **resource_group** (String) -- **search_domain** (String) -- **storage_account** (String) -- **storage_container_name** (String) -- **user_assigned_managed_identity** (String) +- `acr_registry_name` (String) +- `aks_cluster_name` (String) +- `location` (String) +- `network` (List of Object) (see [below for nested schema](#nestedobjatt--azure_attributes--network)) +- `resource_group` (String) +- `search_domain` (String) +- `storage_account` (String) +- `storage_container_name` (String) +- `user_assigned_managed_identity` (String) ### Nested Schema for `azure_attributes.network` Read-Only: -- **resource_group** (String) -- **search_domain** (String) -- **security_group_name** (String) -- **subnet_name** (String) -- **virtual_network_name** (String) +- `resource_group` (String) +- `search_domain` (String) +- `security_group_name` (String) +- `subnet_name` (String) +- `virtual_network_name` (String) @@ -170,9 +170,9 @@ Read-Only: Read-Only: -- **disk_size** (Number) -- **instance_type** (String) -- **node_id** (String) +- `disk_size` (Number) +- `instance_type` (String) +- `node_id` (String) @@ -180,10 +180,10 @@ Read-Only: Read-Only: -- **feature_store** (Boolean) -- **kafka** (Boolean) -- **online_feature_store** (Boolean) -- **ssh** (Boolean) +- `feature_store` (Boolean) +- `kafka` (Boolean) +- `online_feature_store` (Boolean) +- `ssh` (Boolean) @@ -191,20 +191,20 @@ Read-Only: Read-Only: -- **api_nodes** (List of Object) (see [below for nested schema](#nestedobjatt--rondb--api_nodes)) -- **configuration** (List of Object) (see [below for nested schema](#nestedobjatt--rondb--configuration)) -- **data_nodes** (List of Object) (see [below for nested schema](#nestedobjatt--rondb--data_nodes)) -- **management_nodes** (List of Object) (see [below for nested schema](#nestedobjatt--rondb--management_nodes)) -- **mysql_nodes** (List of Object) (see [below for nested schema](#nestedobjatt--rondb--mysql_nodes)) +- `api_nodes` (List of Object) (see [below for nested schema](#nestedobjatt--rondb--api_nodes)) +- `configuration` (List of Object) (see [below for nested schema](#nestedobjatt--rondb--configuration)) +- `data_nodes` (List of Object) (see [below for nested schema](#nestedobjatt--rondb--data_nodes)) +- `management_nodes` (List of Object) (see [below for nested schema](#nestedobjatt--rondb--management_nodes)) +- `mysql_nodes` (List of Object) (see [below for nested schema](#nestedobjatt--rondb--mysql_nodes)) ### Nested Schema for `rondb.api_nodes` Read-Only: -- **count** (Number) -- **disk_size** (Number) -- **instance_type** (String) +- `count` (Number) +- `disk_size` (Number) +- `instance_type` (String) @@ -212,22 +212,22 @@ Read-Only: Read-Only: -- **general** (List of Object) (see [below for nested schema](#nestedobjatt--rondb--configuration--general)) -- **ndbd_default** (List of Object) (see [below for nested schema](#nestedobjatt--rondb--configuration--ndbd_default)) +- `general` (List of Object) (see [below for nested schema](#nestedobjatt--rondb--configuration--general)) +- `ndbd_default` (List of Object) (see [below for nested schema](#nestedobjatt--rondb--configuration--ndbd_default)) ### Nested Schema for `rondb.configuration.general` Read-Only: -- **benchmark** (List of Object) (see [below for nested schema](#nestedobjatt--rondb--configuration--general--benchmark)) +- `benchmark` (List of Object) (see [below for nested schema](#nestedobjatt--rondb--configuration--general--benchmark)) ### Nested Schema for `rondb.configuration.general.benchmark` Read-Only: -- **grant_user_privileges** (Boolean) +- `grant_user_privileges` (Boolean) @@ -236,7 +236,7 @@ Read-Only: Read-Only: -- **replication_factor** (Number) +- `replication_factor` (Number) @@ -245,9 +245,9 @@ Read-Only: Read-Only: -- **count** (Number) -- **disk_size** (Number) -- **instance_type** (String) +- `count` (Number) +- `disk_size` (Number) +- `instance_type` (String) @@ -255,9 +255,9 @@ Read-Only: Read-Only: -- **count** (Number) -- **disk_size** (Number) -- **instance_type** (String) +- `count` (Number) +- `disk_size` (Number) +- `instance_type` (String) @@ -265,9 +265,9 @@ Read-Only: Read-Only: -- **count** (Number) -- **disk_size** (Number) -- **instance_type** (String) +- `count` (Number) +- `disk_size` (Number) +- `instance_type` (String) @@ -276,8 +276,8 @@ Read-Only: Read-Only: -- **from_version** (String) -- **to_version** (String) +- `from_version` (String) +- `to_version` (String) @@ -285,17 +285,17 @@ Read-Only: Read-Only: -- **count** (Number) -- **disk_size** (Number) -- **instance_type** (String) -- **spot_config** (List of Object) (see [below for nested schema](#nestedobjatt--workers--spot_config)) +- `count` (Number) +- `disk_size` (Number) +- `instance_type` (String) +- `spot_config` (List of Object) (see [below for nested schema](#nestedobjatt--workers--spot_config)) ### Nested Schema for `workers.spot_config` Read-Only: -- **fall_back_on_demand** (Boolean) -- **max_price_percent** (Number) +- `fall_back_on_demand` (Boolean) +- `max_price_percent` (Number) diff --git a/docs/data-sources/clusters.md b/docs/data-sources/clusters.md index 7a91e02..48d879d 100644 --- a/docs/data-sources/clusters.md +++ b/docs/data-sources/clusters.md @@ -31,19 +31,19 @@ data "hopsworksai_clusters" "awsClusters" { ### Optional -- **filter** (Block List, Max: 1) Filter requested clusters based on cloud provider. (see [below for nested schema](#nestedblock--filter)) -- **id** (String) The ID of this resource. +- `filter` (Block List, Max: 1) Filter requested clusters based on cloud provider. (see [below for nested schema](#nestedblock--filter)) +- `id` (String) The ID of this resource. ### Read-Only -- **clusters** (List of Object) The list of clusters in the user's account. (see [below for nested schema](#nestedatt--clusters)) +- `clusters` (List of Object) The list of clusters in the user's account. (see [below for nested schema](#nestedatt--clusters)) ### Nested Schema for `filter` Optional: -- **cloud** (String) Filter based on cloud provider. +- `cloud` (String) Filter based on cloud provider. @@ -51,63 +51,63 @@ Optional: Read-Only: -- **activation_state** (String) -- **attach_public_ip** (Boolean) -- **autoscale** (List of Object) (see [below for nested schema](#nestedobjatt--clusters--autoscale)) -- **aws_attributes** (List of Object) (see [below for nested schema](#nestedobjatt--clusters--aws_attributes)) -- **azure_attributes** (List of Object) (see [below for nested schema](#nestedobjatt--clusters--azure_attributes)) -- **backup_retention_period** (Number) -- **cluster_id** (String) -- **collect_logs** (Boolean) -- **creation_date** (String) -- **deactivate_hopsworksai_log_collection** (Boolean) -- **head** (List of Object) (see [below for nested schema](#nestedobjatt--clusters--head)) -- **init_script** (String) -- **issue_lets_encrypt_certificate** (Boolean) -- **managed_users** (Boolean) -- **name** (String) -- **open_ports** (List of Object) (see [below for nested schema](#nestedobjatt--clusters--open_ports)) -- **os** (String) -- **rondb** (List of Object) (see [below for nested schema](#nestedobjatt--clusters--rondb)) -- **run_init_script_first** (Boolean) -- **ssh_key** (String) -- **start_date** (String) -- **state** (String) -- **tags** (Map of String) -- **update_state** (String) -- **upgrade_in_progress** (List of Object) (see [below for nested schema](#nestedobjatt--clusters--upgrade_in_progress)) -- **url** (String) -- **version** (String) -- **workers** (Set of Object) (see [below for nested schema](#nestedobjatt--clusters--workers)) +- `activation_state` (String) +- `attach_public_ip` (Boolean) +- `autoscale` (List of Object) (see [below for nested schema](#nestedobjatt--clusters--autoscale)) +- `aws_attributes` (List of Object) (see [below for nested schema](#nestedobjatt--clusters--aws_attributes)) +- `azure_attributes` (List of Object) (see [below for nested schema](#nestedobjatt--clusters--azure_attributes)) +- `backup_retention_period` (Number) +- `cluster_id` (String) +- `collect_logs` (Boolean) +- `creation_date` (String) +- `deactivate_hopsworksai_log_collection` (Boolean) +- `head` (List of Object) (see [below for nested schema](#nestedobjatt--clusters--head)) +- `init_script` (String) +- `issue_lets_encrypt_certificate` (Boolean) +- `managed_users` (Boolean) +- `name` (String) +- `open_ports` (List of Object) (see [below for nested schema](#nestedobjatt--clusters--open_ports)) +- `os` (String) +- `rondb` (List of Object) (see [below for nested schema](#nestedobjatt--clusters--rondb)) +- `run_init_script_first` (Boolean) +- `ssh_key` (String) +- `start_date` (String) +- `state` (String) +- `tags` (Map of String) +- `update_state` (String) +- `upgrade_in_progress` (List of Object) (see [below for nested schema](#nestedobjatt--clusters--upgrade_in_progress)) +- `url` (String) +- `version` (String) +- `workers` (Set of Object) (see [below for nested schema](#nestedobjatt--clusters--workers)) ### Nested Schema for `clusters.autoscale` Read-Only: -- **gpu_workers** (List of Object) (see [below for nested schema](#nestedobjatt--clusters--autoscale--gpu_workers)) -- **non_gpu_workers** (List of Object) (see [below for nested schema](#nestedobjatt--clusters--autoscale--non_gpu_workers)) +- `gpu_workers` (List of Object) (see [below for nested schema](#nestedobjatt--clusters--autoscale--gpu_workers)) +- `non_gpu_workers` (List of Object) (see [below for nested schema](#nestedobjatt--clusters--autoscale--non_gpu_workers)) ### Nested Schema for `clusters.autoscale.gpu_workers` Read-Only: -- **disk_size** (Number) -- **downscale_wait_time** (Number) -- **instance_type** (String) -- **max_workers** (Number) -- **min_workers** (Number) -- **spot_config** (List of Object) (see [below for nested schema](#nestedobjatt--clusters--autoscale--gpu_workers--spot_config)) -- **standby_workers** (Number) +- `disk_size` (Number) +- `downscale_wait_time` (Number) +- `instance_type` (String) +- `max_workers` (Number) +- `min_workers` (Number) +- `spot_config` (List of Object) (see [below for nested schema](#nestedobjatt--clusters--autoscale--gpu_workers--spot_config)) +- `standby_workers` (Number) ### Nested Schema for `clusters.autoscale.gpu_workers.standby_workers` Read-Only: -- **fall_back_on_demand** (Boolean) -- **max_price_percent** (Number) +- `fall_back_on_demand` (Boolean) +- `max_price_percent` (Number) @@ -116,21 +116,21 @@ Read-Only: Read-Only: -- **disk_size** (Number) -- **downscale_wait_time** (Number) -- **instance_type** (String) -- **max_workers** (Number) -- **min_workers** (Number) -- **spot_config** (List of Object) (see [below for nested schema](#nestedobjatt--clusters--autoscale--non_gpu_workers--spot_config)) -- **standby_workers** (Number) +- `disk_size` (Number) +- `downscale_wait_time` (Number) +- `instance_type` (String) +- `max_workers` (Number) +- `min_workers` (Number) +- `spot_config` (List of Object) (see [below for nested schema](#nestedobjatt--clusters--autoscale--non_gpu_workers--spot_config)) +- `standby_workers` (Number) ### Nested Schema for `clusters.autoscale.non_gpu_workers.standby_workers` Read-Only: -- **fall_back_on_demand** (Boolean) -- **max_price_percent** (Number) +- `fall_back_on_demand` (Boolean) +- `max_price_percent` (Number) @@ -140,21 +140,21 @@ Read-Only: Read-Only: -- **bucket_name** (String) -- **ecr_registry_account_id** (String) -- **eks_cluster_name** (String) -- **instance_profile_arn** (String) -- **network** (List of Object) (see [below for nested schema](#nestedobjatt--clusters--aws_attributes--network)) -- **region** (String) +- `bucket_name` (String) +- `ecr_registry_account_id` (String) +- `eks_cluster_name` (String) +- `instance_profile_arn` (String) +- `network` (List of Object) (see [below for nested schema](#nestedobjatt--clusters--aws_attributes--network)) +- `region` (String) ### Nested Schema for `clusters.aws_attributes.network` Read-Only: -- **security_group_id** (String) -- **subnet_id** (String) -- **vpc_id** (String) +- `security_group_id` (String) +- `subnet_id` (String) +- `vpc_id` (String) @@ -163,26 +163,26 @@ Read-Only: Read-Only: -- **acr_registry_name** (String) -- **aks_cluster_name** (String) -- **location** (String) -- **network** (List of Object) (see [below for nested schema](#nestedobjatt--clusters--azure_attributes--network)) -- **resource_group** (String) -- **search_domain** (String) -- **storage_account** (String) -- **storage_container_name** (String) -- **user_assigned_managed_identity** (String) +- `acr_registry_name` (String) +- `aks_cluster_name` (String) +- `location` (String) +- `network` (List of Object) (see [below for nested schema](#nestedobjatt--clusters--azure_attributes--network)) +- `resource_group` (String) +- `search_domain` (String) +- `storage_account` (String) +- `storage_container_name` (String) +- `user_assigned_managed_identity` (String) ### Nested Schema for `clusters.azure_attributes.network` Read-Only: -- **resource_group** (String) -- **search_domain** (String) -- **security_group_name** (String) -- **subnet_name** (String) -- **virtual_network_name** (String) +- `resource_group` (String) +- `search_domain` (String) +- `security_group_name` (String) +- `subnet_name` (String) +- `virtual_network_name` (String) @@ -191,9 +191,9 @@ Read-Only: Read-Only: -- **disk_size** (Number) -- **instance_type** (String) -- **node_id** (String) +- `disk_size` (Number) +- `instance_type` (String) +- `node_id` (String) @@ -201,10 +201,10 @@ Read-Only: Read-Only: -- **feature_store** (Boolean) -- **kafka** (Boolean) -- **online_feature_store** (Boolean) -- **ssh** (Boolean) +- `feature_store` (Boolean) +- `kafka` (Boolean) +- `online_feature_store` (Boolean) +- `ssh` (Boolean) @@ -212,20 +212,20 @@ Read-Only: Read-Only: -- **api_nodes** (List of Object) (see [below for nested schema](#nestedobjatt--clusters--rondb--api_nodes)) -- **configuration** (List of Object) (see [below for nested schema](#nestedobjatt--clusters--rondb--configuration)) -- **data_nodes** (List of Object) (see [below for nested schema](#nestedobjatt--clusters--rondb--data_nodes)) -- **management_nodes** (List of Object) (see [below for nested schema](#nestedobjatt--clusters--rondb--management_nodes)) -- **mysql_nodes** (List of Object) (see [below for nested schema](#nestedobjatt--clusters--rondb--mysql_nodes)) +- `api_nodes` (List of Object) (see [below for nested schema](#nestedobjatt--clusters--rondb--api_nodes)) +- `configuration` (List of Object) (see [below for nested schema](#nestedobjatt--clusters--rondb--configuration)) +- `data_nodes` (List of Object) (see [below for nested schema](#nestedobjatt--clusters--rondb--data_nodes)) +- `management_nodes` (List of Object) (see [below for nested schema](#nestedobjatt--clusters--rondb--management_nodes)) +- `mysql_nodes` (List of Object) (see [below for nested schema](#nestedobjatt--clusters--rondb--mysql_nodes)) ### Nested Schema for `clusters.rondb.api_nodes` Read-Only: -- **count** (Number) -- **disk_size** (Number) -- **instance_type** (String) +- `count` (Number) +- `disk_size` (Number) +- `instance_type` (String) @@ -233,22 +233,22 @@ Read-Only: Read-Only: -- **general** (List of Object) (see [below for nested schema](#nestedobjatt--clusters--rondb--configuration--general)) -- **ndbd_default** (List of Object) (see [below for nested schema](#nestedobjatt--clusters--rondb--configuration--ndbd_default)) +- `general` (List of Object) (see [below for nested schema](#nestedobjatt--clusters--rondb--configuration--general)) +- `ndbd_default` (List of Object) (see [below for nested schema](#nestedobjatt--clusters--rondb--configuration--ndbd_default)) ### Nested Schema for `clusters.rondb.configuration.ndbd_default` Read-Only: -- **benchmark** (List of Object) (see [below for nested schema](#nestedobjatt--clusters--rondb--configuration--ndbd_default--benchmark)) +- `benchmark` (List of Object) (see [below for nested schema](#nestedobjatt--clusters--rondb--configuration--ndbd_default--benchmark)) ### Nested Schema for `clusters.rondb.configuration.ndbd_default.benchmark` Read-Only: -- **grant_user_privileges** (Boolean) +- `grant_user_privileges` (Boolean) @@ -257,7 +257,7 @@ Read-Only: Read-Only: -- **replication_factor** (Number) +- `replication_factor` (Number) @@ -266,9 +266,9 @@ Read-Only: Read-Only: -- **count** (Number) -- **disk_size** (Number) -- **instance_type** (String) +- `count` (Number) +- `disk_size` (Number) +- `instance_type` (String) @@ -276,9 +276,9 @@ Read-Only: Read-Only: -- **count** (Number) -- **disk_size** (Number) -- **instance_type** (String) +- `count` (Number) +- `disk_size` (Number) +- `instance_type` (String) @@ -286,9 +286,9 @@ Read-Only: Read-Only: -- **count** (Number) -- **disk_size** (Number) -- **instance_type** (String) +- `count` (Number) +- `disk_size` (Number) +- `instance_type` (String) @@ -297,8 +297,8 @@ Read-Only: Read-Only: -- **from_version** (String) -- **to_version** (String) +- `from_version` (String) +- `to_version` (String) @@ -306,17 +306,17 @@ Read-Only: Read-Only: -- **count** (Number) -- **disk_size** (Number) -- **instance_type** (String) -- **spot_config** (List of Object) (see [below for nested schema](#nestedobjatt--clusters--workers--spot_config)) +- `count` (Number) +- `disk_size` (Number) +- `instance_type` (String) +- `spot_config` (List of Object) (see [below for nested schema](#nestedobjatt--clusters--workers--spot_config)) ### Nested Schema for `clusters.workers.spot_config` Read-Only: -- **fall_back_on_demand** (Boolean) -- **max_price_percent** (Number) +- `fall_back_on_demand` (Boolean) +- `max_price_percent` (Number) diff --git a/docs/data-sources/instance_type.md b/docs/data-sources/instance_type.md index 24dabb4..9519d27 100644 --- a/docs/data-sources/instance_type.md +++ b/docs/data-sources/instance_type.md @@ -33,14 +33,14 @@ data "hopsworksai_instance_type" "supported_type" { ### Required -- **cloud_provider** (String) The cloud provider where you plan to create your cluster. -- **node_type** (String) The node type that you want to get its smallest instance type. It has to be one of these types (head, worker, rondb_management, rondb_data, rondb_mysql, rondb_api). +- `cloud_provider` (String) The cloud provider where you plan to create your cluster. +- `node_type` (String) The node type that you want to get its smallest instance type. It has to be one of these types (head, worker, rondb_management, rondb_data, rondb_mysql, rondb_api). ### Optional -- **id** (String) The ID of this resource. -- **min_cpus** (Number) Filter based on the minimum number of CPU cores. Defaults to `0`. -- **min_gpus** (Number) Filter based on the minimum number of GPUs. Defaults to `0`. -- **min_memory_gb** (Number) Filter based on the minimum memory in gigabytes. Defaults to `0`. +- `id` (String) The ID of this resource. +- `min_cpus` (Number) Filter based on the minimum number of CPU cores. Defaults to `0`. +- `min_gpus` (Number) Filter based on the minimum number of GPUs. Defaults to `0`. +- `min_memory_gb` (Number) Filter based on the minimum memory in gigabytes. Defaults to `0`. diff --git a/docs/data-sources/instance_types.md b/docs/data-sources/instance_types.md index 926295a..8b3e753 100644 --- a/docs/data-sources/instance_types.md +++ b/docs/data-sources/instance_types.md @@ -25,25 +25,25 @@ data "hopsworksai_instance_types" "supported_worker_types" { ### Required -- **cloud_provider** (String) The cloud provider where you plan to create your cluster. -- **node_type** (String) The node type that you want to get its supported instance types. +- `cloud_provider` (String) The cloud provider where you plan to create your cluster. +- `node_type` (String) The node type that you want to get its supported instance types. ### Optional -- **id** (String) The ID of this resource. +- `id` (String) The ID of this resource. ### Read-Only -- **supported_types** (List of Object) The list of supported instance types. (see [below for nested schema](#nestedatt--supported_types)) +- `supported_types` (List of Object) The list of supported instance types. (see [below for nested schema](#nestedatt--supported_types)) ### Nested Schema for `supported_types` Read-Only: -- **cpus** (Number) -- **gpus** (Number) -- **id** (String) -- **memory** (Number) +- `cpus` (Number) +- `gpus` (Number) +- `id` (String) +- `memory` (Number) diff --git a/docs/data-sources/version.md b/docs/data-sources/version.md index 85fea4c..5db78f9 100644 --- a/docs/data-sources/version.md +++ b/docs/data-sources/version.md @@ -37,28 +37,28 @@ data "hopsworksai_version" "latest" { ### Required -- **cloud_provider** (String) The cloud provider where you plan to create your cluster. +- `cloud_provider` (String) The cloud provider where you plan to create your cluster. ### Optional -- **default** (Boolean) The version is the default version. -- **experimental** (Boolean) The version is an experimental version. -- **id** (String) The ID of this resource. -- **os** (String) Filter based on the supported os. -- **region** (String) Filter based on the region. -- **upgradeable_from_version** (String) The version which is upgradeable to this version. +- `default` (Boolean) The version is the default version. +- `experimental` (Boolean) The version is an experimental version. +- `id` (String) The ID of this resource. +- `os` (String) Filter based on the supported os. +- `region` (String) Filter based on the region. +- `upgradeable_from_version` (String) The version which is upgradeable to this version. ### Read-Only -- **release_notes_url** (String) The release notes url for this version. -- **supported_regions** (List of Object) The list of supported operating systems per regions. (see [below for nested schema](#nestedatt--supported_regions)) +- `release_notes_url` (String) The release notes url for this version. +- `supported_regions` (List of Object) The list of supported operating systems per regions. (see [below for nested schema](#nestedatt--supported_regions)) ### Nested Schema for `supported_regions` Read-Only: -- **centos** (List of String) -- **ubuntu** (List of String) +- `centos` (List of String) +- `ubuntu` (List of String) diff --git a/docs/index.md b/docs/index.md index 52b6c46..dc41d04 100644 --- a/docs/index.md +++ b/docs/index.md @@ -181,4 +181,4 @@ output "hopsworks_cluster_url" { ### Optional -- **api_key** (String, Sensitive) The API Key to use to connect to your account on Hopsworka.ai. Can be specified using the HOPSWORKSAI_API_KEY environment variable. \ No newline at end of file +- `api_key` (String, Sensitive) The API Key to use to connect to your account on Hopsworka.ai. Can be specified using the HOPSWORKSAI_API_KEY environment variable. \ No newline at end of file diff --git a/docs/resources/backup.md b/docs/resources/backup.md index 56ad346..408f26c 100644 --- a/docs/resources/backup.md +++ b/docs/resources/backup.md @@ -24,30 +24,30 @@ resource "hopsworksai_backup" "backup" { ### Required -- **backup_name** (String) The name to attach to this backup. -- **cluster_id** (String) The id of the cluster for which you want to create a backup. +- `backup_name` (String) The name to attach to this backup. +- `cluster_id` (String) The id of the cluster for which you want to create a backup. ### Optional -- **id** (String) The ID of this resource. -- **timeouts** (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) +- `id` (String) The ID of this resource. +- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) ### Read-Only -- **backup_id** (String) The backup id. -- **cloud_provider** (String) The backup cloud provider. -- **creation_date** (String) The creation date of the backup. The date is represented in RFC3339 format. -- **state** (String) The backup state. -- **state_message** (String) The backup state message. +- `backup_id` (String) The backup id. +- `cloud_provider` (String) The backup cloud provider. +- `creation_date` (String) The creation date of the backup. The date is represented in RFC3339 format. +- `state` (String) The backup state. +- `state_message` (String) The backup state message. ### Nested Schema for `timeouts` Optional: -- **create** (String) -- **delete** (String) -- **read** (String) +- `create` (String) +- `delete` (String) +- `read` (String) ## Import diff --git a/docs/resources/cluster.md b/docs/resources/cluster.md index 55d89b9..32b5953 100644 --- a/docs/resources/cluster.md +++ b/docs/resources/cluster.md @@ -1,11 +1,11 @@ --- # generated by https://github.com/hashicorp/terraform-plugin-docs -page_title: "Resource hopsworksai_cluster - terraform-provider-hopsworksai" +page_title: "hopsworksai_cluster Resource - terraform-provider-hopsworksai" subcategory: "" description: |- Use this resource to create, read, update, and delete clusters on Hopsworks.ai. --- -# Resource (hopsworksai_cluster) +# hopsworksai_cluster (Resource) Use this resource to create, read, update, and delete clusters on Hopsworks.ai. ## Example Usage @@ -68,54 +68,54 @@ resource "hopsworksai_cluster" "cluster" { ### Required -- **head** (Block List, Min: 1, Max: 1) The configurations of the head node of the cluster. (see [below for nested schema](#nestedblock--head)) -- **name** (String) The name of the cluster, must be unique. -- **ssh_key** (String) The ssh key name that will be attached to this cluster. +- `head` (Block List, Min: 1, Max: 1) The configurations of the head node of the cluster. (see [below for nested schema](#nestedblock--head)) +- `name` (String) The name of the cluster, must be unique. +- `ssh_key` (String) The ssh key name that will be attached to this cluster. ### Optional -- **attach_public_ip** (Boolean) Attach or do not attach a public ip to the cluster. This can be useful if you intend to create a cluster in a private network. Defaults to `true`. -- **autoscale** (Block List, Max: 1) Setup auto scaling. (see [below for nested schema](#nestedblock--autoscale)) -- **aws_attributes** (Block List, Max: 1) The configurations required to run the cluster on Amazon AWS. (see [below for nested schema](#nestedblock--aws_attributes)) -- **azure_attributes** (Block List, Max: 1) The configurations required to run the cluster on Microsoft Azure. (see [below for nested schema](#nestedblock--azure_attributes)) -- **backup_retention_period** (Number) The validity of cluster backups in days. If set to 0 cluster backups are disabled. Defaults to `0`. -- **collect_logs** (Boolean) Push services' logs to AWS cloud watch. Defaults to `false`. -- **deactivate_hopsworksai_log_collection** (Boolean) Allow Hopsworks.ai to collect services logs to help diagnose issues with the cluster. By deactivating this option, you will not be able to get full support from our teams. Defaults to `false`. -- **id** (String) The ID of this resource. -- **init_script** (String) A bash script that will run on all nodes during their initialization (must start with #!/usr/bin/env bash) -- **issue_lets_encrypt_certificate** (Boolean) Enable or disable issuing let's encrypt certificates. This can be used to disable issuing certificates if port 80 can not be open. Defaults to `true`. -- **managed_users** (Boolean) Enable or disable Hopsworks.ai to manage your users. Defaults to `true`. -- **open_ports** (Block List, Max: 1) Open the required ports to communicate with one of the Hopsworks services. (see [below for nested schema](#nestedblock--open_ports)) -- **os** (String) The operating system to use for the instances. Supported systems are ubuntu in all regions and centos in some specific regions Defaults to `ubuntu`. -- **rondb** (Block List, Max: 1) Setup a cluster with managed RonDB. (see [below for nested schema](#nestedblock--rondb)) -- **run_init_script_first** (Boolean) Run the init script before any other node initialization. WARNING if your initscript interfere with the following node initialization the cluster may not start properly. Make sure that you know what you are doing. -- **tags** (Map of String) The list of custom tags to be attached to the cluster. -- **timeouts** (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) -- **update_state** (String) The action you can use to start or stop the cluster. Defaults to `none`. -- **version** (String) The version of the cluster. For existing clusters, you can change this attribute to upgrade to a newer version of Hopsworks. If the upgrade process ended up in an error state, you can always rollback to the old version by resetting this attribute to the old version. Defaults to `2.5.0`. -- **workers** (Block Set) The configurations of worker nodes. You can add as many as you want of this block to create workers with different configurations. (see [below for nested schema](#nestedblock--workers)) +- `attach_public_ip` (Boolean) Attach or do not attach a public ip to the cluster. This can be useful if you intend to create a cluster in a private network. Defaults to `true`. +- `autoscale` (Block List, Max: 1) Setup auto scaling. (see [below for nested schema](#nestedblock--autoscale)) +- `aws_attributes` (Block List, Max: 1) The configurations required to run the cluster on Amazon AWS. (see [below for nested schema](#nestedblock--aws_attributes)) +- `azure_attributes` (Block List, Max: 1) The configurations required to run the cluster on Microsoft Azure. (see [below for nested schema](#nestedblock--azure_attributes)) +- `backup_retention_period` (Number) The validity of cluster backups in days. If set to 0 cluster backups are disabled. Defaults to `0`. +- `collect_logs` (Boolean) Push services' logs to AWS cloud watch. Defaults to `false`. +- `deactivate_hopsworksai_log_collection` (Boolean) Allow Hopsworks.ai to collect services logs to help diagnose issues with the cluster. By deactivating this option, you will not be able to get full support from our teams. Defaults to `false`. +- `id` (String) The ID of this resource. +- `init_script` (String) A bash script that will run on all nodes during their initialization (must start with #!/usr/bin/env bash) +- `issue_lets_encrypt_certificate` (Boolean) Enable or disable issuing let's encrypt certificates. This can be used to disable issuing certificates if port 80 can not be open. Defaults to `true`. +- `managed_users` (Boolean) Enable or disable Hopsworks.ai to manage your users. Defaults to `true`. +- `open_ports` (Block List, Max: 1) Open the required ports to communicate with one of the Hopsworks services. (see [below for nested schema](#nestedblock--open_ports)) +- `os` (String) The operating system to use for the instances. Supported systems are ubuntu in all regions and centos in some specific regions Defaults to `ubuntu`. +- `rondb` (Block List, Max: 1) Setup a cluster with managed RonDB. (see [below for nested schema](#nestedblock--rondb)) +- `run_init_script_first` (Boolean) Run the init script before any other node initialization. WARNING if your initscript interfere with the following node initialization the cluster may not start properly. Make sure that you know what you are doing. +- `tags` (Map of String) The list of custom tags to be attached to the cluster. +- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) +- `update_state` (String) The action you can use to start or stop the cluster. Defaults to `none`. +- `version` (String) The version of the cluster. For existing clusters, you can change this attribute to upgrade to a newer version of Hopsworks. If the upgrade process ended up in an error state, you can always rollback to the old version by resetting this attribute to the old version. Defaults to `2.5.0`. +- `workers` (Block Set) The configurations of worker nodes. You can add as many as you want of this block to create workers with different configurations. (see [below for nested schema](#nestedblock--workers)) ### Read-Only -- **activation_state** (String) The current activation state of the cluster. -- **cluster_id** (String) The Id of the cluster. -- **creation_date** (String) The creation date of the cluster. The date is represented in RFC3339 format. -- **start_date** (String) The starting date of the cluster. The date is represented in RFC3339 format. -- **state** (String) The current state of the cluster. -- **upgrade_in_progress** (List of Object) Information about ongoing cluster upgrade if any. (see [below for nested schema](#nestedatt--upgrade_in_progress)) -- **url** (String) The url generated to access the cluster. +- `activation_state` (String) The current activation state of the cluster. +- `cluster_id` (String) The Id of the cluster. +- `creation_date` (String) The creation date of the cluster. The date is represented in RFC3339 format. +- `start_date` (String) The starting date of the cluster. The date is represented in RFC3339 format. +- `state` (String) The current state of the cluster. +- `upgrade_in_progress` (List of Object) Information about ongoing cluster upgrade if any. (see [below for nested schema](#nestedatt--upgrade_in_progress)) +- `url` (String) The url generated to access the cluster. ### Nested Schema for `head` Optional: -- **disk_size** (Number) The disk size of the head node in units of GB. Defaults to `512`. -- **instance_type** (String) The instance type of the head node. Defaults to m5.2xlarge for AWS and Standard_D8_v3 for Azure. +- `disk_size` (Number) The disk size of the head node in units of GB. Defaults to `512`. +- `instance_type` (String) The instance type of the head node. Defaults to m5.2xlarge for AWS and Standard_D8_v3 for Azure. Read-Only: -- **node_id** (String) The corresponding aws/azure instance id of the head node. +- `node_id` (String) The corresponding aws/azure instance id of the head node. @@ -123,35 +123,35 @@ Read-Only: Required: -- **non_gpu_workers** (Block List, Min: 1, Max: 1) Setup auto scaling for non gpu nodes. (see [below for nested schema](#nestedblock--autoscale--non_gpu_workers)) +- `non_gpu_workers` (Block List, Min: 1, Max: 1) Setup auto scaling for non gpu nodes. (see [below for nested schema](#nestedblock--autoscale--non_gpu_workers)) Optional: -- **gpu_workers** (Block List, Max: 1) Setup auto scaling for gpu nodes. (see [below for nested schema](#nestedblock--autoscale--gpu_workers)) +- `gpu_workers` (Block List, Max: 1) Setup auto scaling for gpu nodes. (see [below for nested schema](#nestedblock--autoscale--gpu_workers)) ### Nested Schema for `autoscale.non_gpu_workers` Required: -- **instance_type** (String) The instance type to use while auto scaling. +- `instance_type` (String) The instance type to use while auto scaling. Optional: -- **disk_size** (Number) The disk size to use while auto scaling Defaults to `512`. -- **downscale_wait_time** (Number) The time to wait before removing unused resources. Defaults to `300`. -- **max_workers** (Number) The maximum number of workers created by auto scaling. Defaults to `10`. -- **min_workers** (Number) The minimum number of workers created by auto scaling. Defaults to `0`. -- **spot_config** (Block List, Max: 1) The configuration to use spot instances (see [below for nested schema](#nestedblock--autoscale--non_gpu_workers--spot_config)) -- **standby_workers** (Number) The percentage of workers to be always available during auto scaling. If you set this value to 0 new workers will only be added when a job or a notebook requests the resources. This attribute will not be taken into account if you set the minimum number of workers to 0 and no resources are used in the cluster, instead, it will start to take effect as soon as you start using resources. Defaults to `0.5`. +- `disk_size` (Number) The disk size to use while auto scaling Defaults to `512`. +- `downscale_wait_time` (Number) The time to wait before removing unused resources. Defaults to `300`. +- `max_workers` (Number) The maximum number of workers created by auto scaling. Defaults to `10`. +- `min_workers` (Number) The minimum number of workers created by auto scaling. Defaults to `0`. +- `spot_config` (Block List, Max: 1) The configuration to use spot instances (see [below for nested schema](#nestedblock--autoscale--non_gpu_workers--spot_config)) +- `standby_workers` (Number) The percentage of workers to be always available during auto scaling. If you set this value to 0 new workers will only be added when a job or a notebook requests the resources. This attribute will not be taken into account if you set the minimum number of workers to 0 and no resources are used in the cluster, instead, it will start to take effect as soon as you start using resources. Defaults to `0.5`. ### Nested Schema for `autoscale.non_gpu_workers.spot_config` Optional: -- **fall_back_on_demand** (Boolean) Fall back to on demand instance if unable to allocate a spot instance Defaults to `true`. -- **max_price_percent** (Number) The maximum spot instance price in percentage of the on-demand price. Defaults to `100`. +- `fall_back_on_demand` (Boolean) Fall back to on demand instance if unable to allocate a spot instance Defaults to `true`. +- `max_price_percent` (Number) The maximum spot instance price in percentage of the on-demand price. Defaults to `100`. @@ -160,24 +160,24 @@ Optional: Required: -- **instance_type** (String) The instance type to use while auto scaling. +- `instance_type` (String) The instance type to use while auto scaling. Optional: -- **disk_size** (Number) The disk size to use while auto scaling Defaults to `512`. -- **downscale_wait_time** (Number) The time to wait before removing unused resources. Defaults to `300`. -- **max_workers** (Number) The maximum number of workers created by auto scaling. Defaults to `10`. -- **min_workers** (Number) The minimum number of workers created by auto scaling. Defaults to `0`. -- **spot_config** (Block List, Max: 1) The configuration to use spot instances (see [below for nested schema](#nestedblock--autoscale--gpu_workers--spot_config)) -- **standby_workers** (Number) The percentage of workers to be always available during auto scaling. If you set this value to 0 new workers will only be added when a job or a notebook requests the resources. This attribute will not be taken into account if you set the minimum number of workers to 0 and no resources are used in the cluster, instead, it will start to take effect as soon as you start using resources. Defaults to `0.5`. +- `disk_size` (Number) The disk size to use while auto scaling Defaults to `512`. +- `downscale_wait_time` (Number) The time to wait before removing unused resources. Defaults to `300`. +- `max_workers` (Number) The maximum number of workers created by auto scaling. Defaults to `10`. +- `min_workers` (Number) The minimum number of workers created by auto scaling. Defaults to `0`. +- `spot_config` (Block List, Max: 1) The configuration to use spot instances (see [below for nested schema](#nestedblock--autoscale--gpu_workers--spot_config)) +- `standby_workers` (Number) The percentage of workers to be always available during auto scaling. If you set this value to 0 new workers will only be added when a job or a notebook requests the resources. This attribute will not be taken into account if you set the minimum number of workers to 0 and no resources are used in the cluster, instead, it will start to take effect as soon as you start using resources. Defaults to `0.5`. ### Nested Schema for `autoscale.gpu_workers.spot_config` Optional: -- **fall_back_on_demand** (Boolean) Fall back to on demand instance if unable to allocate a spot instance Defaults to `true`. -- **max_price_percent** (Number) The maximum spot instance price in percentage of the on-demand price. Defaults to `100`. +- `fall_back_on_demand` (Boolean) Fall back to on demand instance if unable to allocate a spot instance Defaults to `true`. +- `max_price_percent` (Number) The maximum spot instance price in percentage of the on-demand price. Defaults to `100`. @@ -187,27 +187,27 @@ Optional: Required: -- **bucket_name** (String) The name of the S3 bucket that the cluster will use to store data in. -- **instance_profile_arn** (String) The ARN of the AWS instance profile that the cluster will be started with. -- **region** (String) The AWS region where the cluster will be created. +- `bucket_name` (String) The name of the S3 bucket that the cluster will use to store data in. +- `instance_profile_arn` (String) The ARN of the AWS instance profile that the cluster will be started with. +- `region` (String) The AWS region where the cluster will be created. Optional: -- **ecr_registry_account_id** (String) The account id used for ECR. Defaults to the user's account id, inferred from the instance profille ARN. -- **eks_cluster_name** (String) The name of the AWS EKS cluster. -- **network** (Block List, Max: 1) The network configurations. (see [below for nested schema](#nestedblock--aws_attributes--network)) +- `ecr_registry_account_id` (String) The account id used for ECR. Defaults to the user's account id, inferred from the instance profille ARN. +- `eks_cluster_name` (String) The name of the AWS EKS cluster. +- `network` (Block List, Max: 1) The network configurations. (see [below for nested schema](#nestedblock--aws_attributes--network)) ### Nested Schema for `aws_attributes.network` Required: -- **subnet_id** (String) The subnet id. -- **vpc_id** (String) The VPC id. +- `subnet_id` (String) The subnet id. +- `vpc_id` (String) The VPC id. Optional: -- **security_group_id** (String) The security group id. +- `security_group_id` (String) The security group id. @@ -216,32 +216,32 @@ Optional: Required: -- **location** (String) The location where the cluster will be created. -- **resource_group** (String) The resource group where the cluster will be created. -- **storage_account** (String) The azure storage account that the cluster will use to store data in. -- **user_assigned_managed_identity** (String) The azure user assigned managed identity that the cluster will be started with. +- `location` (String) The location where the cluster will be created. +- `resource_group` (String) The resource group where the cluster will be created. +- `storage_account` (String) The azure storage account that the cluster will use to store data in. +- `user_assigned_managed_identity` (String) The azure user assigned managed identity that the cluster will be started with. Optional: -- **acr_registry_name** (String) The name of the ACR registry. -- **aks_cluster_name** (String) The name of the AKS cluster. -- **network** (Block List, Max: 1) The network configurations. (see [below for nested schema](#nestedblock--azure_attributes--network)) -- **search_domain** (String, Deprecated) The search domain to use for node address resolution. If not specified it will use the Azure default one (internal.cloudapp.net). Use azure_attributes/network/search_domain instead. -- **storage_container_name** (String) The name of the azure storage container that the cluster will use to store data in. If not specified, it will be automatically generated. +- `acr_registry_name` (String) The name of the ACR registry. +- `aks_cluster_name` (String) The name of the AKS cluster. +- `network` (Block List, Max: 1) The network configurations. (see [below for nested schema](#nestedblock--azure_attributes--network)) +- `search_domain` (String, Deprecated) The search domain to use for node address resolution. If not specified it will use the Azure default one (internal.cloudapp.net). Use azure_attributes/network/search_domain instead. +- `storage_container_name` (String) The name of the azure storage container that the cluster will use to store data in. If not specified, it will be automatically generated. ### Nested Schema for `azure_attributes.network` Required: -- **subnet_name** (String) The subnet name. -- **virtual_network_name** (String) The virtual network name. +- `subnet_name` (String) The subnet name. +- `virtual_network_name` (String) The virtual network name. Optional: -- **resource_group** (String) The resource group where the network resources reside. If not specified, the azure_attributes/resource_group will be used. -- **search_domain** (String) The search domain to use for node address resolution. If not specified it will use the Azure default one (internal.cloudapp.net). -- **security_group_name** (String) The security group name. +- `resource_group` (String) The resource group where the network resources reside. If not specified, the azure_attributes/resource_group will be used. +- `search_domain` (String) The search domain to use for node address resolution. If not specified it will use the Azure default one (internal.cloudapp.net). +- `security_group_name` (String) The security group name. @@ -250,10 +250,10 @@ Optional: Optional: -- **feature_store** (Boolean) Open the required ports to access the feature store from outside Hopsworks. Defaults to `false`. -- **kafka** (Boolean) Open the required ports to access kafka from outside Hopsworks. Defaults to `false`. -- **online_feature_store** (Boolean) Open the required ports to access the online feature store from outside Hopsworks. Defaults to `false`. -- **ssh** (Boolean) Open the ssh port (22) to allow ssh access to your cluster. Defaults to `false`. +- `feature_store` (Boolean) Open the required ports to access the feature store from outside Hopsworks. Defaults to `false`. +- `kafka` (Boolean) Open the required ports to access kafka from outside Hopsworks. Defaults to `false`. +- `online_feature_store` (Boolean) Open the required ports to access the online feature store from outside Hopsworks. Defaults to `false`. +- `ssh` (Boolean) Open the ssh port (22) to allow ssh access to your cluster. Defaults to `false`. @@ -261,20 +261,20 @@ Optional: Optional: -- **api_nodes** (Block List, Max: 1) The configuration of API nodes. (see [below for nested schema](#nestedblock--rondb--api_nodes)) -- **configuration** (Block List, Max: 1) The configuration of RonDB. (see [below for nested schema](#nestedblock--rondb--configuration)) -- **data_nodes** (Block List, Max: 1) The configuration of RonDB data nodes. (see [below for nested schema](#nestedblock--rondb--data_nodes)) -- **management_nodes** (Block List, Max: 1) The configuration of RonDB management nodes. (see [below for nested schema](#nestedblock--rondb--management_nodes)) -- **mysql_nodes** (Block List, Max: 1) The configuration of MySQL nodes. (see [below for nested schema](#nestedblock--rondb--mysql_nodes)) +- `api_nodes` (Block List, Max: 1) The configuration of API nodes. (see [below for nested schema](#nestedblock--rondb--api_nodes)) +- `configuration` (Block List, Max: 1) The configuration of RonDB. (see [below for nested schema](#nestedblock--rondb--configuration)) +- `data_nodes` (Block List, Max: 1) The configuration of RonDB data nodes. (see [below for nested schema](#nestedblock--rondb--data_nodes)) +- `management_nodes` (Block List, Max: 1) The configuration of RonDB management nodes. (see [below for nested schema](#nestedblock--rondb--management_nodes)) +- `mysql_nodes` (Block List, Max: 1) The configuration of MySQL nodes. (see [below for nested schema](#nestedblock--rondb--mysql_nodes)) ### Nested Schema for `rondb.api_nodes` Optional: -- **count** (Number) The number of API nodes. Defaults to `0`. -- **disk_size** (Number) The disk size of API nodes in units of GB Defaults to `30`. -- **instance_type** (String) The instance type of the RonDB data node. Defaults to t3a.medium for AWS and Standard_D2s_v4 for Azure. +- `count` (Number) The number of API nodes. Defaults to `0`. +- `disk_size` (Number) The disk size of API nodes in units of GB Defaults to `30`. +- `instance_type` (String) The instance type of the RonDB data node. Defaults to t3a.medium for AWS and Standard_D2s_v4 for Azure. @@ -282,22 +282,22 @@ Optional: Optional: -- **general** (Block List, Max: 1) The general configurations of RonDB. (see [below for nested schema](#nestedblock--rondb--configuration--general)) -- **ndbd_default** (Block List, Max: 1) The configuration of RonDB data nodes. (see [below for nested schema](#nestedblock--rondb--configuration--ndbd_default)) +- `general` (Block List, Max: 1) The general configurations of RonDB. (see [below for nested schema](#nestedblock--rondb--configuration--general)) +- `ndbd_default` (Block List, Max: 1) The configuration of RonDB data nodes. (see [below for nested schema](#nestedblock--rondb--configuration--ndbd_default)) ### Nested Schema for `rondb.configuration.general` Optional: -- **benchmark** (Block List, Max: 1) The configurations required to benchmark RonDB. (see [below for nested schema](#nestedblock--rondb--configuration--general--benchmark)) +- `benchmark` (Block List, Max: 1) The configurations required to benchmark RonDB. (see [below for nested schema](#nestedblock--rondb--configuration--general--benchmark)) ### Nested Schema for `rondb.configuration.general.benchmark` Optional: -- **grant_user_privileges** (Boolean) This allow API nodes to have user privileges access to RonDB. This is needed mainly for benchmarking and for that you need API nodes. Defaults to `false`. +- `grant_user_privileges` (Boolean) This allow API nodes to have user privileges access to RonDB. This is needed mainly for benchmarking and for that you need API nodes. Defaults to `false`. @@ -306,7 +306,7 @@ Optional: Optional: -- **replication_factor** (Number) The number of replicas created by RonDB for high availability. Defaults to `2`. +- `replication_factor` (Number) The number of replicas created by RonDB for high availability. Defaults to `2`. @@ -315,9 +315,9 @@ Optional: Optional: -- **count** (Number) The number of data nodes. Notice that the number of RonDB data nodes have to be multiples of the replication_factor. Defaults to `2`. -- **disk_size** (Number) The disk size of data nodes in units of GB Defaults to `512`. -- **instance_type** (String) The instance type of the RonDB data node. Defaults to t3a.xlarge for AWS and Standard_D4s_v4 for Azure. +- `count` (Number) The number of data nodes. Notice that the number of RonDB data nodes have to be multiples of the replication_factor. Defaults to `2`. +- `disk_size` (Number) The disk size of data nodes in units of GB Defaults to `512`. +- `instance_type` (String) The instance type of the RonDB data node. Defaults to t3a.xlarge for AWS and Standard_D4s_v4 for Azure. @@ -325,9 +325,9 @@ Optional: Optional: -- **count** (Number) The number of management nodes. Defaults to `1`. -- **disk_size** (Number) The disk size of management nodes in units of GB Defaults to `30`. -- **instance_type** (String) The instance type of the RonDB management node. Defaults to t3a.medium for AWS and Standard_D2s_v4 for Azure. +- `count` (Number) The number of management nodes. Defaults to `1`. +- `disk_size` (Number) The disk size of management nodes in units of GB Defaults to `30`. +- `instance_type` (String) The instance type of the RonDB management node. Defaults to t3a.medium for AWS and Standard_D2s_v4 for Azure. @@ -335,9 +335,9 @@ Optional: Optional: -- **count** (Number) The number of MySQL nodes. Defaults to `1`. -- **disk_size** (Number) The disk size of MySQL nodes in units of GB Defaults to `128`. -- **instance_type** (String) The instance type of the RonDB data node. Defaults to t3a.medium for AWS and Standard_D2s_v4 for Azure. +- `count` (Number) The number of MySQL nodes. Defaults to `1`. +- `disk_size` (Number) The disk size of MySQL nodes in units of GB Defaults to `128`. +- `instance_type` (String) The instance type of the RonDB data node. Defaults to t3a.medium for AWS and Standard_D2s_v4 for Azure. @@ -346,10 +346,10 @@ Optional: Optional: -- **create** (String) -- **delete** (String) -- **read** (String) -- **update** (String) +- `create` (String) +- `delete` (String) +- `read` (String) +- `update` (String) @@ -357,21 +357,21 @@ Optional: Required: -- **instance_type** (String) The instance type of the worker nodes. +- `instance_type` (String) The instance type of the worker nodes. Optional: -- **count** (Number) The number of worker nodes. Defaults to `1`. -- **disk_size** (Number) The disk size of worker nodes in units of GB Defaults to `512`. -- **spot_config** (Block List, Max: 1) The configuration to use spot instances (see [below for nested schema](#nestedblock--workers--spot_config)) +- `count` (Number) The number of worker nodes. Defaults to `1`. +- `disk_size` (Number) The disk size of worker nodes in units of GB Defaults to `512`. +- `spot_config` (Block List, Max: 1) The configuration to use spot instances (see [below for nested schema](#nestedblock--workers--spot_config)) ### Nested Schema for `workers.spot_config` Optional: -- **fall_back_on_demand** (Boolean) Fall back to on demand instance if unable to allocate a spot instance Defaults to `true`. -- **max_price_percent** (Number) The maximum spot instance price in percentage of the on-demand price. Defaults to `100`. +- `fall_back_on_demand` (Boolean) Fall back to on demand instance if unable to allocate a spot instance Defaults to `true`. +- `max_price_percent` (Number) The maximum spot instance price in percentage of the on-demand price. Defaults to `100`. @@ -380,8 +380,8 @@ Optional: Read-Only: -- **from_version** (String) -- **to_version** (String) +- `from_version` (String) +- `to_version` (String) ## Import diff --git a/docs/resources/cluster_from_backup.md b/docs/resources/cluster_from_backup.md index 0f52d79..1ae30fa 100644 --- a/docs/resources/cluster_from_backup.md +++ b/docs/resources/cluster_from_backup.md @@ -23,78 +23,78 @@ resource "hopsworksai_cluster_from_backup" "cluster" { ### Required -- **source_backup_id** (String) +- `source_backup_id` (String) ### Optional -- **autoscale** (Block List, Max: 1) Setup auto scaling. (see [below for nested schema](#nestedblock--autoscale)) -- **aws_attributes** (Block List, Max: 1) The configurations required to run the cluster on Amazon AWS. (see [below for nested schema](#nestedblock--aws_attributes)) -- **azure_attributes** (Block List, Max: 1) The configurations required to run the cluster on Microsoft Azure. (see [below for nested schema](#nestedblock--azure_attributes)) -- **id** (String) The ID of this resource. -- **name** (String) The name of the cluster, must be unique. -- **open_ports** (Block List, Max: 1) Open the required ports to communicate with one of the Hopsworks services. (see [below for nested schema](#nestedblock--open_ports)) -- **ssh_key** (String) The ssh key name that will be attached to this cluster. -- **tags** (Map of String) The list of custom tags to be attached to the cluster. -- **timeouts** (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) -- **update_state** (String) The action you can use to start or stop the cluster. Defaults to `none`. -- **workers** (Block Set) The configurations of worker nodes. You can add as many as you want of this block to create workers with different configurations. (see [below for nested schema](#nestedblock--workers)) +- `autoscale` (Block List, Max: 1) Setup auto scaling. (see [below for nested schema](#nestedblock--autoscale)) +- `aws_attributes` (Block List, Max: 1) The configurations required to run the cluster on Amazon AWS. (see [below for nested schema](#nestedblock--aws_attributes)) +- `azure_attributes` (Block List, Max: 1) The configurations required to run the cluster on Microsoft Azure. (see [below for nested schema](#nestedblock--azure_attributes)) +- `id` (String) The ID of this resource. +- `name` (String) The name of the cluster, must be unique. +- `open_ports` (Block List, Max: 1) Open the required ports to communicate with one of the Hopsworks services. (see [below for nested schema](#nestedblock--open_ports)) +- `ssh_key` (String) The ssh key name that will be attached to this cluster. +- `tags` (Map of String) The list of custom tags to be attached to the cluster. +- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) +- `update_state` (String) The action you can use to start or stop the cluster. Defaults to `none`. +- `workers` (Block Set) The configurations of worker nodes. You can add as many as you want of this block to create workers with different configurations. (see [below for nested schema](#nestedblock--workers)) ### Read-Only -- **activation_state** (String) The current activation state of the cluster. -- **attach_public_ip** (Boolean) Attach or do not attach a public ip to the cluster. This can be useful if you intend to create a cluster in a private network. -- **backup_retention_period** (Number) The validity of cluster backups in days. If set to 0 cluster backups are disabled. -- **cluster_id** (String) The Id of the cluster. -- **collect_logs** (Boolean) Push services' logs to AWS cloud watch. -- **creation_date** (String) The creation date of the cluster. The date is represented in RFC3339 format. -- **deactivate_hopsworksai_log_collection** (Boolean) Allow Hopsworks.ai to collect services logs to help diagnose issues with the cluster. By deactivating this option, you will not be able to get full support from our teams. -- **head** (List of Object) The configurations of the head node of the cluster. (see [below for nested schema](#nestedatt--head)) -- **init_script** (String) A bash script that will run on all nodes during their initialization (must start with #!/usr/bin/env bash) -- **issue_lets_encrypt_certificate** (Boolean) Enable or disable issuing let's encrypt certificates. This can be used to disable issuing certificates if port 80 can not be open. -- **managed_users** (Boolean) Enable or disable Hopsworks.ai to manage your users. -- **os** (String) The operating system to use for the instances. Supported systems are ubuntu in all regions and centos in some specific regions -- **rondb** (List of Object) Setup a cluster with managed RonDB. (see [below for nested schema](#nestedatt--rondb)) -- **run_init_script_first** (Boolean) Run the init script before any other node initialization. WARNING if your initscript interfere with the following node initialization the cluster may not start properly. Make sure that you know what you are doing. -- **start_date** (String) The starting date of the cluster. The date is represented in RFC3339 format. -- **state** (String) The current state of the cluster. -- **upgrade_in_progress** (List of Object) Information about ongoing cluster upgrade if any. (see [below for nested schema](#nestedatt--upgrade_in_progress)) -- **url** (String) The url generated to access the cluster. -- **version** (String) The version of the cluster. For existing clusters, you can change this attribute to upgrade to a newer version of Hopsworks. If the upgrade process ended up in an error state, you can always rollback to the old version by resetting this attribute to the old version. +- `activation_state` (String) The current activation state of the cluster. +- `attach_public_ip` (Boolean) Attach or do not attach a public ip to the cluster. This can be useful if you intend to create a cluster in a private network. +- `backup_retention_period` (Number) The validity of cluster backups in days. If set to 0 cluster backups are disabled. +- `cluster_id` (String) The Id of the cluster. +- `collect_logs` (Boolean) Push services' logs to AWS cloud watch. +- `creation_date` (String) The creation date of the cluster. The date is represented in RFC3339 format. +- `deactivate_hopsworksai_log_collection` (Boolean) Allow Hopsworks.ai to collect services logs to help diagnose issues with the cluster. By deactivating this option, you will not be able to get full support from our teams. +- `head` (List of Object) The configurations of the head node of the cluster. (see [below for nested schema](#nestedatt--head)) +- `init_script` (String) A bash script that will run on all nodes during their initialization (must start with #!/usr/bin/env bash) +- `issue_lets_encrypt_certificate` (Boolean) Enable or disable issuing let's encrypt certificates. This can be used to disable issuing certificates if port 80 can not be open. +- `managed_users` (Boolean) Enable or disable Hopsworks.ai to manage your users. +- `os` (String) The operating system to use for the instances. Supported systems are ubuntu in all regions and centos in some specific regions +- `rondb` (List of Object) Setup a cluster with managed RonDB. (see [below for nested schema](#nestedatt--rondb)) +- `run_init_script_first` (Boolean) Run the init script before any other node initialization. WARNING if your initscript interfere with the following node initialization the cluster may not start properly. Make sure that you know what you are doing. +- `start_date` (String) The starting date of the cluster. The date is represented in RFC3339 format. +- `state` (String) The current state of the cluster. +- `upgrade_in_progress` (List of Object) Information about ongoing cluster upgrade if any. (see [below for nested schema](#nestedatt--upgrade_in_progress)) +- `url` (String) The url generated to access the cluster. +- `version` (String) The version of the cluster. For existing clusters, you can change this attribute to upgrade to a newer version of Hopsworks. If the upgrade process ended up in an error state, you can always rollback to the old version by resetting this attribute to the old version. ### Nested Schema for `autoscale` Required: -- **non_gpu_workers** (Block List, Min: 1, Max: 1) Setup auto scaling for non gpu nodes. (see [below for nested schema](#nestedblock--autoscale--non_gpu_workers)) +- `non_gpu_workers` (Block List, Min: 1, Max: 1) Setup auto scaling for non gpu nodes. (see [below for nested schema](#nestedblock--autoscale--non_gpu_workers)) Optional: -- **gpu_workers** (Block List, Max: 1) Setup auto scaling for gpu nodes. (see [below for nested schema](#nestedblock--autoscale--gpu_workers)) +- `gpu_workers` (Block List, Max: 1) Setup auto scaling for gpu nodes. (see [below for nested schema](#nestedblock--autoscale--gpu_workers)) ### Nested Schema for `autoscale.non_gpu_workers` Required: -- **instance_type** (String) The instance type to use while auto scaling. +- `instance_type` (String) The instance type to use while auto scaling. Optional: -- **disk_size** (Number) The disk size to use while auto scaling Defaults to `512`. -- **downscale_wait_time** (Number) The time to wait before removing unused resources. Defaults to `300`. -- **max_workers** (Number) The maximum number of workers created by auto scaling. Defaults to `10`. -- **min_workers** (Number) The minimum number of workers created by auto scaling. Defaults to `0`. -- **spot_config** (Block List, Max: 1) The configuration to use spot instances (see [below for nested schema](#nestedblock--autoscale--non_gpu_workers--spot_config)) -- **standby_workers** (Number) The percentage of workers to be always available during auto scaling. If you set this value to 0 new workers will only be added when a job or a notebook requests the resources. This attribute will not be taken into account if you set the minimum number of workers to 0 and no resources are used in the cluster, instead, it will start to take effect as soon as you start using resources. Defaults to `0.5`. +- `disk_size` (Number) The disk size to use while auto scaling Defaults to `512`. +- `downscale_wait_time` (Number) The time to wait before removing unused resources. Defaults to `300`. +- `max_workers` (Number) The maximum number of workers created by auto scaling. Defaults to `10`. +- `min_workers` (Number) The minimum number of workers created by auto scaling. Defaults to `0`. +- `spot_config` (Block List, Max: 1) The configuration to use spot instances (see [below for nested schema](#nestedblock--autoscale--non_gpu_workers--spot_config)) +- `standby_workers` (Number) The percentage of workers to be always available during auto scaling. If you set this value to 0 new workers will only be added when a job or a notebook requests the resources. This attribute will not be taken into account if you set the minimum number of workers to 0 and no resources are used in the cluster, instead, it will start to take effect as soon as you start using resources. Defaults to `0.5`. ### Nested Schema for `autoscale.non_gpu_workers.spot_config` Optional: -- **fall_back_on_demand** (Boolean) Fall back to on demand instance if unable to allocate a spot instance Defaults to `true`. -- **max_price_percent** (Number) The maximum spot instance price in percentage of the on-demand price. Defaults to `100`. +- `fall_back_on_demand` (Boolean) Fall back to on demand instance if unable to allocate a spot instance Defaults to `true`. +- `max_price_percent` (Number) The maximum spot instance price in percentage of the on-demand price. Defaults to `100`. @@ -103,24 +103,24 @@ Optional: Required: -- **instance_type** (String) The instance type to use while auto scaling. +- `instance_type` (String) The instance type to use while auto scaling. Optional: -- **disk_size** (Number) The disk size to use while auto scaling Defaults to `512`. -- **downscale_wait_time** (Number) The time to wait before removing unused resources. Defaults to `300`. -- **max_workers** (Number) The maximum number of workers created by auto scaling. Defaults to `10`. -- **min_workers** (Number) The minimum number of workers created by auto scaling. Defaults to `0`. -- **spot_config** (Block List, Max: 1) The configuration to use spot instances (see [below for nested schema](#nestedblock--autoscale--gpu_workers--spot_config)) -- **standby_workers** (Number) The percentage of workers to be always available during auto scaling. If you set this value to 0 new workers will only be added when a job or a notebook requests the resources. This attribute will not be taken into account if you set the minimum number of workers to 0 and no resources are used in the cluster, instead, it will start to take effect as soon as you start using resources. Defaults to `0.5`. +- `disk_size` (Number) The disk size to use while auto scaling Defaults to `512`. +- `downscale_wait_time` (Number) The time to wait before removing unused resources. Defaults to `300`. +- `max_workers` (Number) The maximum number of workers created by auto scaling. Defaults to `10`. +- `min_workers` (Number) The minimum number of workers created by auto scaling. Defaults to `0`. +- `spot_config` (Block List, Max: 1) The configuration to use spot instances (see [below for nested schema](#nestedblock--autoscale--gpu_workers--spot_config)) +- `standby_workers` (Number) The percentage of workers to be always available during auto scaling. If you set this value to 0 new workers will only be added when a job or a notebook requests the resources. This attribute will not be taken into account if you set the minimum number of workers to 0 and no resources are used in the cluster, instead, it will start to take effect as soon as you start using resources. Defaults to `0.5`. ### Nested Schema for `autoscale.gpu_workers.spot_config` Optional: -- **fall_back_on_demand** (Boolean) Fall back to on demand instance if unable to allocate a spot instance Defaults to `true`. -- **max_price_percent** (Number) The maximum spot instance price in percentage of the on-demand price. Defaults to `100`. +- `fall_back_on_demand` (Boolean) Fall back to on demand instance if unable to allocate a spot instance Defaults to `true`. +- `max_price_percent` (Number) The maximum spot instance price in percentage of the on-demand price. Defaults to `100`. @@ -130,27 +130,27 @@ Optional: Optional: -- **instance_profile_arn** (String) The ARN of the AWS instance profile that the cluster will be started with. -- **network** (Block List, Max: 1) The network configurations. (see [below for nested schema](#nestedblock--aws_attributes--network)) +- `instance_profile_arn` (String) The ARN of the AWS instance profile that the cluster will be started with. +- `network` (Block List, Max: 1) The network configurations. (see [below for nested schema](#nestedblock--aws_attributes--network)) Read-Only: -- **bucket_name** (String) The name of the S3 bucket that the cluster will use to store data in. -- **ecr_registry_account_id** (String) The account id used for ECR. Defaults to the user's account id, inferred from the instance profille ARN. -- **eks_cluster_name** (String) The name of the AWS EKS cluster. -- **region** (String) The AWS region where the cluster will be created. +- `bucket_name` (String) The name of the S3 bucket that the cluster will use to store data in. +- `ecr_registry_account_id` (String) The account id used for ECR. Defaults to the user's account id, inferred from the instance profille ARN. +- `eks_cluster_name` (String) The name of the AWS EKS cluster. +- `region` (String) The AWS region where the cluster will be created. ### Nested Schema for `aws_attributes.network` Required: -- **subnet_id** (String) The subnet id. -- **vpc_id** (String) The VPC id. +- `subnet_id` (String) The subnet id. +- `vpc_id` (String) The VPC id. Optional: -- **security_group_id** (String) The security group id. +- `security_group_id` (String) The security group id. @@ -159,32 +159,32 @@ Optional: Optional: -- **network** (Block List, Max: 1) The network configurations. (see [below for nested schema](#nestedblock--azure_attributes--network)) +- `network` (Block List, Max: 1) The network configurations. (see [below for nested schema](#nestedblock--azure_attributes--network)) Read-Only: -- **acr_registry_name** (String) The name of the ACR registry. -- **aks_cluster_name** (String) The name of the AKS cluster. -- **location** (String) The location where the cluster will be created. -- **resource_group** (String) The resource group where the cluster will be created. -- **search_domain** (String) The search domain to use for node address resolution. If not specified it will use the Azure default one (internal.cloudapp.net). -- **storage_account** (String) The azure storage account that the cluster will use to store data in. -- **storage_container_name** (String) The name of the azure storage container that the cluster will use to store data in. If not specified, it will be automatically generated. -- **user_assigned_managed_identity** (String) The azure user assigned managed identity that the cluster will be started with. +- `acr_registry_name` (String) The name of the ACR registry. +- `aks_cluster_name` (String) The name of the AKS cluster. +- `location` (String) The location where the cluster will be created. +- `resource_group` (String) The resource group where the cluster will be created. +- `search_domain` (String) The search domain to use for node address resolution. If not specified it will use the Azure default one (internal.cloudapp.net). +- `storage_account` (String) The azure storage account that the cluster will use to store data in. +- `storage_container_name` (String) The name of the azure storage container that the cluster will use to store data in. If not specified, it will be automatically generated. +- `user_assigned_managed_identity` (String) The azure user assigned managed identity that the cluster will be started with. ### Nested Schema for `azure_attributes.network` Required: -- **subnet_name** (String) The subnet name. -- **virtual_network_name** (String) The virtual network name. +- `subnet_name` (String) The subnet name. +- `virtual_network_name` (String) The virtual network name. Optional: -- **resource_group** (String) The resource group where the network resources reside. If not specified, the azure_attributes/resource_group will be used. -- **search_domain** (String) The search domain to use for node address resolution. If not specified it will use the Azure default one (internal.cloudapp.net). -- **security_group_name** (String) The security group name. +- `resource_group` (String) The resource group where the network resources reside. If not specified, the azure_attributes/resource_group will be used. +- `search_domain` (String) The search domain to use for node address resolution. If not specified it will use the Azure default one (internal.cloudapp.net). +- `security_group_name` (String) The security group name. @@ -193,10 +193,10 @@ Optional: Optional: -- **feature_store** (Boolean) Open the required ports to access the feature store from outside Hopsworks. Defaults to `false`. -- **kafka** (Boolean) Open the required ports to access kafka from outside Hopsworks. Defaults to `false`. -- **online_feature_store** (Boolean) Open the required ports to access the online feature store from outside Hopsworks. Defaults to `false`. -- **ssh** (Boolean) Open the ssh port (22) to allow ssh access to your cluster. Defaults to `false`. +- `feature_store` (Boolean) Open the required ports to access the feature store from outside Hopsworks. Defaults to `false`. +- `kafka` (Boolean) Open the required ports to access kafka from outside Hopsworks. Defaults to `false`. +- `online_feature_store` (Boolean) Open the required ports to access the online feature store from outside Hopsworks. Defaults to `false`. +- `ssh` (Boolean) Open the ssh port (22) to allow ssh access to your cluster. Defaults to `false`. @@ -204,10 +204,10 @@ Optional: Optional: -- **create** (String) -- **delete** (String) -- **read** (String) -- **update** (String) +- `create` (String) +- `delete` (String) +- `read` (String) +- `update` (String) @@ -215,21 +215,21 @@ Optional: Required: -- **instance_type** (String) The instance type of the worker nodes. +- `instance_type` (String) The instance type of the worker nodes. Optional: -- **count** (Number) The number of worker nodes. Defaults to `1`. -- **disk_size** (Number) The disk size of worker nodes in units of GB Defaults to `512`. -- **spot_config** (Block List, Max: 1) The configuration to use spot instances (see [below for nested schema](#nestedblock--workers--spot_config)) +- `count` (Number) The number of worker nodes. Defaults to `1`. +- `disk_size` (Number) The disk size of worker nodes in units of GB Defaults to `512`. +- `spot_config` (Block List, Max: 1) The configuration to use spot instances (see [below for nested schema](#nestedblock--workers--spot_config)) ### Nested Schema for `workers.spot_config` Optional: -- **fall_back_on_demand** (Boolean) Fall back to on demand instance if unable to allocate a spot instance Defaults to `true`. -- **max_price_percent** (Number) The maximum spot instance price in percentage of the on-demand price. Defaults to `100`. +- `fall_back_on_demand` (Boolean) Fall back to on demand instance if unable to allocate a spot instance Defaults to `true`. +- `max_price_percent` (Number) The maximum spot instance price in percentage of the on-demand price. Defaults to `100`. @@ -238,9 +238,9 @@ Optional: Read-Only: -- **disk_size** (Number) -- **instance_type** (String) -- **node_id** (String) +- `disk_size` (Number) +- `instance_type` (String) +- `node_id` (String) @@ -248,20 +248,20 @@ Read-Only: Read-Only: -- **api_nodes** (List of Object) (see [below for nested schema](#nestedobjatt--rondb--api_nodes)) -- **configuration** (List of Object) (see [below for nested schema](#nestedobjatt--rondb--configuration)) -- **data_nodes** (List of Object) (see [below for nested schema](#nestedobjatt--rondb--data_nodes)) -- **management_nodes** (List of Object) (see [below for nested schema](#nestedobjatt--rondb--management_nodes)) -- **mysql_nodes** (List of Object) (see [below for nested schema](#nestedobjatt--rondb--mysql_nodes)) +- `api_nodes` (List of Object) (see [below for nested schema](#nestedobjatt--rondb--api_nodes)) +- `configuration` (List of Object) (see [below for nested schema](#nestedobjatt--rondb--configuration)) +- `data_nodes` (List of Object) (see [below for nested schema](#nestedobjatt--rondb--data_nodes)) +- `management_nodes` (List of Object) (see [below for nested schema](#nestedobjatt--rondb--management_nodes)) +- `mysql_nodes` (List of Object) (see [below for nested schema](#nestedobjatt--rondb--mysql_nodes)) ### Nested Schema for `rondb.api_nodes` Read-Only: -- **count** (Number) -- **disk_size** (Number) -- **instance_type** (String) +- `count` (Number) +- `disk_size` (Number) +- `instance_type` (String) @@ -269,22 +269,22 @@ Read-Only: Read-Only: -- **general** (List of Object) (see [below for nested schema](#nestedobjatt--rondb--configuration--general)) -- **ndbd_default** (List of Object) (see [below for nested schema](#nestedobjatt--rondb--configuration--ndbd_default)) +- `general` (List of Object) (see [below for nested schema](#nestedobjatt--rondb--configuration--general)) +- `ndbd_default` (List of Object) (see [below for nested schema](#nestedobjatt--rondb--configuration--ndbd_default)) ### Nested Schema for `rondb.configuration.general` Read-Only: -- **benchmark** (List of Object) (see [below for nested schema](#nestedobjatt--rondb--configuration--general--benchmark)) +- `benchmark` (List of Object) (see [below for nested schema](#nestedobjatt--rondb--configuration--general--benchmark)) ### Nested Schema for `rondb.configuration.general.benchmark` Read-Only: -- **grant_user_privileges** (Boolean) +- `grant_user_privileges` (Boolean) @@ -293,7 +293,7 @@ Read-Only: Read-Only: -- **replication_factor** (Number) +- `replication_factor` (Number) @@ -302,9 +302,9 @@ Read-Only: Read-Only: -- **count** (Number) -- **disk_size** (Number) -- **instance_type** (String) +- `count` (Number) +- `disk_size` (Number) +- `instance_type` (String) @@ -312,9 +312,9 @@ Read-Only: Read-Only: -- **count** (Number) -- **disk_size** (Number) -- **instance_type** (String) +- `count` (Number) +- `disk_size` (Number) +- `instance_type` (String) @@ -322,9 +322,9 @@ Read-Only: Read-Only: -- **count** (Number) -- **disk_size** (Number) -- **instance_type** (String) +- `count` (Number) +- `disk_size` (Number) +- `instance_type` (String) @@ -333,7 +333,7 @@ Read-Only: Read-Only: -- **from_version** (String) -- **to_version** (String) +- `from_version` (String) +- `to_version` (String) diff --git a/go.mod b/go.mod index 4313834..234610d 100644 --- a/go.mod +++ b/go.mod @@ -3,6 +3,6 @@ module github.com/logicalclocks/terraform-provider-hopsworksai go 1.16 require ( - github.com/hashicorp/terraform-plugin-docs v0.6.0 + github.com/hashicorp/terraform-plugin-docs v0.7.0 github.com/hashicorp/terraform-plugin-sdk/v2 v2.11.0 ) diff --git a/go.sum b/go.sum index 3e3d0cf..c2dfd16 100644 --- a/go.sum +++ b/go.sum @@ -137,8 +137,8 @@ github.com/hashicorp/terraform-exec v0.16.0 h1:XUh9pJPcbfZsuhReVvmRarQTaiiCnYogF github.com/hashicorp/terraform-exec v0.16.0/go.mod h1:wB5JHmjxZ/YVNZuv9npAXKmz5pGyxy8PSi0GRR0+YjA= github.com/hashicorp/terraform-json v0.13.0 h1:Li9L+lKD1FO5RVFRM1mMMIBDoUHslOniyEi5CM+FWGY= github.com/hashicorp/terraform-json v0.13.0/go.mod h1:y5OdLBCT+rxbwnpxZs9kGL7R9ExU76+cpdY8zHwoazk= -github.com/hashicorp/terraform-plugin-docs v0.6.0 h1:gWnop6iX7HKpWQDu7TkK7eXizkaFQPQBZyVN5bFh2sI= -github.com/hashicorp/terraform-plugin-docs v0.6.0/go.mod h1:kbdlq1sGGAoSDnus8GfG4V7xQaYOyexM0d8HUb6GZg4= +github.com/hashicorp/terraform-plugin-docs v0.7.0 h1:7XKAOYHAxghe7q4/vx468X43X9GikdQ2dxtmcu2gQv0= +github.com/hashicorp/terraform-plugin-docs v0.7.0/go.mod h1:57CICKfW7/KbW4lPhKOledyT6vu1LeAOzuvWXsVaxUE= github.com/hashicorp/terraform-plugin-go v0.8.0 h1:MvY43PcDj9VlBjYifBWCO/6j1wf106xU8d5Tob/WRs0= github.com/hashicorp/terraform-plugin-go v0.8.0/go.mod h1:E3GuvfX0Pz2Azcl6BegD6t51StXsVZMOYQoGO8mkHM0= github.com/hashicorp/terraform-plugin-log v0.3.0 h1:NPENNOjaJSVX0f7JJTl4f/2JKRPQ7S2ZN9B4NSqq5kA=