Add license and contributing

# Contributing to Operator Platform Automation

First off, thank you for considering contributing to this project! Contributions, whether big or small, are always welcome. This guide outlines the contribution process for this repository.

---

## Table of Contents

1. [How to Contribute](#how-to-contribute)

2. [Reporting Issues](#reporting-issues)

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)

---

## How to Contribute

You can contribute to this project in several ways:

- Submit bug reports or feature requests via [Issues](https://github.com/YOUR_REPO/issues)

- Fix bugs or add new features and open a pull request

- Update documentation to improve clarity

- Test existing playbooks and roles, suggesting improvements

---

## Reporting Issues

If you discover a bug or have a feature request, please create an issue by following these steps:

1. **Search Existing Issues**: Check if the issue already exists before creating a new one.

2. **Provide Clear Details**: Include the following:

   - A descriptive title

   - Steps to replicate the issue

   - Expected versus actual behavior

   - Logs (if applicable)

---

## Submitting Merge Requests

To contribute code, follow these steps:

1. **Clone the Repository**:

   ```bash

   git clone git@gitlab.i2cat.net:areas/software-networks/operator-platform/op-automation.git

   cd op-automation

   ```

2. **Create a Feature Branch**:

   ```bash

   git checkout -b feature/your-feature-name

   ```

3. **Make and Test Changes**: Ensure your changes follow coding and testing standards outlined below.

4. **Commit Changes**:

   ```bash

   git add .

   git commit -m "Brief description of your feature or fix"

   ```

5. **Push Changes**:

   ```bash

   git push origin feature/your-feature-name

   ```

6. **Create a Merge Request** (MR):

   - Visit the repository page on GitLab.

   - Navigate to **Merge Requests** > **New Merge Request**.

   - Select your branch as the source and the default branch (`main` or equivalent) as the target.

   - Provide a clear and detailed description of the changes in your MR.

   - Submit the MR and request a review.

7. **Address Review Feedback**:

   - Be responsive to reviewers' comments and implement necessary changes promptly.

   - Once feedback is addressed, re-request a review if needed.

---

## Coding Standards

This repository adheres to the following coding standards for consistency:

1. **YAML Formatting** (for playbooks/roles):

   - Use 2 spaces for indentation.

   - Avoid inline comments; prefer block-level explanations above the code.

   - Group tasks logically (e.g., initialization, configuration, cleanup).

2. **Python Scripts** (if applicable):

   - Follow PEP8 standards.

   - Document your functions with clear docstrings.

3. **Ansible Best Practices**:

   - Use roles to modularize components.

   - Prefer the `kubernetes.core.k8s` module over shell commands.

   - Avoid hardcoding values; use `defaults/main.yml` or variables.

---

## Testing Your Changes

Before opening a PR, ensure your changes are working correctly:

1. **Set Up Test Environment**:

   - Ensure all required dependencies are installed.

   - Use a local Kubernetes (e.g., Kind) environment to test deployments.

2. **Run Playbook Tests**:

   - Example:

     ```bash

     ansible-playbook playbooks/scenarios/deploy_quick_single_oop.yml -e @secrets.yml

     ```

3. **Verify Cleanup**:

   - Set `state: absent` and ensure components undeploy cleanly.

4. **Run Ansible Lint**:

   ```bash

   ansible-lint .

   ```

5. **Confirm No Regressions**:

   - Test affected components thoroughly.

---

## 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!

 No newline at end of file

                                  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 [yyyy] [name of copyright owner]

   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.

# Operator Platform Automation

This repository contains the automation for deploying the Operator Platform.

[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)

## Documentation

Deploy the Operator Platform quickly and reliably using Ansible-based automation. This repository is designed for developers, operators, and organizations looking to streamline the deployment of a complete Operator Platform environment with minimal manual effort.

---

## Features

- **Complete Stack**: Deploy Kubernetes clusters, platform components, and utilities.

- **Idempotent Playbooks**: Re-run playbooks safely.

- **Flexible Deployment Scenarios**: Single-node and multi-cluster federation setups.

- **Customizable Configurations**: Modify variables to suit your needs.

- **Fully Tested**: Verified by ansible-lint and end-to-end testing.

---

## Prerequisites

Before using this repository, ensure the following:

Full documentation is available in the `docs/` directory and can be viewed in https://op-automation-b0b7e6.pages.i2cat.net

1. **Software Dependencies**:

   - Python 3.8+

   - pip

   - Ansible (>= 2.10)

   - Docker (for Kind-based clusters)

### Running Documentation Locally

2. **Install Required Python Packages**:

   ```bash

   pip install -r requirements.txt

   ```

3. **Access and Permissions**:

   - Kubernetes cluster admin access (or setup local Kind cluster).

---

## Quick Start

Follow these steps to deploy the Operator Platform on a local Kind cluster:

1.  Create and activate the documentation virtual environment:

```bash

# Step 1: Clone the repository

 git clone https://gitlab.i2cat.net/areas/software-networks/operator-platform/op-automation.git

cd op-automation

# Step 2: Set up your environment

ansible-playbook playbooks/infrastructure/prerequisites/setup-docker.yml

# Step 3: Deploy Operator Platform (Single OOP scenario)

ansible-playbook playbooks/scenarios/deploy_quick_single_oop.yml -e @ansible/secrets.yml

# Step 4: Verify deployed components

kubectl get pods --all-namespaces

# Optional: Undeploy Operator Platform

ansible-playbook playbooks/scenarios/clean_quick_single_oop.yml -e @ansible/secrets.yml

```

---

## Documentation

**Full Documentation** is available in the `docs/` directory. To view locally:

1. Create and activate a virtual environment:

    ```bash

    python3 -m venv docs/.venv

    source docs/.venv/bin/activate

    ```

2. Install dependencies:

    ```bash

    pip install -r docs/requirements.txt

    ```

3.  Serve the documentation:

3. Serve the documentation locally:

    ```bash

    mkdocs serve

    ```

4. Open [http://127.0.0.1:8000](http://127.0.0.1:8000) in your browser.

---

4.  Open http://127.0.0.1:8000 in your browser.

## License

This project is licensed under the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for details.