Example to show how bundle variables work #21

pietern · 2024-02-14T09:26:12Z

No description provided.

pietern · 2024-02-14T09:32:18Z

I was in need of a working example to demonstrate how this works, so figured I create an example.

Feedback welcome!

juliacrawf-db · 2024-02-15T06:01:39Z

knowledge_base/bundle_variables/README.md

@@ -0,0 +1,65 @@
+# bundle_variables


I think a real title would be nice. Given it's a KB topic, how about "How to validate bundle variables"? Or maybe that's not quite right... "How to validate and set variable values"?

juliacrawf-db · 2024-02-15T06:06:19Z

knowledge_base/bundle_variables/README.md

+Example to show how bundle variables work.
+
+We will focus on the behavior of the variables section alone. To do so, we exclusively use
+the `validate` command, and use its JSON output mode to focus on the variables section.


Suggested change

Example to show how bundle variables work.

We will focus on the behavior of the variables section alone. To do so, we exclusively use

the `validate` command, and use its JSON output mode to focus on the variables section.

This example shows how to validate and set values for the custom variables defined for a bundle using the `bundle validate` command and its JSON output mode.

I think that is the main intent of this KB, but another sentence could also be added about showing how to set variable defaults. (Update: I tinkered with that suggestion.)

juliacrawf-db · 2024-02-15T06:09:41Z

knowledge_base/bundle_variables/README.md

+
+We will focus on the behavior of the variables section alone. To do so, we exclusively use
+the `validate` command, and use its JSON output mode to focus on the variables section.
+


Are there any prerequisites worth mentioning? It might be a good standard just to list the supported CLI version for any KB?

juliacrawf-db · 2024-02-15T06:11:07Z

knowledge_base/bundle_variables/databricks.yml

+
+  with_default_in_targets:
+    description: This is a variable with its default value defined in the targets section
+


Pedantic, I know, but can we add periods to the end of the sentences on all of these descriptions?

juliacrawf-db · 2024-02-15T18:25:41Z

knowledge_base/bundle_variables/README.md

+We will focus on the behavior of the variables section alone. To do so, we exclusively use
+the `validate` command, and use its JSON output mode to focus on the variables section.
+
+## Usage


This singular heading feels unnecessary and also doesn't seem like quite the right word. I'd either remove it (acceptable for a KB e.g., https://kb.databricks.com/en_US/clusters/calculate-number-of-cores) or break up the content into at least two headings. (I'd lean towards the former.)

juliacrawf-db · 2024-02-15T18:35:17Z

knowledge_base/bundle_variables/README.md

+
+## Usage
+
+Configure the workspace to use:


Suggested change

Configure the workspace to use:

First, configure your workspace:

juliacrawf-db · 2024-02-15T18:50:05Z

knowledge_base/bundle_variables/README.md

+export DATABRICKS_CONFIG_PROFILE="<workspace profile>"
+```
+
+Try to run validate without arguments:


Suggested change

Try to run validate without arguments:

Next, run `bundle validate` using the JSON output mode and `jq` to retrieve just the variables node.

I wasn't sure how this command was "without arguments" but maybe I'm misunderstanding the intent there. Also, I'm not sure if it's necessary to state that last bit as most devs know all about jq, but it feels most complete.

juliacrawf-db · 2024-02-15T18:52:49Z

knowledge_base/bundle_variables/README.md

+Because the configuration includes a variable definition without a value, it returns an error
+saying that the value must be defined:


Suggested change

Because the configuration includes a variable definition without a value, it returns an error

saying that the value must be defined:

Because the configuration includes a variable definition without a value, it returns the following error:

juliacrawf-db · 2024-02-15T18:57:53Z

knowledge_base/bundle_variables/README.md

+Error: no value assigned to required variable "no_default".
+```
+
+Assign a value for this variable by either:


Suggested change

Assign a value for this variable by either:

To assign a value to this variable, you can either:

juliacrawf-db · 2024-02-15T18:59:01Z

knowledge_base/bundle_variables/README.md

+
+Assign a value for this variable by either:
+
+1. Adding a `--var` flag to all bundle commands:


Suggested change

1. Adding a `--var` flag to all bundle commands:

- Add a `--var` flag to all bundle commands:

These aren't steps (numbered list) but a list of options (bulleted list). However, I like making it really clear (see the next comment)...

juliacrawf-db · 2024-02-15T19:00:12Z

knowledge_base/bundle_variables/README.md

+databricks bundle validate --var no_default="injected value"
+```
+
+2. Configuring an environment variable:


Suggested change

2. Configuring an environment variable:

OR

- Configure an environment variable:

(But this might look weird, or not follow our style)

juliacrawf-db · 2024-02-15T19:07:43Z

knowledge_base/bundle_variables/README.md

+```sh
+databricks bundle validate --var no_default="injected value"
+```


Indent these to fit under the bullet.

juliacrawf-db · 2024-02-15T19:08:05Z

knowledge_base/bundle_variables/README.md

+2. Configuring an environment variable:
+```sh
+export BUNDLE_VAR_no_default="injected value"
+```


Indent this to fit under the bullet.

juliacrawf-db · 2024-02-15T19:10:05Z

knowledge_base/bundle_variables/README.md

+export BUNDLE_VAR_no_default="injected value"
+```
+
+Now, try to run validate again, and observe that it passes:


Suggested change

Now, try to run validate again, and observe that it passes:

Now run validate again, and observe that it succeeds in outputting valid JSON:

juliacrawf-db · 2024-02-15T19:11:13Z

knowledge_base/bundle_variables/README.md

+databricks bundle validate --var no_default="injected value" --output json | jq .variables
+```
+
+Example output:


Suggested change

Example output:

juliacrawf-db · 2024-02-15T19:37:20Z

knowledge_base/bundle_variables/README.md

+}
+```
+
+What we've seen:


Suggested change

What we've seen:

In summary:

Example to show how bundle variables work

ed59139

pietern requested review from andrewnester, lennartkats-db, shreyas-goenka and juliacrawf-db February 14, 2024 09:26

andrewnester approved these changes Feb 14, 2024

View reviewed changes

juliacrawf-db reviewed Feb 15, 2024

View reviewed changes

knowledge_base/bundle_variables/README.md

}

```

What we've seen:

Copy link

Contributor

juliacrawf-db Feb 15, 2024

Choose a reason for hiding this comment

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

Suggested change

What we've seen:

In summary:

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Example to show how bundle variables work #21

Example to show how bundle variables work #21

pietern commented Feb 14, 2024

pietern commented Feb 14, 2024

juliacrawf-db Feb 15, 2024 •

edited

Loading

juliacrawf-db Feb 15, 2024 •

edited

Loading

juliacrawf-db Feb 15, 2024 •

edited

Loading

juliacrawf-db Feb 15, 2024

juliacrawf-db Feb 15, 2024 •

edited

Loading

juliacrawf-db Feb 15, 2024

juliacrawf-db Feb 15, 2024

juliacrawf-db Feb 15, 2024

juliacrawf-db Feb 15, 2024

juliacrawf-db Feb 15, 2024

juliacrawf-db Feb 15, 2024

juliacrawf-db Feb 15, 2024

juliacrawf-db Feb 15, 2024

juliacrawf-db Feb 15, 2024 •

edited

Loading

juliacrawf-db Feb 15, 2024

juliacrawf-db Feb 15, 2024

juliacrawf-db Feb 15, 2024

juliacrawf-db Feb 15, 2024 •

edited

Loading

juliacrawf-db Feb 15, 2024

juliacrawf-db Feb 15, 2024


		We will focus on the behavior of the variables section alone. To do so, we exclusively use
		the `validate` command, and use its JSON output mode to focus on the variables section.


		with_default_in_targets:
		description: This is a variable with its default value defined in the targets section

	Configure the workspace to use:
	First, configure your workspace:

	Try to run validate without arguments:
	Next, run `bundle validate` using the JSON output mode and `jq` to retrieve just the variables node.

		Because the configuration includes a variable definition without a value, it returns an error
		saying that the value must be defined:

	Assign a value for this variable by either:
	To assign a value to this variable, you can either:


		Assign a value for this variable by either:

		1. Adding a `--var` flag to all bundle commands:

	1. Adding a `--var` flag to all bundle commands:
	- Add a `--var` flag to all bundle commands:

	Now, try to run validate again, and observe that it passes:
	Now run validate again, and observe that it succeeds in outputting valid JSON:

Example to show how bundle variables work #21

Are you sure you want to change the base?

Example to show how bundle variables work #21

Conversation

pietern commented Feb 14, 2024

pietern commented Feb 14, 2024

juliacrawf-db Feb 15, 2024 • edited Loading

Choose a reason for hiding this comment

juliacrawf-db Feb 15, 2024 • edited Loading

Choose a reason for hiding this comment

juliacrawf-db Feb 15, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

juliacrawf-db Feb 15, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

juliacrawf-db Feb 15, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

juliacrawf-db Feb 15, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

juliacrawf-db Feb 15, 2024 •

edited

Loading

juliacrawf-db Feb 15, 2024 •

edited

Loading

juliacrawf-db Feb 15, 2024 •

edited

Loading

juliacrawf-db Feb 15, 2024 •

edited

Loading

juliacrawf-db Feb 15, 2024 •

edited

Loading

juliacrawf-db Feb 15, 2024 •

edited

Loading