-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add
bundle summary to display URLs for deployed resources (#1731)
## Changes Adds a textual output to the `databricks bundle summary` command, which includes URLs of deployed resources. Example usage: ``` $ databricks bundle summary Name: my_pipeline Target: dev Workspace: Host: https://domain.databricks.com User: [email protected] Path: /Users/[email protected]/.bundle/my_pipeline/dev Resources: Jobs: my_project_job: Name: [dev lennart] my_project_job URL: https://domain.databricks.com/jobs/206899209187287?o=6051921418418893 Pipelines: my_project_pipeline: Name: [dev lennart] my_project_pipeline URL: https://domain.databricks.com/pipelines/3f849fd5-ba7d-47fa-a34c-c6bf034b4f58?o=6051921418418893 ``` Notes: * The top headers of the output are the same as those from the existing `bundle validate` command * URLs are colored light blue in the output * For resources that haven't been deployed yet, we show `(not deployed)` in place of the URL --------- Co-authored-by: Pieter Noordhuis <[email protected]> Co-authored-by: Pieter Noordhuis <[email protected]>
- Loading branch information
3 people
authored
Oct 18, 2024
1 parent
dedec58
commit c5043c3
Showing
18 changed files
with
728 additions
and
52 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| package mutator | ||
|
|
||
| import ( | ||
| "context" | ||
| "net/url" | ||
| "strconv" | ||
| "strings" | ||
|
|
||
| "github.com/databricks/cli/bundle" | ||
| "github.com/databricks/cli/libs/diag" | ||
| ) | ||
|
|
||
| type initializeURLs struct { | ||
| } | ||
|
|
||
| // InitializeURLs makes sure the URL field of each resource is configured. | ||
| // NOTE: since this depends on an extra API call, this mutator adds some extra | ||
| // latency. As such, it should only be used when needed. | ||
| // This URL field is used for the output of the 'bundle summary' CLI command. | ||
| func InitializeURLs() bundle.Mutator { | ||
| return &initializeURLs{} | ||
| } | ||
|
|
||
| func (m *initializeURLs) Name() string { | ||
| return "InitializeURLs" | ||
| } | ||
|
|
||
| func (m *initializeURLs) Apply(ctx context.Context, b *bundle.Bundle) diag.Diagnostics { | ||
| workspaceId, err := b.WorkspaceClient().CurrentWorkspaceID(ctx) | ||
| if err != nil { | ||
| return diag.FromErr(err) | ||
| } | ||
| orgId := strconv.FormatInt(workspaceId, 10) | ||
| host := b.WorkspaceClient().Config.CanonicalHostName() | ||
| initializeForWorkspace(b, orgId, host) | ||
| return nil | ||
| } | ||
|
|
||
| func initializeForWorkspace(b *bundle.Bundle, orgId string, host string) error { | ||
| baseURL, err := url.Parse(host) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| // Add ?o=<workspace id> only if <workspace id> wasn't in the subdomain already. | ||
| // The ?o= is needed when vanity URLs / legacy workspace URLs are used. | ||
| // If it's not needed we prefer to leave it out since these URLs are rather | ||
| // long for most terminals. | ||
| // | ||
| // See https://docs.databricks.com/en/workspace/workspace-details.html for | ||
| // further reading about the '?o=' suffix. | ||
| if !strings.Contains(baseURL.Hostname(), orgId) { | ||
| values := baseURL.Query() | ||
| values.Add("o", orgId) | ||
| baseURL.RawQuery = values.Encode() | ||
| } | ||
|
|
||
| for _, group := range b.Config.Resources.AllResources() { | ||
| for _, r := range group.Resources { | ||
| r.InitializeURL(*baseURL) | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| package mutator | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/databricks/cli/bundle" | ||
| "github.com/databricks/cli/bundle/config" | ||
| "github.com/databricks/cli/bundle/config/resources" | ||
| "github.com/databricks/databricks-sdk-go/service/catalog" | ||
| "github.com/databricks/databricks-sdk-go/service/compute" | ||
| "github.com/databricks/databricks-sdk-go/service/jobs" | ||
| "github.com/databricks/databricks-sdk-go/service/ml" | ||
| "github.com/databricks/databricks-sdk-go/service/pipelines" | ||
| "github.com/databricks/databricks-sdk-go/service/serving" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestInitializeURLs(t *testing.T) { | ||
| b := &bundle.Bundle{ | ||
| Config: config.Root{ | ||
| Workspace: config.Workspace{ | ||
| Host: "https://mycompany.databricks.com/", | ||
| }, | ||
| Resources: config.Resources{ | ||
| Jobs: map[string]*resources.Job{ | ||
| "job1": { | ||
| ID: "1", | ||
| JobSettings: &jobs.JobSettings{Name: "job1"}, | ||
| }, | ||
| }, | ||
| Pipelines: map[string]*resources.Pipeline{ | ||
| "pipeline1": { | ||
| ID: "3", | ||
| PipelineSpec: &pipelines.PipelineSpec{Name: "pipeline1"}, | ||
| }, | ||
| }, | ||
| Experiments: map[string]*resources.MlflowExperiment{ | ||
| "experiment1": { | ||
| ID: "4", | ||
| Experiment: &ml.Experiment{Name: "experiment1"}, | ||
| }, | ||
| }, | ||
| Models: map[string]*resources.MlflowModel{ | ||
| "model1": { | ||
| ID: "a model uses its name for identifier", | ||
| Model: &ml.Model{Name: "a model uses its name for identifier"}, | ||
| }, | ||
| }, | ||
| ModelServingEndpoints: map[string]*resources.ModelServingEndpoint{ | ||
| "servingendpoint1": { | ||
| ID: "my_serving_endpoint", | ||
| CreateServingEndpoint: &serving.CreateServingEndpoint{ | ||
| Name: "my_serving_endpoint", | ||
| }, | ||
| }, | ||
| }, | ||
| RegisteredModels: map[string]*resources.RegisteredModel{ | ||
| "registeredmodel1": { | ||
| ID: "8", | ||
| CreateRegisteredModelRequest: &catalog.CreateRegisteredModelRequest{ | ||
| Name: "my_registered_model", | ||
| }, | ||
| }, | ||
| }, | ||
| QualityMonitors: map[string]*resources.QualityMonitor{ | ||
| "qualityMonitor1": { | ||
| CreateMonitor: &catalog.CreateMonitor{ | ||
| TableName: "catalog.schema.qualityMonitor1", | ||
| }, | ||
| }, | ||
| }, | ||
| Schemas: map[string]*resources.Schema{ | ||
| "schema1": { | ||
| ID: "catalog.schema", | ||
| CreateSchema: &catalog.CreateSchema{ | ||
| Name: "schema", | ||
| }, | ||
| }, | ||
| }, | ||
| Clusters: map[string]*resources.Cluster{ | ||
| "cluster1": { | ||
| ID: "1017-103929-vlr7jzcf", | ||
| ClusterSpec: &compute.ClusterSpec{ | ||
| ClusterName: "cluster1", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| expectedURLs := map[string]string{ | ||
| "job1": "https://mycompany.databricks.com/jobs/1?o=123456", | ||
| "pipeline1": "https://mycompany.databricks.com/pipelines/3?o=123456", | ||
| "experiment1": "https://mycompany.databricks.com/ml/experiments/4?o=123456", | ||
| "model1": "https://mycompany.databricks.com/ml/models/a%20model%20uses%20its%20name%20for%20identifier?o=123456", | ||
| "servingendpoint1": "https://mycompany.databricks.com/ml/endpoints/my_serving_endpoint?o=123456", | ||
| "registeredmodel1": "https://mycompany.databricks.com/explore/data/models/8?o=123456", | ||
| "qualityMonitor1": "https://mycompany.databricks.com/explore/data/catalog/schema/qualityMonitor1?o=123456", | ||
| "schema1": "https://mycompany.databricks.com/explore/data/catalog/schema?o=123456", | ||
| "cluster1": "https://mycompany.databricks.com/compute/clusters/1017-103929-vlr7jzcf?o=123456", | ||
| } | ||
|
|
||
| initializeForWorkspace(b, "123456", "https://mycompany.databricks.com/") | ||
|
|
||
| for _, group := range b.Config.Resources.AllResources() { | ||
| for key, r := range group.Resources { | ||
| require.Equal(t, expectedURLs[key], r.GetURL(), "Unexpected URL for "+key) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func TestInitializeURLsWithoutOrgId(t *testing.T) { | ||
| b := &bundle.Bundle{ | ||
| Config: config.Root{ | ||
| Resources: config.Resources{ | ||
| Jobs: map[string]*resources.Job{ | ||
| "job1": { | ||
| ID: "1", | ||
| JobSettings: &jobs.JobSettings{Name: "job1"}, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| initializeForWorkspace(b, "123456", "https://adb-123456.azuredatabricks.net/") | ||
|
|
||
| require.Equal(t, "https://adb-123456.azuredatabricks.net/jobs/1", b.Config.Resources.Jobs["job1"].URL) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.