netadopt 0.1.0__tar.gz

netadopt-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026-present Michal Bakalarski and Netclab Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

netadopt-0.1.0/PKG-INFO

@@ -0,0 +1,178 @@
+Metadata-Version: 2.4
+Name: netadopt
+Version: 0.1.0
+Summary: Read a network-automation repository and adopt its model into Kubernetes
+Keywords: arista,avd,ansible,kubernetes,network automation
+Author: mbakalarski
+Author-email: mbakalarski <64490638+mbakalarski@users.noreply.github.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: System Administrators
+Classifier: Intended Audience :: Telecommunications Industry
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: System :: Networking
+Classifier: Topic :: System :: Systems Administration
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: rich>=15.0.0
+Requires-Dist: typer>=0.27.2
+Requires-Dist: ansible-core ; extra == 'ansible'
+Requires-Python: >=3.12
+Project-URL: Repository, https://github.com/netclab/netadopt
+Project-URL: Issues, https://github.com/netclab/netadopt/issues
+Project-URL: Releases, https://github.com/netclab/netadopt/releases
+Provides-Extra: ansible
+Description-Content-Type: text/markdown
+
+# netadopt
+
+Reads a network-automation repository, says what is in it, and writes the
+repository's model as Kubernetes resources. It reads *repositories*, never devices.
+
+Arista AVD first: netadopt uses AVD's own data model - no new schema, no translation.
+The objects carry the repository's inventory, play and vars exactly as written.
+
+## Installing
+
+With [uv](https://docs.astral.sh/uv/):
+
+```
+uv tool install netadopt
+```
+
+or, to run it once without installing:
+
+```
+uvx netadopt avd report ./repo --playbook build.yml
+```
+
+netadopt uses the Ansible already on `PATH`. On a machine without one, the `ansible`
+extra brings ansible-core along:
+
+```
+uv tool install "netadopt[ansible]"
+```
+
+```
+uvx "netadopt[ansible]" avd report ./repo --playbook build.yml
+```
+
+## Reading an AVD repository
+
+Run on AVD's `single-dc-l3ls` example:
+
+```
+$ netadopt avd report single-dc-l3ls --playbook build.yml
+single-dc-l3ls
+
+Ansible     ansible-core 2.21.3    ~/.local/bin/ansible-playbook
+Config      ansible.cfg
+Inventory   named by ansible.cfg   8 hosts, 8 groups
+Variables   8 files                group_vars 8, host_vars 0
+Playbook    build.yml              1 play
+
+#   Play                                     Hosts    Roles
+─────────────────────────────────────────────────────────────────────────────────────
+0   Build Configurations and Documentation   FABRIC   eos_designs, eos_cli_config_gen
+
+Carried
+  Fabric         single-dc-l3ls, from play 0
+  FabricInputs   7
+
+Warnings
+  ansible_password   plain text in FabricInput single-dc-l3ls-fabric, carried as the repository has it
+```
+
+- **Carried** is what `emit` writes.
+- **Not carried** is what it leaves behind, each with the reason. On AVD's
+  `cv-pathfinder` example, the vault password:
+
+  ```
+  Not carried
+    .vault   the vault password; create its Secret:
+      kubectl create secret generic cv-pathfinder-vault --from-file=password=cv-pathfinder/.vault
+  ```
+
+- **Warnings** are carried, but worth knowing: a password in plain text, a vars file
+  for a host the inventory does not have.
+
+Exit codes: `0` when the model is carried whole, warnings or not; `2` when a part of
+it is not carried or something did not read; `1` when there is no Ansible at all.
+
+## Writing Kubernetes manifests
+
+```
+$ netadopt avd emit single-dc-l3ls --playbook build.yml > single-dc-l3ls.yaml
+```
+
+One `Fabric` - the play, the inventory and `ansible.cfg`, as written - and one
+`FabricInput` per group or host that carries vars:
+
+```yaml
+apiVersion: avd.netclab.dev/v1alpha1
+kind: FabricInput
+metadata:
+  name: single-dc-l3ls-dc1
+  labels:
+    avd.netclab.dev/fabric: single-dc-l3ls
+spec:
+  appliesTo:
+    group: DC1
+  beside: inventory
+  design:
+    mgmt_gateway: 172.16.1.1
+    management_eapi:
+      enabled: true
+```
+
+Group and host names stay the repository's; only `metadata.name` is spelled for
+Kubernetes. The YAML goes to stdout and everything said about it to stderr.
+
+Apply them server-side:
+
+```
+kubectl apply --server-side -f single-dc-l3ls.yaml
+```
+
+A plain `kubectl apply` drops every `key: null` in a map, and AVD reads a null
+differently from a missing key.
+
+## Before running it on someone else's repository
+
+`report` asks Ansible about the inventory, in the repository. Ansible then runs
+whatever the repository gives it: an executable inventory, and the plugin directories
+named in its `ansible.cfg`. `report` names both under Warnings - after running them.
+
+`emit` runs no Ansible; it only reads files. Neither command renders Jinja, so a
+`lookup('pipe', ...)` in the vars runs only where the design is rendered.
+
+Neither connects to a device.
+
+## Tested on AVD's own repositories
+
+Each release is tested on the examples and test scenarios that ship with AVD, at the
+release `netadopt --version` names. Every one that can be carried is emitted, rebuilt
+from the objects, and resolved by Ansible on both sides, and every host must end up
+with the same variables.
+
+## Limits
+
+- The inventory must be a YAML file. An executable or dynamic inventory is not
+  carried.
+- A code directory named in `ansible.cfg`, such as `vars_plugins = plugins/vars`, is not
+  carried.
+- One play per `Fabric`. Another play of the same playbook is another run:
+  `--play N --name NAME`.
+
+## Where this is going
+
+- The same proof on your own repository, not only a report.
+- A second ecosystem after AVD, under a subcommand of its own, with its model kept as
+  its vendor writes it.
+
+## License
+
+[Apache-2.0](LICENSE)

netadopt-0.1.0/README.md

@@ -0,0 +1,149 @@
+# netadopt
+
+Reads a network-automation repository, says what is in it, and writes the
+repository's model as Kubernetes resources. It reads *repositories*, never devices.
+
+Arista AVD first: netadopt uses AVD's own data model - no new schema, no translation.
+The objects carry the repository's inventory, play and vars exactly as written.
+
+## Installing
+
+With [uv](https://docs.astral.sh/uv/):
+
+```
+uv tool install netadopt
+```
+
+or, to run it once without installing:
+
+```
+uvx netadopt avd report ./repo --playbook build.yml
+```
+
+netadopt uses the Ansible already on `PATH`. On a machine without one, the `ansible`
+extra brings ansible-core along:
+
+```
+uv tool install "netadopt[ansible]"
+```
+
+```
+uvx "netadopt[ansible]" avd report ./repo --playbook build.yml
+```
+
+## Reading an AVD repository
+
+Run on AVD's `single-dc-l3ls` example:
+
+```
+$ netadopt avd report single-dc-l3ls --playbook build.yml
+single-dc-l3ls
+
+Ansible     ansible-core 2.21.3    ~/.local/bin/ansible-playbook
+Config      ansible.cfg
+Inventory   named by ansible.cfg   8 hosts, 8 groups
+Variables   8 files                group_vars 8, host_vars 0
+Playbook    build.yml              1 play
+
+#   Play                                     Hosts    Roles
+─────────────────────────────────────────────────────────────────────────────────────
+0   Build Configurations and Documentation   FABRIC   eos_designs, eos_cli_config_gen
+
+Carried
+  Fabric         single-dc-l3ls, from play 0
+  FabricInputs   7
+
+Warnings
+  ansible_password   plain text in FabricInput single-dc-l3ls-fabric, carried as the repository has it
+```
+
+- **Carried** is what `emit` writes.
+- **Not carried** is what it leaves behind, each with the reason. On AVD's
+  `cv-pathfinder` example, the vault password:
+
+  ```
+  Not carried
+    .vault   the vault password; create its Secret:
+      kubectl create secret generic cv-pathfinder-vault --from-file=password=cv-pathfinder/.vault
+  ```
+
+- **Warnings** are carried, but worth knowing: a password in plain text, a vars file
+  for a host the inventory does not have.
+
+Exit codes: `0` when the model is carried whole, warnings or not; `2` when a part of
+it is not carried or something did not read; `1` when there is no Ansible at all.
+
+## Writing Kubernetes manifests
+
+```
+$ netadopt avd emit single-dc-l3ls --playbook build.yml > single-dc-l3ls.yaml
+```
+
+One `Fabric` - the play, the inventory and `ansible.cfg`, as written - and one
+`FabricInput` per group or host that carries vars:
+
+```yaml
+apiVersion: avd.netclab.dev/v1alpha1
+kind: FabricInput
+metadata:
+  name: single-dc-l3ls-dc1
+  labels:
+    avd.netclab.dev/fabric: single-dc-l3ls
+spec:
+  appliesTo:
+    group: DC1
+  beside: inventory
+  design:
+    mgmt_gateway: 172.16.1.1
+    management_eapi:
+      enabled: true
+```
+
+Group and host names stay the repository's; only `metadata.name` is spelled for
+Kubernetes. The YAML goes to stdout and everything said about it to stderr.
+
+Apply them server-side:
+
+```
+kubectl apply --server-side -f single-dc-l3ls.yaml
+```
+
+A plain `kubectl apply` drops every `key: null` in a map, and AVD reads a null
+differently from a missing key.
+
+## Before running it on someone else's repository
+
+`report` asks Ansible about the inventory, in the repository. Ansible then runs
+whatever the repository gives it: an executable inventory, and the plugin directories
+named in its `ansible.cfg`. `report` names both under Warnings - after running them.
+
+`emit` runs no Ansible; it only reads files. Neither command renders Jinja, so a
+`lookup('pipe', ...)` in the vars runs only where the design is rendered.
+
+Neither connects to a device.
+
+## Tested on AVD's own repositories
+
+Each release is tested on the examples and test scenarios that ship with AVD, at the
+release `netadopt --version` names. Every one that can be carried is emitted, rebuilt
+from the objects, and resolved by Ansible on both sides, and every host must end up
+with the same variables.
+
+## Limits
+
+- The inventory must be a YAML file. An executable or dynamic inventory is not
+  carried.
+- A code directory named in `ansible.cfg`, such as `vars_plugins = plugins/vars`, is not
+  carried.
+- One play per `Fabric`. Another play of the same playbook is another run:
+  `--play N --name NAME`.
+
+## Where this is going
+
+- The same proof on your own repository, not only a report.
+- A second ecosystem after AVD, under a subcommand of its own, with its model kept as
+  its vendor writes it.
+
+## License
+
+[Apache-2.0](LICENSE)

netadopt-0.1.0/pyproject.toml

@@ -0,0 +1,60 @@
+[project]
+name = "netadopt"
+version = "0.1.0"
+description = "Read a network-automation repository and adopt its model into Kubernetes"
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+keywords = [
+    "arista",
+    "avd",
+    "ansible",
+    "kubernetes",
+    "network automation",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: System Administrators",
+    "Intended Audience :: Telecommunications Industry",
+    "Operating System :: POSIX",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: System :: Networking",
+    "Topic :: System :: Systems Administration",
+]
+requires-python = ">=3.12"
+dependencies = [
+    "pyyaml>=6.0.3",
+    "rich>=15.0.0",
+    "typer>=0.27.2",
+]
+
+[[project.authors]]
+name = "mbakalarski"
+email = "64490638+mbakalarski@users.noreply.github.com"
+
+[project.optional-dependencies]
+ansible = ["ansible-core"]
+
+[project.urls]
+Repository = "https://github.com/netclab/netadopt"
+Issues = "https://github.com/netclab/netadopt/issues"
+Releases = "https://github.com/netclab/netadopt/releases"
+
+[project.scripts]
+netadopt = "netadopt.cli:main"
+
+[build-system]
+requires = ["uv_build>=0.12.10,<0.13.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "netadopt[ansible]",
+    "pyavd==6.4.0",
+    "pytest>=9.1.1",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

netadopt-0.1.0/pyproject.toml.orig

@@ -0,0 +1,59 @@
+[project]
+name = "netadopt"
+version = "0.1.0"
+description = "Read a network-automation repository and adopt its model into Kubernetes"
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [
+    { name = "mbakalarski", email = "64490638+mbakalarski@users.noreply.github.com" }
+]
+keywords = ["arista", "avd", "ansible", "kubernetes", "network automation"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: System Administrators",
+    "Intended Audience :: Telecommunications Industry",
+    "Operating System :: POSIX",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: System :: Networking",
+    "Topic :: System :: Systems Administration",
+]
+requires-python = ">=3.12"
+dependencies = [
+    "pyyaml>=6.0.3",
+    "rich>=15.0.0",
+    "typer>=0.27.2",
+]
+
+[project.optional-dependencies]
+# For a machine with no pipeline of its own: `uvx "netadopt[ansible]" ./repo`.
+# PATH is still preferred at run time -- see netadopt.ansible.resolve_ansible.
+#
+# Unbounded on purpose. Each ecosystem states its own ansible-core window in its
+# collection's meta/runtime.yml and moves it over time; that number is read from the
+# repository at run time and reported, never frozen here.
+ansible = ["ansible-core"]
+
+[project.urls]
+Repository = "https://github.com/netclab/netadopt"
+Issues = "https://github.com/netclab/netadopt/issues"
+Releases = "https://github.com/netclab/netadopt/releases"
+
+[project.scripts]
+netadopt = "netadopt.cli:main"
+
+[build-system]
+requires = ["uv_build>=0.12.10,<0.13.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "netadopt[ansible]",
+    "pyavd==6.4.0",
+    "pytest>=9.1.1",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

netadopt-0.1.0/src/netadopt/__init__.py

@@ -0,0 +1,2 @@
+# The avd submodule's tag, and pyavd's pin in the dev group.
+AVD_TESTED = "6.4.0"