Commit 52c70a13 authored by Sergio Gimenez's avatar Sergio Gimenez
Browse files

docs: update for ETSI public repository and fix stale references

- Update README: remove downstream/i2CAT wording, add image override notes
- Update CONTRIBUTING: remove broken GitLab links, add ETSI clone URL
- Update mkdocs.yml: point to labs.etsi.org, add manual-api-e2e-testing to nav
- Remove stale smoke-test.sh references from deployment docs
- Add image configuration section to getting-started.md
- Fix all_in_one playbook docs and summary to match actual roles
- Add explicit profile vars_files to all_in_one deploy playbook
- Remove stale ROLE_REFACTORING.md/TESTING_SUMMARY.md references
parent c3a351c3
Loading
Loading
Loading
Loading
+3 −10
Changes for CONTRIBUTING.md: 3 added lines, 10 removed lines.
Original line number Diff line number Diff line
@@ -11,7 +11,6 @@ First off, thank you for considering contributing to this project! Contributions
3. [Forking and Submitting PRs](#forking-and-submitting-prs)
4. [Coding Standards](#coding-standards)
5. [Testing Your Changes](#testing-your-changes)
6. [Code of Conduct](#code-of-conduct)

---

@@ -19,7 +18,7 @@ First off, thank you for considering contributing to this project! Contributions

You can contribute to this project in several ways:

- Submit bug reports or feature requests via [Issues](https://github.com/YOUR_REPO/issues)
- Submit bug reports or feature requests through the project issue tracker
- Fix bugs or add new features and open a pull request
- Update documentation to improve clarity
- Test existing playbooks and roles, suggesting improvements
@@ -45,8 +44,8 @@ To contribute code, follow these steps:

1. **Clone the Repository**:
   ```bash
   git clone git@gitlab.i2cat.net:areas/software-networks/operator-platform/oop/op-automation.git
   cd i2CAT_OP_AUTOMATION
   git clone ssh://git@labs.etsi.org:29419/oop/deploy/ansible.git
   cd ansible
   ```

2. **Create a Feature Branch**:
@@ -127,10 +126,4 @@ Before opening a PR, ensure your changes are working correctly:

---

## Code of Conduct

Please note this project follows a [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you agree to abide by these guidelines for fostering a welcoming and inclusive environment.

---

Thank you for contributing!
+11 −3
Changes for README.md: 11 added lines, 3 removed lines.
Original line number Diff line number Diff line
@@ -10,8 +10,7 @@ Repository scope:
- deploy two-host federation setups
- fetch kubeconfigs back to local machine

This downstream repository keeps i2CAT-specific inventory and local defaults on
top of the public-safe upstream automation.
This repository contains the public Ansible automation for the ETSI OOP stack.

## Start here

@@ -28,11 +27,15 @@ pip install -r requirements.txt
ansible-galaxy collection install -r requirements.yml

cp inventory/hosts.yml inventory/hosts.local.yml
# Optional: only when private registry credentials or local paths are needed.
cp secrets.example.yml secrets.yml

ansible-playbook -i inventory/hosts.local.yml playbooks/scenarios/full_oop/deploy-kubernetes.yml --limit example_op_1
```

Set `artefact_manager_image` and `artefact_manager_tag` to a published image before
deploying. Set `lite2edge_image` as well when using the `lite2edge` profile.

## Working scenarios

- `playbooks/scenarios/dual_oop/deploy.yml`: two complete Operator Platforms on two hosts
@@ -57,6 +60,7 @@ Examples:
- `ansible/secrets.yml` is optional, local-only, and gitignored.
- Copy `ansible/inventory/hosts.yml` to `ansible/inventory/hosts.local.yml` for site-specific inventory.
- Copy `ansible/secrets.example.yml` to `ansible/secrets.yml` only when local overrides are needed.
- Public defaults do not include private flavour images; provide image overrides in inventory, `secrets.yml`, or `-e`.

## Docs preview

@@ -67,6 +71,10 @@ pip install -r docs/requirements.txt
mkdocs serve
```

## Author

Sergio Giménez <sergio.gimenez@i2cat.net>

## License

Apache 2.0. See `LICENSE`.
Apache 2.0. See `LICENSE` and `NOTICE` for attribution requirements.
+2 −3
Changes for ansible/playbooks/scenarios/README.md: 2 added lines, 3 removed lines.
Original line number Diff line number Diff line
@@ -32,8 +32,7 @@ ansible-playbook -i inventory/hosts.local.yml playbooks/scenarios/dual_oop/deplo
One complete Operator Platform on a host that already has a running cluster.

```bash
ansible-playbook playbooks/scenarios/full_oop_existing_cluster/deploy.yml --limit openop_sunrise
ansible-playbook playbooks/scenarios/full_oop_existing_cluster/deploy.yml --limit openop_kul
ansible-playbook playbooks/scenarios/full_oop_existing_cluster/deploy.yml --limit example_existing_cluster
```

## Undeploy
@@ -61,7 +60,7 @@ ansible-playbook -i inventory/hosts.local.yml playbooks/scenarios/dual_oop/quick
- `existing_cluster_nodes`: hosts with an already running Kubernetes cluster
- `op1_nodes`: first host for `dual_oop`
- `op2_nodes`: second host for `dual_oop`
- `openop_dev`: optional host group for one-host `full_oop`
- `full_oop_nodes`: optional host group for one-host `full_oop`

## Notes

+11 −5
Changes for ansible/playbooks/scenarios/all_in_one/deploy.yml: 11 added lines, 5 removed lines.
Original line number Diff line number Diff line
@@ -17,9 +17,18 @@
- name: Deploy All-in-One OOP (Dual Federation Managers)
  hosts: k8s_clusters
  gather_facts: true
  vars_files:
    - ../../../inventory/profiles/{{ oop_deployment_profile | default('lite2edge') }}.yml

  vars:
    # Scenario-specific configuration
    artifact_registry: zot
    edgecloud_platform: "{{ oop_profile_edgecloud_platform }}"
    srm_edge_cloud_adapter_name: "{{ oop_profile_srm_edge_cloud_adapter_name }}"
    srm_adapter_base_url: "{{ oop_profile_srm_adapter_base_url }}"
    federation_manager_ecp_host: "{{ oop_profile_federation_manager_ecp_host }}"
    federation_manager_ecp_port: "{{ oop_profile_federation_manager_ecp_port }}"
    federation_manager_ecp_client_name: "{{ oop_profile_federation_manager_ecp_client_name }}"
    prepare_oop_storage: true

  pre_tasks:
@@ -76,7 +85,7 @@

    # Artifact Registry
    - role: zot
      when: artifact_registry == 'zot'
      when: artifact_registry | default('zot') == 'zot'
      tags: [oop, artifact-registry, zot]

      # Other registries can be added such as harbor
@@ -167,9 +176,8 @@

          Components Deployed:
            ✓ K8s Cluster ({{ cluster_name }})
            ✓ Prometheus Monitoring
            ✓ Node Feature Discovery
            {% if artifact_registry | default('zot') == 'zot' %}✓ Zot Registry{% elif artifact_registry == 'harbor' %}✓ Harbor Registry{% else %}⊘ Artifact Registry (skipped){% endif %}
            {% if artifact_registry | default('zot') == 'zot' %}✓ Zot Registry{% elif artifact_registry | default('') == 'harbor' %}✓ Harbor Registry{% else %}⊘ Artifact Registry (skipped){% endif %}

            ✓ Artefact Manager
            ✓ SRM Controller
@@ -182,8 +190,6 @@

          Access Points:
            Kubeconfig: {{ kubeconfig_dir }}/{{ kubeconfig_filename }}
            Prometheus: http://{{ host_ip }}:30090
            Grafana: http://{{ host_ip }}:30091
            Homer: http://{{ host_ip }}:{{ homer_nodeport }}

          Federation Testing:
+0 −2
Changes for ansible/roles/README.md: 0 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -281,8 +281,6 @@ When modifying a role:

- **Variable Organization**: See `inventory/group_vars/README.md`
- **Playbook Scenarios**: See `playbooks/scenarios/README.md`
- **Testing Summary**: See `TESTING_SUMMARY.md` in project root
- **Role Refactoring**: See `ROLE_REFACTORING.md` in project root

---

Loading