netautomate.netorca¶

Ansible modules for the NetOrca service orchestration platform. NetOrca sits between consumer teams (who declare the services they need, usually from Git) and service owner teams (who fulfil those requests with automation); this collection is how both sides drive that from Ansible - poll and transition change instances, query service items and declarations, record deployed items, and (as the v2 series completes) submit declarations, manage webhooks, healthchecks, billing and AI/Pack operations.

Version 2.0.0 is a breaking rewrite

The collection was rebuilt on netorca-sdk ≥ 1.0.9. All v1 modules (get_* / update_*) were removed and username/password authentication is gone - the NetOrca API is API-key only. The migration guide maps every v1 module and pattern to its replacement; staying on v1 is a one-line version: "<2.0.0" pin.

Sixty seconds to first result¶

ansible-galaxy collection install netautomate.netorca
pip install "netorca-sdk>=1.0.9,<2.0.0"
export NETORCA_API_URL=https://api.example.netorca.io
export NETORCA_API_KEY=...

- hosts: localhost
  gather_facts: false
  tasks:
    - name: Approved changes waiting for my team
      netautomate.netorca.netorca_change_instance_info:
        state: [APPROVED]
      register: work

    - name: Complete one, recording what was deployed
      netautomate.netorca.netorca_change_instance:
        id: "{{ work.change_instances[0].id }}"
        state: COMPLETED
        deployed_item:
          fqdn: app01.example.com
      when: work.count > 0

No credentials in playbooks, real check mode and diff everywhere, structured errors, full auto-pagination.

Where to go¶

New here? Installation → Authentication → Your first playbook, with expected output.
Building automation? Start from the Scenarios - real-life, end-to-end workflows with final playbooks, headlined by load balancer as a service.
Looking something up? The module reference is generated from the modules themselves and cannot drift from the code.
Contributing? Development - including every CI job explained and the local testing map.

Part of the NetOrca documentation family¶

Platform documentation lives at docs.netorca.io (concepts, GUI, API, SDK guide); this site is the Ansible collection's own home, generated from this repository so it always matches the released code.

Versioning¶

Semantic versioning: breaking changes only in major releases, removed modules keep failing with a pointer to their replacement (tombstones), and the release notes are compiled from per-change fragments. Details in Releasing.