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

Update project for publishing to official Ansible Galaxy #26

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
28 changes: 6 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -317,25 +317,9 @@ The IAP and IAG binary files are hosted on the Itential Nexus repository. An acc

### Online Installation

The Itential Deployer can be installed via the `ansible-galaxy` utility. To do this, [configure Ansible][Ansible Configuration File] to use the Itential and Ansible Galaxy servers when installing collections. On your control node:
The Itential Deployer can be installed via the `ansible-galaxy` utility.

1. Create a blank file named `ansible.cfg` in your working directory. This will be your new Ansible configuration file.
2. Open `ansible.cfg` in a text editor and add the following. Be sure to supply the proper credentials where relevant.

```ini
[galaxy]
server_list = itential_galaxy, release_galaxy

[galaxy_server.itential_galaxy]
url=https://registry.aws.itential.com/repository/ansible-galaxy/
username=<USERNAME>
password=<PASSWORD>

[galaxy_server.release_galaxy]
url=https://galaxy.ansible.com/
```

3. Execute the following command to install the Itential Deployer:
On your control node, execute the following command to install the Itential Deployer:

```bash
ansible-galaxy collection install itential.deployer
Expand All @@ -356,10 +340,10 @@ Some of the following collections may already be installed on your control node.

1. Download the following collections from the provided links:

- [Itential Deployer]
- [Community General]
- [Community MongoDB]
- [Ansible POSIX]
- [Itential Deployer](https://galaxy.ansible.com/ui/repo/published/itential/deployer/)
- [Community General](https://galaxy.ansible.com/ui/repo/published/community/general/)
- [Community MongoDB](https://galaxy.ansible.com/ui/repo/published/community/mongodb/)
- [Ansible POSIX](https://galaxy.ansible.com/ui/repo/published/ansible/posix/)

2. Copy the downloaded collections to your control node.
3. Install the collections using the following command:
Expand Down
19 changes: 9 additions & 10 deletions galaxy.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### REQUIRED

Check failure on line 1 in galaxy.yml

View workflow job for this annotation

GitHub Actions / Ansible Lint

galaxy[tags]

galaxy.yaml must have one of the required tags: ['application', 'cloud', 'database', 'eda', 'infrastructure', 'linux', 'monitoring', 'networking', 'security', 'storage', 'tools', 'windows']
# The namespace of the collection. This can be a company/brand/organization or product namespace under which all
# content lives. May only contain alphanumeric lowercase characters and underscores. Namespaces cannot start with
# underscores or numbers and cannot contain consecutive underscores
Expand All @@ -16,10 +16,11 @@
# A list of the collection's content authors. Can be just the name or in the format 'Full Name <email> (url)
# @nicks:irc/im.site#channel'
authors:
- Peter Sprygada <peter.sprygada@itential.com>
- Steven Schattenberg <steven.schattenberg@itential.com>
- Travis Nicks <travis.nicks@itential.com>
- Kevin Velarde <kevin.velarde@itential.com>
- Steven Schattenberg <steven.schattenberg@itential.com>

Check failure on line 19 in galaxy.yml

View workflow job for this annotation

GitHub Actions / Ansible Lint

yaml[indentation]

Wrong indentation: expected at least 1
- Travis Nicks <travis.nicks@itential.com>
- Kevin Velarde <kevin.velarde@itential.com>
- Peter Sprygada <peter.sprygada@itential.com>
- Nick Andreano <nick.andreano@itential.com>

### OPTIONAL but strongly recommended
# A short summary description of the collection
Expand All @@ -39,8 +40,6 @@
tags:
- itential
- deployer
- automation-platform
- automation-gateway

# Collections that this collection requires to be installed for it to be usable. The key of the dict is the
# collection label 'namespace.name'. The value is a version range
Expand All @@ -51,16 +50,16 @@
'community.mongodb': '>=0.0.1'

# The URL of the originating SCM repository
repository: https://gitlab.com/itential/enablement-tools/ansible/itential-installer/itential-deployer
repository: https://github.com/itential/deployer

# The URL to any online docs
documentation: https://docs.itential.com/docs/using-itential-deployer-2023-1
documentation: https://github.com/itential/deployer/README.md

# The URL to the homepage of the collection/project
homepage: https://gitlab.com/itential/enablement-tools/ansible/itential-installer/itential-deployer
homepage: https://galaxy.ansible.com/ui/repo/published/itential/deployer/

# The URL to the collection issue tracker
issues: https://gitlab.com/itential/enablement-tools/ansible/itential-installer/itential-deployer/-/issues
issues: https://github.com/itential/deployer/issues

# A list of file glob-like patterns used to filter any files or directories that should not be included in the build
# artifact. A pattern is matched from the relative path of the file or directory of the collection directory. This
Expand Down
2 changes: 1 addition & 1 deletion meta/runtime.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---

Check failure on line 1 in meta/runtime.yml

View workflow job for this annotation

GitHub Actions / Ansible Lint

meta-runtime[unsupported-version]

'requires_ansible' key must refer to a currently supported version such as: >=2.15.0, >=2.16.0, >=2.17.0
# Collections must specify a minimum required ansible version to upload
# to galaxy
# requires_ansible: '>=2.9.10'
requires_ansible: '>=2.11.0'

# Content that Ansible needs to load from another location or that has
# been deprecated/removed
Expand Down
Empty file added roles/common_vars/README.md
steven-schattenberg-itential marked this conversation as resolved.
Show resolved Hide resolved
Empty file.
Empty file added roles/gateway/README.md
Empty file.
Empty file added roles/gateway_haproxy/README.md
Empty file.
Empty file added roles/mongodb/README.md
Empty file.
Empty file added roles/mongodb_auth/README.md
Empty file.
Empty file added roles/mongodb_common/README.md
Empty file.
Empty file.
Empty file added roles/mongodb_tls/README.md
Empty file.
Empty file added roles/offline/README.md
Empty file.
Empty file added roles/os/README.md
Empty file.
Empty file added roles/platform/README.md
Empty file.
Empty file.
Empty file added roles/prometheus/README.md
Empty file.
Empty file added roles/python/README.md
Empty file.
Empty file added roles/rabbitmq/README.md
Empty file.
Empty file.
Empty file added roles/rabbitmq_ssl/README.md
Empty file.
Empty file added roles/redis/README.md
Empty file.
Empty file added roles/redis_auth/README.md
Empty file.
Empty file.
Empty file added roles/selinux/README.md
Empty file.
Empty file added roles/vault/README.md
Empty file.
Empty file added roles/vault_unseal/README.md
Empty file.
Loading