Skip to content
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

Enhancement/registry setup instructions #234

Merged
merged 27 commits into from
Jul 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
81e5692
Fix anchor
quirogas Jul 12, 2023
d224b05
Fix anchor and update container FAQ
quirogas Jul 12, 2023
a9ad10f
Update index page
quirogas Jul 13, 2023
cfcb071
Move troubleshooting and FAQ page to directory index
quirogas Jul 13, 2023
4b44949
Breakdown troubleshooting and FAQ into multiple sections
quirogas Jul 13, 2023
c0704d3
Update index page and move API comments to other
quirogas Jul 13, 2023
cf35f9e
Delete API section
quirogas Jul 13, 2023
fa5d5fa
Update links
quirogas Jul 13, 2023
9226793
Add index descriptions
quirogas Jul 13, 2023
833bcc3
Revise troubleshooting and FAQ contents page
quirogas Jul 14, 2023
588db82
Re-arrange sections order
quirogas Jul 14, 2023
87bf09b
Improve TS and FAQs pages tittle
quirogas Jul 14, 2023
7a5ec67
Merge branch 'main' into enhancement/registry-setup-instructions
quirogas Jul 14, 2023
cec2a9e
Update docs/troubleshooting_and_faq/container_registries.md
quirogas Jul 14, 2023
4831244
Code revision after feedback
quirogas Jul 14, 2023
69f1537
Add docker daemon socker troubleshooting steps to docker FAQs page
quirogas Jul 16, 2023
64b7271
Remove icons from pymdownx.emoji to prevent linting error
quirogas Jul 17, 2023
ac3afe9
Merge branch 'enhancement/registry-setup-instructions' of github.com:…
quirogas Jul 17, 2023
cff3032
Add docker daemon as requirement for tools and add tooltip for Docker…
quirogas Jul 17, 2023
fe4adcc
change admonition wording
quirogas Jul 17, 2023
4ec7515
Change Collections -> mp-test
quirogas Jul 17, 2023
fa89eca
remove platform page from troubleshooting
quirogas Jul 17, 2023
3d4295e
Update docs/troubleshooting_and_faq/collections.md
quirogas Jul 17, 2023
e8ba43f
remove duplicates
quirogas Jul 17, 2023
61d5275
Remove reference to removed page
quirogas Jul 17, 2023
c3392e2
Add amonitions in mp-test and mp-build FAQs page that reference Docke…
quirogas Jul 17, 2023
61be610
Merge branch 'enhancement/registry-setup-instructions' of github.com:…
quirogas Jul 17, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions docs/.pages
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
nav:
- index.md
- introduction.md
- get_started.md
- get_started.md
- guides
- examples.md
- references
- ...
- troubleshooting_and_faq.md

- ...
- Troubleshooting and FAQs: troubleshooting_and_faq
4 changes: 2 additions & 2 deletions docs/get_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ Other operating systems may be compatible.
The Management Packs generated by the VMware Aria Operations Integration SDK will only run on versions that support containerized Management Packs. Currently, this is limited to on-prem installs, version 8.10 or later.
In addition, at least one Cloud Proxy (also version 8.10 or later) must be set up in VMware Aria Operations, as containerized Management Packs must be run on a Cloud Proxy collector.

#### Dependencies
#### Prerequisites

* Docker 20.10.0 or later. Updating to the latest stable version is recommended. For instructions on installing Docker,
go to [Docker's installation documentation](https://docs.docker.com/engine/install/),
follow the instructions provided for your operating system. Finally, make sure the Docker default socket is enabled in the
**Advanced** tab in **Settings** (version 4.18.0 and above).
* Container registry with read and write access (see [FAQ and Troubleshooting](troubleshooting_and_faq.md#why-do-i-need-a-container-registry) for additional information).
* Container registry with read and write access (see [Container Registries (FAQs)](./troubleshooting_and_faq/container_registries.md#why-do-i-need-a-container-registry) for additional information).
* Python3 3.9.0 or later. Updating to the latest stable version is recommended. Python 3.8 and earlier (including Python2) are not supported. For instructions on installing Python, go
to [Python's installation documentation](https://wiki.python.org/moin/BeginnersGuide/Download),
and follow the instructions provided for your operating system.
Expand Down
7 changes: 7 additions & 0 deletions docs/references/mp-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,14 @@ any tests on the adapter; to test the adapter code, use the [test tool](mp-test.
* The [VMware Aria Operations Integration SDK](../index.md#installation) is installed, with the virtual environment active.
* A Management Pack project created by the [mp-init](mp-init.md) tool.
* Write permissions to a container registry that is accessible from VMware Aria Operations.
* Access to the Docker daemon

???+ info

When the Docker daemon is not accessible, mp-init might crash with the "Cannot connect to the Docker daemon"
error. For more information about this error, visit the [Docker](../troubleshooting_and_faq/docker.md#when-using-mp-test-and-mp-build-i-get-a-cannot-connect-to-the-docker-daemon-error)
Troubleshooting and FAQs section.

## Input

### Command-line Arguments
Expand Down
7 changes: 7 additions & 0 deletions docs/references/mp-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,13 @@ If the test tool runs error-free on each endpoint, then the Management Pack shou

* The [VMware Aria Operations Integration SDK](../index.md#installation) is installed, with the virtual environment active.
* A Management Pack project created by the [mp-init](mp-init.md) tool.
* Access to the Docker daemon

???+ info

When the Docker daemon is not accessible, mp-init might crash with the "Cannot connect to the Docker daemon"
error. For more information about this error, visit the [Docker](../troubleshooting_and_faq/docker.md#when-using-mp-test-and-mp-build-i-get-a-cannot-connect-to-the-docker-daemon-error)
Troubleshooting and FAQs section.

## Input

Expand Down
273 changes: 0 additions & 273 deletions docs/troubleshooting_and_faq.md

This file was deleted.

3 changes: 3 additions & 0 deletions docs/troubleshooting_and_faq/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
nav:
- ...
- other.md
33 changes: 33 additions & 0 deletions docs/troubleshooting_and_faq/build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# mp-build


### mp-build returns 'Unable to build pak file'

In most cases, this error indicates issues with building the container image. The most probable causes are:

1. Unknown Instruction :

```
mp-build
Building adapter [Finished]
Unable to build pak file
ERROR: Unable to build Docker file at /Users/user/code/aria_ops/management-packs/test:
{'message': 'dockerfile parse error line 7: unknown instruction: COP'}

```
2. A command inside the Dockerfile failed:

```
mp-build
Building adapter [Finished]
Unable to build pak file
ERROR: Unable to build Docker file at /Users/user/code/management-packs/test:
The command '/bin/sh -c pip3 install -r adapter_requirements.txt --upgrade' returned a non-zero code: 1
```
The solution for case 1 to fix the typo/command by editing the Dockerfile. For case 2, however, the solution might not be evident at first sight. Since the error
comes from building the image itself, we can run `docker build .` in the project's root directory and look at the stack trace for clues.

???+ info

For issues regarding mp-build and docker, see [Docker's](docker.md) page.

Loading
Loading