Skip to content
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

Document enable_serverless_compute API changes in databricks_sql_endpoint resource #2137

Merged

Conversation

jxbell
Copy link
Contributor

@jxbell jxbell commented Mar 21, 2023

DEPLOYMENT NOTE: TO BE DEPLOYED WITH AWS GA SERVERLESS SQL ON MARCH 22 AND IN CONJUNCTION WITH THIS DOCS PR: https://github.com/databricks/docs/pull/10197 PROBABLY BEST TO WAIT FOR CONFIRMATION OF GO/NOGO!

Three related PRs:

DOC-6788 Terraform AWS serverless SQL API changes

IMPORTANT: NO API changes to remove global config field IN TERRAFORM CONTRACT PER @nfx -- HE DID DEPRECATE IT IN https://github.com/databricks/terraform-provider-databricks/pull/2139/files

Cleanup:

  • Cleanup: fix "sql endpoint" in English descriptions (not code/spec) to "SQL warehouse" per name change.

  • Cleanup: fix to lowercase for all this type of case for "serverless" (per Marketing Department dictum)

API change to regular enable_serverless_compute field (not global config) :

  • Update the enable_serverless_compute guidance for AWS and Azure enablement: ((Make more accurate enablement info for AWS only (not "enable for workspace" since we don't do that as of GA). Azure doesn't need special terms of use flags at account level, but does have workspace flag) :

    If your account was created before October 1, 2021, your organization's owner or account administrator must [accept applicable terms of use](https://docs.databricks.com/sql/admin/serverless.html#accept-terms) before workspaces are enabled for serverless compute. A workspace must meet the [requirements](https://docs.databricks.com/sql/admin/serverless.html#requirements) and might require an update its instance profile role to [add a trust relationship](https://docs.databricks.com/sql/admin/serverless.html#aws-instance-profile-setup). For Azure, you must [enable your workspace for serverless SQL warehouse](https://learn.microsoft.com/azure/databricks/sql/admin/serverless).

  • Also update that field per agreement with PM to match API Explorer and main docs... Update AWS specific instructions when we enable "auto enablement at account level" as part of GA for AWS

    For AWS, Databricks strongly recommends that you always explicitly set this field. If omitted, the default is false for most workspaces. However, if this workspace used the SQL Warehouses API to create a warehouse between September 1, 2022 and April 6, 2023, the default remains the previous behavior which is default to true if the workspace is enabled for serverless and fits the requirements for serverless SQL warehouses. To avoid ambiguity, especially for organizations with many workspaces, Databricks recommends that you always set this field.

  • For Azure, specify how default value works:

    For Azure, if serverless SQL warehouses are disabled for the workspace, the default is false. If serverless SQL warehouses are enabled for the workspace, the default is true.

…ay "SQL warehouse" which is Databricks current name for them.
…space" since we don't do that as of GA). Azure doesn't need special terms of use flags at account level :

```
 If your account was created before October 1, 2021, your organization's owner or account administrator must [accept applicable terms of use](https://docs.databricks.com/sql/admin/serverless.html#accept-terms) before workspaces are enabled for serverless compute. A workspace must meet the [requirements](https://docs.databricks.com/sql/admin/serverless.html#requirements) and might require an update its instance profile role to [add a trust relationship](https://docs.databricks.com/sql/admin/serverless.html#aws-instance-profile-setup). For Azure, you must [enable your workspace for serverless SQL warehouse](https://learn.microsoft.com/azure/databricks/sql/admin/serverless).
 ```
…ccount level" as part of GA

```
For AWS, Databricks strongly recommends that you always explicitly set this field. If omitted, the default is false for most workspaces. However, if this workspace used the SQL Warehouses API to create a warehouse between September 1, 2022 and April 6, 2023, the default remains the previous behavior which is default to true if the workspace is enabled for serverless and fits the requirements for serverless SQL warehouses. To avoid ambiguity, especially for organizations with many workspaces, Databricks recommends that you always set this field.
```
…apitalization (though I wasn't sure about article "Data Source" whether that needs to remain, so I left it be)
…SQL warehouses are disabled for the workspace, the default is `false`. If serverless SQL warehouses are enabled for the workspace, the default is `true`.
@alexott
Copy link
Contributor

alexott commented Mar 21, 2023

please rebase onto the latest master

…ay "SQL warehouse" which is Databricks current name for them.
…space" since we don't do that as of GA). Azure doesn't need special terms of use flags at account level :

```
 If your account was created before October 1, 2021, your organization's owner or account administrator must [accept applicable terms of use](https://docs.databricks.com/sql/admin/serverless.html#accept-terms) before workspaces are enabled for serverless compute. A workspace must meet the [requirements](https://docs.databricks.com/sql/admin/serverless.html#requirements) and might require an update its instance profile role to [add a trust relationship](https://docs.databricks.com/sql/admin/serverless.html#aws-instance-profile-setup). For Azure, you must [enable your workspace for serverless SQL warehouse](https://learn.microsoft.com/azure/databricks/sql/admin/serverless).
 ```
…ccount level" as part of GA

```
For AWS, Databricks strongly recommends that you always explicitly set this field. If omitted, the default is false for most workspaces. However, if this workspace used the SQL Warehouses API to create a warehouse between September 1, 2022 and April 6, 2023, the default remains the previous behavior which is default to true if the workspace is enabled for serverless and fits the requirements for serverless SQL warehouses. To avoid ambiguity, especially for organizations with many workspaces, Databricks recommends that you always set this field.
```
…apitalization (though I wasn't sure about article "Data Source" whether that needs to remain, so I left it be)
…SQL warehouses are disabled for the workspace, the default is `false`. If serverless SQL warehouses are enabled for the workspace, the default is `true`.
@jxbell
Copy link
Contributor Author

jxbell commented Mar 21, 2023

@alexott , ok I just pulled origin/master into my fork master, did merge master to my branch, and then did "git rebase master"

@jxbell
Copy link
Contributor Author

jxbell commented Mar 21, 2023

@alexott It appears to still fail that "fail on differences" step

Copy link
Contributor

@alexott alexott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few comments, and then we're good with doc changes. Code changes should be discussed separately

CHANGELOG.md Outdated Show resolved Hide resolved
docs/data-sources/sql_warehouse.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@codecov-commenter
Copy link

codecov-commenter commented Mar 21, 2023

Codecov Report

Merging #2137 (9480803) into master (4b52883) will increase coverage by 0.00%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2137   +/-   ##
=======================================
  Coverage   89.03%   89.03%           
=======================================
  Files         137      137           
  Lines       11196    11198    +2     
=======================================
+ Hits         9968     9970    +2     
  Misses        823      823           
  Partials      405      405           

see 1 file with indirect coverage changes

@nfx nfx requested a review from alexott March 21, 2023 15:34
@nfx nfx changed the title [DOC-6788] Terraform AWS serverless SQL API changes Document enable_serverless_compute API changes in databricks_sql_endpoint resource Mar 21, 2023
Copy link
Contributor

@alexott alexott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

@nfx nfx enabled auto-merge (squash) March 24, 2023 12:08
@nfx nfx merged commit 01efc82 into databricks:master Mar 24, 2023
@nfx nfx mentioned this pull request Mar 31, 2023
@jxbell jxbell deleted the terraform-aws-serverless-sql-api-change-DOC-6788 branch April 26, 2023 22:09
@jxbell
Copy link
Contributor Author

jxbell commented Apr 26, 2023

There is a FOLLOWUP PR for the Azure version of the DBSQL Serverless GA: #2249

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants