Skip to content

Commit

Permalink
revisions
Browse files Browse the repository at this point in the history
  • Loading branch information
quirogas committed Jul 12, 2023
1 parent 5d20dd0 commit cbfe133
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 11 deletions.
22 changes: 13 additions & 9 deletions docs/get_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,16 +97,20 @@ the creation of a new management pack project.

8. `Select a template for your project`

`Sample Adapter`: Comes with a template adapter that collects several objects and metrics from the container the adapter is running.
The template adapter has comments throughout its code that explain what the code does and how to customize it for your adapter.
Both of the available options will generate a project structure that can be modified into an adapter:

`New Adapter`: Comes without any examples, just the necessary methods and minimal comments and code to implement test
connection, collection, adapter definition, and endpoints logic.
`Sample Adapter`: Creates a template adapter that collects several objects and metrics from the container the adapter is running.
The template adapter has comments throughout its code that explain what the code does and how to customize it for your adapter.

For complete documentation of the `mp-init` tool including an overview of its output, see the [MP Initialization Tool Documentation](references/mp-init.md).
`New Adapter`: Creates methods, minimal comments, and code necessary to implement test
connection, collection, adapter definition, and endpoints logic.

### Template Projects
Every new project creates a file system that has the basic project structure required to develop and build a Management Pack.
Select **Sample Adapter** if you are following along the walkthrough.
For complete documentation of the `mp-init` tool including an overview of its output,
see the [MP Initialization Tool Documentation](references/mp-init.md).

### Project Templates
Both templates create a file system that has the basic project structure required to develop and build a Management Pack.
Each file and directory is discussed in depth in the [mp-init](references/mp-init.md) documentation. `app/adapter.py` is the adapter's
entry point and the best starting point. Users can pick between two entry points when creating their project:

Expand Down Expand Up @@ -155,7 +159,7 @@ Each method is described below:
when using advanced features of the `describe.xml` file that are not present in this method.


For further guidance on using the template project, consult the `Guides` section.
For further guidance on using the sample adapter, consult the `Guides` section.

### Testing a Management Pack

Expand Down Expand Up @@ -191,7 +195,7 @@ saved per project, and can be reused when re-running the `mp-test` tool.

???+ note

In the template project, the only connection parameter is `ID`, and because it connects to the container it is running on,
In the sample adapter, the only connection parameter is `ID`, and because it connects to the container it is running on,
this parameter is not necessary; it is only there as an example, and can be set to any value. The template also implements an
example Test Connection. If a Test Connection is run (see below), with the `ID` set to the text `bad`, then the Test Connection
will fail.
Expand Down
4 changes: 2 additions & 2 deletions docs/references/mp-init.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@

## Purpose

The mp-init tool generates a template project that contains all the requirements to develop a Management Pack with a
The `mp-init` tool generates project templates that contain all the requirements to develop a Management Pack with a
containerized adapter for VMware Aria Operations. To build a Management Pack, use the [build tool](mp-build.md). When
calling `mp-init`, the user will be prompted with a series of questions. The script will use these questions to generate
an initial project structure and create classifiers that other tools and VMware Aria Operations will use.

## Prerequisites
* The [VMware Aria Operations Integration SDK](../index.md#installation) is installed, with the virtual environment active.
* The [VMware Aria Operations Integration SDK](../get_started.md#installation) is installed, with the virtual environment active.

## Input

Expand Down

0 comments on commit cbfe133

Please sign in to comment.