-
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 description to max_clusters_per_user
in policies schema. Re-format docs.
#1959
Conversation
… `make fmt-docs`.
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #1959 +/- ##
==========================================
+ Coverage 90.24% 90.29% +0.05%
==========================================
Files 146 146
Lines 11898 11906 +8
==========================================
+ Hits 10737 10751 +14
+ Misses 749 746 -3
+ Partials 412 409 -3
|
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.
docs/resources/cluster_policy.md
Outdated
@@ -99,7 +99,7 @@ The following arguments are required: | |||
|
|||
* `name` - (Required) Cluster policy name. This must be unique. Length must be between 1 and 100 characters. | |||
* `definition` - (Required) Policy definition: JSON document expressed in [Databricks Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policies.html#cluster-policy-definition). | |||
* `max_clusters_per_user` - (Optional, integer) Maximum number of clusters allowed per user. When omitted, there is no limit. | |||
* `max_clusters_per_user` - (Optional, integer) Maximum number of clusters allowed per user. When omitted, there is no limit. If specified, value must be non-zero. |
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.
it's better to say "greater than zero" :-)
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.
Changed.
@@ -125,6 +125,9 @@ func ResourceClusterPolicy() *schema.Resource { | |||
"max_clusters_per_user": { | |||
Type: schema.TypeInt, | |||
Optional: true, | |||
Description: "Max number of clusters per user that can be active\n" + | |||
"using this policy. If not present, there is no max limit.", | |||
ValidateFunc: validation.IntAtLeast(1), |
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.
does it work when omitted?
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.
Yes, I've tested it with and without the parameter.
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.
lgtm
No description provided.