Skip to content

Commit

Permalink
carved out ansible tutorials out of jsonrpc section
Browse files Browse the repository at this point in the history
  • Loading branch information
hellt committed Jul 22, 2023
1 parent 440a43d commit 4b1dba6
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/ansible/collection/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Ansible collection for SR Linux is identified with `nokia.srlinux` fully qualifi
Modules contained within this collection fully conform to the idempotence principles of Ansible, as well as provide first-class support for diff and check functionality[^2].

!!!tip "Tutorial"
Besides examples provided for each module of this collection, checkout [Ansible with SR Linux tutorial](../../tutorials/programmability/json-rpc/ansible.md) to see how to use this collection in practice.
Besides examples provided for each module of this collection, checkout [Ansible with SR Linux tutorial](../../tutorials/programmability/ansible/using-nokia-srlinux-collection.md) to see how to use this collection in practice.

## Modules

Expand Down
8 changes: 7 additions & 1 deletion docs/ansible/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ Ansible is one of the leading configuration management frameworks both in the ap

Nokia provides Ansible users with the [`nokia.srlinux`](collection/index.md) Ansible collection that stores plugins and modules designed to perform automation tasks against Nokia SR Linux Network OS. The modules in `nokia.srlinux` collection are designed in a generic way with universal modules enabling configuration operations.

In contrast to the supported `nokia.srlinux` collection, a community collection `srllabs.srlinux` is in the works where the community memebers work on the network resource modules for SR Linux.
In contrast to the supported `nokia.srlinux` collection, a community collection `srllabs.srlinux` is in the works where the community members work on the network resource modules for SR Linux.

## See also

We strive to create hands-on material demonstrating the use of `nokia.srlinux` collection in various scenarios. The following tutorials, blog posts, and examples may be exactly what you're looking for:

* [Using `nokia.srlinux` Ansible collection](../tutorials/programmability/ansible/using-nokia-srlinux-collection.md) tutorial.

[^1]: Simplicity of a DSL often goes hand with constraints that a DSL has to impose when compared with a generic programming language. This may lead to complications when advanced data processing or branching control is required. For that reason it is common to hear sentiments that Ansible is easy to start with but may become a problem over time when automation tasks become more complex.
2 changes: 1 addition & 1 deletion docs/blog/posts/2022/json-rpc-ansible.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ A few days after we fleshed out our [:material-book: JSON-RPC Basics](../../../t

Quite a lot of network ops teams we've been talking to used Ansible to manage their infra, and they wanted to keep using it for network automation as well. While this is a questionable tactic, we still can give you the "fishing rod".

Please welcome - **[:material-book: Using Ansible with SR Linux's JSON-RPC Interface](../../../tutorials/programmability/json-rpc/ansible.md)** tutorial, which puts our JSON-RPC interface to work under Ansible command through a set of task-oriented exercises.
Please welcome - **[:material-book: Using Ansible with SR Linux's JSON-RPC Interface](../../../tutorials/programmability/ansible/using-nokia-srlinux-collection.md)** tutorial, which puts our JSON-RPC interface to work under Ansible command through a set of task-oriented exercises.
2 changes: 1 addition & 1 deletion docs/blog/posts/2023/ansible-collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ The `cli` module allows you to execute any CLI command on the device and get the

To help you get started, we have created a set of examples that you can use as a reference when developing your own playbooks. These examples are outlined in the "Examples" section for each [module][collection-doc-link].

Besides that, we have adapted the original [Ansible tutorial](../../../tutorials/programmability/json-rpc/ansible.md) to feature the SR Linux collection.
Besides that, we have adapted the original [Ansible tutorial](../../../tutorials/programmability/ansible/using-nokia-srlinux-collection.md) to feature the SR Linux collection.

## Conclusion

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ title: Using Ansible's URI module with SR Linux's JSON-RPC Interface
!!!warning
This is an original tutorial that predate `nokia.srlinux` collection. It uses Ansible's `uri` module to interact with SR Linux's JSON-RPC interface. It is recommended to use `nokia.srlinux` collection instead.

A new version of this tutorial is available [here](ansible.md).
A new version of this tutorial is available [here](using-nokia-srlinux-collection.md).

| Summary | |
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
Expand Down
4 changes: 3 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,8 @@ nav:
- Summary: tutorials/programmability/event-handler/oper-group/summary.md
- JSON-RPC:
- Basics: tutorials/programmability/json-rpc/basics.md
- Ansible: tutorials/programmability/json-rpc/ansible.md
- Ansible:
- Using nokia.srlinux collection: tutorials/programmability/ansible/using-nokia-srlinux-collection.md
- Community: community.md
- Blog:
- blog/index.md
Expand Down Expand Up @@ -178,6 +179,7 @@ plugins:
redirect_maps:
"ndk/intro.md": "ndk/index.md"
"yang/yang.md": "yang/index.md"
"tutorials/programmability/json-rpc/ansible.md": "tutorials/programmability/ansible/using-nokia-srlinux-collection.md"
- git-revision-date-localized:
enable_creation_date: true
enabled: !ENV [CI, false]
Expand Down

0 comments on commit 4b1dba6

Please sign in to comment.