You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Creating ansible content using ansible-creator and VS Code Ansible extension
2
+
3
+
- For users who prefer a graphical interface, ansible-creator seamlessly integrates with the [Visual Studio Code (VS Code)](https://code.visualstudio.com/docs) and the [Ansible extension](https://marketplace.visualstudio.com/items?itemName=redhat.ansible) for it, offering an intuitive GUI experience.
4
+
5
+
- By navigating to the Ansible section in the VS Code activity bar and selecting "Ansible Development Tools," users can access a menu-driven interface.
6
+
7
+
- This GUI provides interactive forms for straightforward input. So you can effortlessly manage your Ansible content without delving into the intricacies of command-line operations.
8
+
9
+
- Here is a detailed [guide](https://ansible.readthedocs.io/projects/vscode-ansible/) on creating an ansible content using the ansible-creator and VS Code Ansible extension.
10
+
11
+
#TO-DO: Add VS Code extension guide here when its available.
Copy file name to clipboardExpand all lines: docs/index.md
+1-5Lines changed: 1 addition & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -8,11 +8,7 @@ hide:
8
8
9
9
The `ansible-creator` is a Command-Line Interface (CLI) tool designed for effortlessly scaffolding all your Ansible content. Whether you are initializing an Ansible Collection or creating the framework for specific plugins, this tool streamlines the process with efficiency and precision based on your requirements.
10
10
11
-
This documentation serves as a detailed guide for using ansible-creator, emphasizing the 'init' functionality for initializing Ansible Collections. Stay tuned for updates on the 'create' branch that will bring new features to enhance your Ansible workflow.
12
-
13
-
## Upcoming Features
14
-
15
-
The `add` command is currently under development which will allow you scaffold ansible plugins of your choice.
11
+
This documentation serves as a detailed guide for using ansible-creator, emphasizing the 'init' and 'add' functionalities. The 'init' functionality initializes a new Ansible project whereas 'add' enables you to add resources to an existing ansible project.
Copy file name to clipboardExpand all lines: docs/installing.md
+57-23Lines changed: 57 additions & 23 deletions
Original file line number
Diff line number
Diff line change
@@ -14,9 +14,9 @@ $ pip install ansible-creator
14
14
15
15
## CLI Usage
16
16
17
-
The Command-Line Interface (CLI) for ansible-creator provides a straightforward and efficient way to interact with the tool. Users can initiate actions, such as initializing Ansible Collections, through concise commands. The CLI is designed for simplicity, allowing users to execute operations with ease and without the need for an extensive understanding of the tool's intricacies. It serves as a flexible and powerful option for users who prefer command-line workflows, enabling them to integrate ansible-creator seamlessly into their development processes.
17
+
The Command-Line Interface (CLI) for ansible-creator provides a straightforward and efficient way to interact with the tool. Users can initiate actions, such as initializing Ansible Collections and other Ansible Projects, through concise commands. The CLI is designed for simplicity, allowing users to execute operations with ease and without the need for an extensive understanding of the tool's intricacies. It serves as a flexible and powerful option for users who prefer command-line workflows, enabling them to integrate ansible-creator seamlessly into their development processes.
18
18
19
-
If command line is not your preferred method, you can also leverage the GUI interface within VS Code's Ansible extension that offers a more visually intuitive experience of ansible-creator. See [here](collection_creation.md).
19
+
If command line is not your preferred method, you can also leverage the GUI interface within VS Code's Ansible extension that offers a more visually intuitive experience of ansible-creator. See [here](content_creation.md).
20
20
21
21
## Command line completion
22
22
@@ -35,7 +35,9 @@ Get an overview of available commands and options by running:
35
35
$ ansible-creator --help
36
36
```
37
37
38
-
### Initialize an Ansible collection project
38
+
## Initialize projects
39
+
40
+
### Initialize Ansible collection project
39
41
40
42
The `init collection` command enables you to initialize an Ansible collection project. Use the following command template:
41
43
@@ -282,7 +284,38 @@ It also comes equipped with Github Action Workflows that use [ansible-content-ac
282
284
283
285
Please ensure that you review any potential `TO-DO` items in the scaffolded content and make the necessary modifications according to your requirements.
284
286
285
-
### Add support to existing project
287
+
### Initialize execution environment project
288
+
289
+
The `init execution_env` command enables you to initialize an Ansible execution environment project. Use the following command template:
Running the `init execution_env` command generates an Ansible execution environment project with a comprehensive directory structure. Explore it using:
306
+
307
+
```console
308
+
$ tree -la /home/user/ansible-projects/ee-project
309
+
.
310
+
├── .github
311
+
│ └── workflows
312
+
│ └── ci.yml
313
+
├── .gitignore
314
+
├── README.md
315
+
└── execution-environment.yml
316
+
```
317
+
318
+
## Add resources
286
319
287
320
The `add` subcommand allows users to scaffold content types like resources and plugins into an existing project. This feature is designed to streamline the development environment setup by automatically generating the necessary configuration files.
0 commit comments