Skip to content

update reference to ansible integration repo #205

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.

Sign up for GitHub

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

Open
wisotzky wants to merge 1 commit into
base: main
Choose a base branch
from
Open

update reference to ansible integration repo #205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/ansible/collection/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -577,7 +577,7 @@ The `config` module supports per-task [commit confirmation](#confirm_timeout). T
Config module is implemented in the [`config.py`][config-gh-url] file.

[ansible-check-diff]: https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_checkmode.html
[config-gh-url]: https://github.com/nokia/srlinux-ansible-collection/blob/main/plugins/modules/config.py
[config-gh-url]: https://github.com/nokia/srlinux-ansible-integration/blob/main/plugins/modules/config.py

[^1]: Effectively, the configuration is sent twice to the device. First, to check if a diff is non-empty, and if not, second time to apply the configuration set. In this case, the diff happens on SR Linux box and is not calculated locally.
[^2]: The diff returned is the same as the one returned by the `diff` CLI command.
2 changes: 1 addition & 1 deletion docs/ansible/collection/get.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,4 +344,4 @@ ok: [clab-ansible-srl] => {

Get module is implemented in the [`get.py`][get-gh-url] file.

[get-gh-url]: https://github.com/nokia/srlinux-ansible-collection/blob/main/plugins/modules/get.py
[get-gh-url]: https://github.com/nokia/srlinux-ansible-integration/blob/main/plugins/modules/get.py
8 changes: 4 additions & 4 deletions docs/ansible/collection/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Ansible collection for SR Linux is identified with `nokia.srlinux` fully qualifi
| **Collection name** | `nokia.srlinux` |
| **Galaxy URL** | [nokia/srlinux][coll-url] |
| **Ansible Automation Platform** | [nokia/srlinux][aap-coll-url] |
| **Github repository** | [nokia/srlinux-ansible-collection][repo-url] |
| **Github repository** | [nokia/srlinux-ansible-integration][repo-url] |
| **Tutorial** | [Using nokia.srlinux collection][tutorial-link] |
| **SR Linux version** | >=23.3.1[^1] |
| **Python version** | >=3.10 |
Expand Down Expand Up @@ -115,7 +115,7 @@ Collection is installed at the collections path. Default location is `~/.ansible

### Container image

To simplify the usage of the collection, we provide a container image that contains the collection and all its dependencies. To accommodate for the different Ansible versions, we provide multiple images based on the underlying `ansible-core` and the python version. The full list of available images and their tags can be found in the [Github container registry](https://github.com/orgs/nokia/packages?repo_name=srlinux-ansible-collection).
To simplify the usage of the collection, we provide a container image that contains the collection and all its dependencies. To accommodate for the different Ansible versions, we provide multiple images based on the underlying `ansible-core` and the python version. The full list of available images and their tags can be found in the [Github container registry](https://github.com/orgs/nokia/packages?repo_name=srlinux-ansible-integration).

The easiest way to use the image is to create an alias for the `ansible-playbook` command.

Expand All @@ -124,7 +124,7 @@ alias ansible-playbook="docker run --rm -it \
-v $(pwd):/ansible \
-v ~/.ssh:/root/.ssh \
-v /etc/hosts:/etc/hosts \
ghcr.io/nokia/srlinux-ansible-collection/2.15.5/py3.11:v0.3.0 ansible-playbook $@"
ghcr.io/nokia/srlinux-ansible-integration/2.15.5/py3.11:v0.3.0 ansible-playbook $@"
```

???tip "How to test this container?"
Expand Down Expand Up @@ -256,7 +256,7 @@ Save the file as `ansible.clab.yml` and deploy the lab with `containerlab deploy
Create the `hosts` file as shown in the previous section and you're ready to tryout the modules of this collection.

[coll-url]: https://galaxy.ansible.com/nokia/srlinux/
[repo-url]: https://github.com/nokia/srlinux-ansible-collection
[repo-url]: https://github.com/nokia/srlinux-ansible-integration
[get]: get.md
[config]: config.md
[cli]: cli.md
Expand Down
2 changes: 1 addition & 1 deletion docs/blog/posts/2023/ansible-collection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ We hope that you will find the SR Linux collection useful and will be able to us

The `cli` module should help you with operational tasks and the `check` and `diff` modes should make your automation more robust and error-proof.

We are eager to hear from you if you find any functionality missing or if you have any suggestions on how to improve the collection. Please leave comments below or [open an issue](https://github.com/nokia/srlinux-ansible-collection/issues) on GitHub.
We are eager to hear from you if you find any functionality missing or if you have any suggestions on how to improve the collection. Please leave comments below or [open an issue](https://github.com/nokia/srlinux-ansible-integration/issues) on GitHub.

[collection-doc-link]: ../../../ansible/collection/index.md
[config-module]: ../../../ansible/collection/config.md
Expand Down
6 changes: 3 additions & 3 deletions docs/tutorials/programmability/ansible/using-nokia-srlinux-collection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,9 +137,9 @@ all:
### Container

Ansible is infamous for breaking things when you least expect it. For that reason, we [caged](../../../ansible/collection/index.md#container-image) the beast.
We [created a pipeline](https://github.com/nokia/srlinux-ansible-collection/blob/main/.github/workflows/container-build.yml) that builds container images for each release of our collection making sure that our users have one worry less during their automation journey.
We [created a pipeline](https://github.com/nokia/srlinux-ansible-integration/blob/main/.github/workflows/container-build.yml) that builds container images for each release of our collection making sure that our users have one worry less during their automation journey.

Throughout this tutorial we will be using `ghcr.io/nokia/srlinux-ansible-collection/2.15.5/py3.11:v0.3.0` container image that as the url suggests is based on `ansible-core==2.15.5` with `python 3.11` running srlinux collection v0.3.0.
Throughout this tutorial we will be using `ghcr.io/nokia/srlinux-ansible-integration/2.15.5/py3.11:v0.3.0` container image that as the url suggests is based on `ansible-core==2.15.5` with `python 3.11` running srlinux collection v0.3.0.

To save some finger energy we will create a handy alias `ansible-playbook` that runs our container image with the `ansible-inventory.yml` file being already loaded:

Expand All @@ -148,7 +148,7 @@ alias ansible-playbook='docker run --rm -it \
-v $(pwd):/ansible \(1)
-v ~/.ssh:/root/.ssh \(2)
-v /etc/hosts:/etc/hosts \(3)
ghcr.io/nokia/srlinux-ansible-collection/2.15.5/py3.11:v0.4.0 \
ghcr.io/nokia/srlinux-ansible-integration/2.15.5/py3.11:v0.4.0 \
ansible-playbook -i clab-2srl/ansible-inventory.yml $@'
```

Expand Down