forked from puppetlabs/bolt
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
(puppetlabsGH-2078) Add Bolt guide pages
This adds a new CLI command and PowerShell cmdlet which display information about various Bolt topics. The guides are read from text files that are saved in the `guides` directory, and are only loaded when a specific guide is being requested. To show a list of available guides: - **Unix shell command** ``` $ bolt guide ``` - **PowerShell cmdlet** ``` Get-BoltGuide ``` To view the guide for a specific topic: - **Unix shell command** ``` $ bolt guide inventory ``` - **PowerShell cmdlet** ``` Get-BoltGuide -Topic inventory ``` This also adds an analytics event for both known guides and unknown guides. This allows Bolt to collect data about which guides users are viewing and which guides users may expect to be available. !feature * **View information about Bolt concepts and features from the CLI** ([puppetlabs#2078](puppetlabs#2078)) Bolt can now display information about various Bolt features and concepts with the new CLI command `bolt guide` and PowerShell cmdlet `Get-BoltGuide`.
- Loading branch information
Showing
15 changed files
with
363 additions
and
5 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
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
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,45 @@ | ||
TOPIC | ||
inventory | ||
|
||
DESCRIPTION | ||
The inventory describes the targets that you run Bolt commands on, along | ||
with any data and configuration for the targets. Targets in an inventory can | ||
belong to one or more groups, allowing you to share data and configuration | ||
across multiple targets and to specify multiple targets for your Bolt | ||
commands without the need to list each target individually. | ||
|
||
In most cases, the inventory is loaded from an inventory file in your Bolt | ||
project. The inventory file is a YAML file named 'inventory.yaml'. Because | ||
the inventory file is only loaded from a Bolt project, you must have an | ||
existing project configuration file named 'bolt-project.yaml' alongside the | ||
inventory file. | ||
|
||
EXAMPLE | ||
The structure of an inventory file will vary depending on your project's | ||
specific needs. The following example shows an inventory with targets | ||
grouped by operating system: | ||
|
||
--- | ||
# inventory.yaml | ||
groups: | ||
- name: linux | ||
targets: | ||
- nix-1.example.org | ||
- nix-2.example.org | ||
config: | ||
ssh: | ||
user: bolt | ||
password: puppet | ||
- name: windows | ||
targets: | ||
- win-1.example.org | ||
- win-2.example.org | ||
config: | ||
transport: winrm | ||
winrm: | ||
user: bolt | ||
password: puppet | ||
|
||
DOCUMENTATION | ||
pup.pt/bolt-inventory | ||
pup.pt/bolt-inventory-reference |
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,39 @@ | ||
TOPIC | ||
project | ||
|
||
DESCRIPTION | ||
A Bolt project is a directory that serves as the launching point for Bolt | ||
and allows you to create a shareable orchestration application. Projects | ||
typically include a project configuration file, an inventory file, and any | ||
content you use in your project workflow, such as tasks and plans. | ||
|
||
When you run Bolt, it runs in the context of a project. If the directory you | ||
run Bolt from is not a project, then Bolt will attempt to find a project by | ||
traversing the parent directories. If Bolt is unable to find a project, it | ||
will run from the default project, located at '~/.puppetlabs/bolt'. | ||
|
||
A directory is only considered a Bolt project when it has a project | ||
configuration file named 'bolt-project.yaml'. Project data and content, | ||
including inventory files, are not loaded by Bolt unless they are part of | ||
a project. | ||
|
||
EXAMPLES | ||
To designate a directory as a Bolt project, use the following command: | ||
|
||
bolt project init | ||
|
||
The following example shows a project configuration file for a project named | ||
'myproject'. It also includes additional configuration that limits the plans | ||
and tasks that are visible to the project's users: | ||
|
||
--- | ||
# bolt-project.yaml | ||
name: myproject | ||
plans: | ||
- myproject::myplan | ||
tasks: | ||
- myproject::mytask | ||
|
||
DOCUMENTATION | ||
pup.pt/bolt-projects | ||
pup.pt/bolt-project-reference |
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
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
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
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.