-
Notifications
You must be signed in to change notification settings - Fork 393
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add databricks_instance_pool
data source
#1907
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
subcategory: "Compute" | ||
--- | ||
|
||
# databricks_instance_pool Data Source | ||
|
||
-> **Note** If you have a fully automated setup with workspaces created by [databricks_mws_workspaces](../resources/mws_workspaces.md) or [azurerm_databricks_workspace](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/databricks_workspace), please make sure to add [depends_on attribute](../index.md#data-resources-and-authentication-is-not-configured-errors) in order to prevent _authentication is not configured for provider_ errors. | ||
|
||
Retrieves information about [databricks_instance_pool](../resources/instance_pool.md). | ||
|
||
## Example Usage | ||
|
||
Referring to an instance pool by name: | ||
|
||
```hcl | ||
data "databricks_instance_pool" "Pool" { | ||
name = "All spot" | ||
} | ||
|
||
resource "databricks_cluster" "my_cluster" { | ||
instance_pool_id = data.databricks_instance_pool.pool.id | ||
... | ||
} | ||
``` | ||
|
||
## Argument Reference | ||
|
||
Data source allows you to pick instance pool by the following attribute | ||
|
||
- `name` - Name of the instance pool. The instance pool must exist before this resource can be planned. | ||
|
||
## Attribute Reference | ||
|
||
Data source exposes the following attributes: | ||
|
||
- `id` - The id of the instance pool. | ||
- `pool_info` - block describing instance pool and its state. Check documentation for [databricks_instance_pool](../resources/instance_pool.md) for a list of exposed attributes. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
package pools | ||
|
||
import ( | ||
"context" | ||
"fmt" | ||
|
||
"github.com/databricks/terraform-provider-databricks/common" | ||
"github.com/hashicorp/terraform-plugin-sdk/v2/diag" | ||
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" | ||
) | ||
|
||
func getPool(poolsAPI InstancePoolsAPI, name string) (*InstancePoolAndStats, error) { | ||
poolList, err := poolsAPI.List() | ||
if err != nil { | ||
return nil, err | ||
} | ||
for _, pool := range poolList.InstancePools { | ||
if pool.InstancePoolName == name { | ||
return &pool, nil | ||
} | ||
} | ||
|
||
return nil, fmt.Errorf("instance pool '%s' doesn't exist", name) | ||
} | ||
|
||
// DataSourceInstancePool returns information about instance pool specified by name | ||
func DataSourceInstancePool() *schema.Resource { | ||
type poolDetails struct { | ||
Name string `json:"name"` | ||
Attributes *InstancePoolAndStats `json:"pool_info,omitempty" tf:"computed"` | ||
} | ||
s := common.StructToSchema(poolDetails{}, nil) | ||
return &schema.Resource{ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. why common.DataSource is not a fit? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I just had this code before DataSource was introduced, simply picked up it from stash. Also, there will be not so much difference in the code size at the end |
||
Schema: s, | ||
ReadContext: func(ctx context.Context, d *schema.ResourceData, m any) diag.Diagnostics { | ||
name := d.Get("name").(string) | ||
poolsAPI := NewInstancePoolsAPI(ctx, m) | ||
pool, err := getPool(poolsAPI, name) | ||
if err != nil { | ||
return diag.FromErr(err) | ||
} | ||
d.SetId(pool.InstancePoolID) | ||
err = common.StructToData(poolDetails{Name: name, Attributes: pool}, s, d) | ||
return diag.FromErr(err) | ||
}, | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
package pools | ||
|
||
import ( | ||
"context" | ||
"testing" | ||
|
||
"github.com/databricks/terraform-provider-databricks/common" | ||
"github.com/databricks/terraform-provider-databricks/qa" | ||
"github.com/stretchr/testify/assert" | ||
"github.com/stretchr/testify/require" | ||
) | ||
|
||
func TestDataSourceInstnacePool(t *testing.T) { | ||
d, err := qa.ResourceFixture{ | ||
Fixtures: []qa.HTTPFixture{ | ||
{ | ||
Method: "GET", | ||
Resource: "/api/2.0/instance-pools/list", | ||
Response: InstancePoolList{ | ||
InstancePools: []InstancePoolAndStats{ | ||
{ | ||
InstancePoolID: "abc", | ||
InstancePoolName: "pool", | ||
NodeTypeID: "node-type", | ||
}, | ||
}, | ||
}, | ||
}, | ||
}, | ||
Read: true, | ||
NonWritable: true, | ||
Resource: DataSourceInstancePool(), | ||
ID: ".", | ||
State: map[string]any{ | ||
"name": "pool", | ||
}, | ||
}.Apply(t) | ||
require.NoError(t, err) | ||
assert.Equal(t, "abc", d.Id()) | ||
assert.NotNil(t, d.Get("pool_info")) | ||
assert.Equal(t, "node-type", d.Get("pool_info.0.node_type_id").(string)) | ||
} | ||
|
||
func TestDataSourceInstancePoolsGetPool(t *testing.T) { | ||
qa.HTTPFixturesApply(t, []qa.HTTPFixture{ | ||
{ | ||
Method: "GET", | ||
Resource: "/api/2.0/instance-pools/list", | ||
Status: 404, | ||
Response: common.APIError{ | ||
Message: "searching_error", | ||
}, | ||
}, | ||
{ | ||
Method: "GET", | ||
Resource: "/api/2.0/instance-pools/list", | ||
Response: InstancePoolList{}, | ||
}, | ||
}, func(ctx context.Context, client *common.DatabricksClient) { | ||
poolsAPI := NewInstancePoolsAPI(ctx, client) | ||
|
||
_, err := getPool(poolsAPI, "searching_error") | ||
assert.EqualError(t, err, "searching_error") | ||
|
||
_, err = getPool(poolsAPI, "unknown") | ||
assert.EqualError(t, err, "instance pool 'unknown' doesn't exist") | ||
}) | ||
} | ||
|
||
func TestDataSourceInstnacePool_NotFound(t *testing.T) { | ||
qa.ResourceFixture{ | ||
Fixtures: []qa.HTTPFixture{ | ||
{ | ||
Method: "GET", | ||
Resource: "/api/2.0/instance-pools/list", | ||
Response: InstancePoolList{ | ||
InstancePools: []InstancePoolAndStats{}, | ||
}, | ||
}, | ||
}, | ||
Read: true, | ||
NonWritable: true, | ||
Resource: DataSourceInstancePool(), | ||
ID: ".", | ||
State: map[string]any{ | ||
"name": "Unknown", | ||
}, | ||
}.ExpectError(t, "instance pool 'Unknown' doesn't exist") | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this may fail make fmt docs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
agree, this need to be fixed in few other places as well