doc(AM-ContributingGuide): Contributing guide and related docs

CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing
+
+Guidelines on how to contribute to KubeSlice
+
+There are a number of ways you can contribute to the KubeSlice project. We would like to accept your patches and contributions to the KubeSlice code base. This document provides guidelines on how to contribute to the KubeSlice code base. We require all participants to adhere to the [Code of Conduct](https://github.com/kubeslice/gateway-sidecar/blob/doc/contributionGuide/code_of_conduct.md).
+
+
+Here are some ways to contribute:
+
+* Contribute to the KubeSlice codebase.
+* Report and triage bugs.
+* Answer questions on KubeSlice discussions forums.
+* Write technical documentation and blog posts, for users and contributors.
+* File Issues.
+* Provide feedback on the codebase and documentation.
+* Submit PRs for small bug fixes.
+
+## Contributor Compliance with Developer Certificate Of Origin (DCO)
+
+We require every contributor to certify that they are legally permitted to contribute to our project. A contributor expresses this by consciously signing their commits, and by this act expressing that they comply with the Developer Certificate Of Origin
+
+A signed commit is a commit where the commit message contains the following content:
+
+`Signed-off-by: John Doe <[email protected]>`
+
+This can be done by adding `--signoff` to your git command line
+
+## Code of Conduct
+Please make sure to read and observe our [Code of Conduct](https://github.com/kubeslice/gateway-sidecar/blob/doc/contributionGuide/code_of_conduct.md).
+
+## Contributor Workflow
+
+Pull Requests are welcome. In general, we follow the "fork-and-pull" Git workflow that has the following steps:
+
+1. **Fork** the repo on GitHub.
+2. **Clone** the project to your own machine.
+3. **Commit** changes to your own branch.
+4. **Push** your work back up to your fork.
+5. Submit a **Pull request** so that we can review your changes.
+
+NOTE: Ensure to rebase the latest from **upstream** before making a pull request!
+
+## Filing Issues
+If you encounter a bug, please file an issue in the Github repository. Please provide as much information as possible to help fix the issue. Please file the issue under the appropriate repo.
+
+
+## Coding Guidelines
+* Follow good [coding guidelines](https://github.com/golang/go/wiki/CodeReviewComments).
+* Write good [commit messages](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format).
+
+## Developer Guide
+This guide helps you to get started with developing [gateway-sidecar](https://github.com/kubeslice/gateway-sidecar/blob/doc/contributionGuide/developer_guide.md).
+
+## License
+Apache License 2.0

Makefile

@@ -27,3 +27,7 @@ chart-deploy:
 	## Deploy the artifacts using helm
 	## Usage: make chart-deploy VALUESFILE=[valuesfilename]
 	helm upgrade --install kubeslice-worker -n kubeslice-system avesha/kubeslice-worker -f ${VALUESFILE}
+
+.PHONY: chart-undeploy
+	## undeploy the artifacts using helm
+	helm delete kubeslice-worker -n kubeslice-system

code_of_conduct.md

@@ -0,0 +1,127 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness towards other people.
+* Being respectful of differing opinions, viewpoints, and experiences.
+* Giving and gracefully accepting constructive feedback.
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience.
+* Focusing on what is best not just for us as individuals, but for the overall
+  community.
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind.
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment.
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission.
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting.
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[FAQ]: https://www.contributor-covenant.org/faq

developer_guide.md

@@ -0,0 +1,106 @@
+# Development Guidelines for Router Sidecar
+
+The Slice VPN Gateway is a slice network service component that provides a secure VPN tunnel between any two clusters that are a part of the slice.
+
+## Building and Installing `gateway-sidecar` in a Local Kind Cluster
+For more information, see [getting started with clusters](https://kubeslice.io/documentation/open-source/1.2.0/category/get-started).
+
+### Setting up Development Environment
+Ensure that: 
+* Go (version 1.17 or later) is installed and configured in your machine ([Installing Go](https://go.dev/dl/)).
+* Docker is installed and running in your local machine
+* You have a running [`kind`](https://kind.sigs.k8s.io/) cluster
+* [`kubectl`](https://kubernetes.io/docs/tasks/tools/)  is installed and configured on the cluster.
+* You follow the getting started from above to install [kubeslice-controller](https://github.com/kubeslice/kubeslice-controller).
+
+### Building Docker Images
+
+1. Clone the latest version of kubeslice-controller from  the `master` branch.
+
+```bash
+git clone https://github.com/kubeslice/gateway-sidecar.git
+cd gateway-sidecar
+```
+
+2. Adjust image name variable `IMG` in the [`Makefile`](Makefile) to change the docker tag to be built.
+   The default image is set as `IMG ?= aveshasystems/kubeslice-gw-sidecar:${VERSION}`. Modify this if required.
+
+```bash
+make docker-build
+```
+### Running Local Image on Kind Clusters
+
+1. You can load the gateway-sidecar docker image into the kind cluster.
+
+```bash
+kind load docker-image my-custom-image:unique-tag --name clustername
+```
+
+Example
+
+```console
+kind load docker-image aveshasystems/kubeslice-gw-sidecar:1.2.1 --name kind
+```
+
+2. Check the loaded image in the cluster. Modify the node name if required.
+
+```console
+docker exec -it <node-name> crictl images
+```
+
+Example.
+
+```console
+docker exec -it kind-control-plane crictl images
+```
+
+### Deploy in a Cluster
+
+Update chart values file `yourvaluesfile.yaml` that you have previously created.
+Refer to [values.yaml](https://github.com/kubeslice/charts/blob/master/charts/kubeslice-worker/values.yaml) to create `yourvaluesfile.yaml` and update the routerSidecar image subsection to use the local image.
+
+From the sample:
+Change the following parameter values
+```
+routerSidecar:
+  image: docker.io/aveshasystems/gw-sidecar
+  tag: 0.1.0
+```
+
+Change them to:
+
+```
+routerSidecar:
+  image: <my-custom-image>
+  tag: <unique-tag>
+```
+
+Deploy the Updated Chart
+
+```console
+make chart-deploy VALUESFILE=yourvaluesfile.yaml
+```
+
+### Verify the gateway-sidecar Pods are Running
+
+```bash
+kubectl describe pod <gateway pod name> -n kubeslice-system
+```
+### Uninstalling the kubeslice-worker
+
+Refer to the [uninstallation guide](https://kubeslice.io/documentation/open-source/1.2.0/uninstall-kubeslice/).
+
+1. [Offboard](https://kubeslice.io/documentation/open-source/1.2.0/uninstall-kubeslice/#offboard-application-namespaces) the namespaces from the slice.
+
+2. [Delete](https://kubeslice.io/documentation/open-source/1.2.0/uninstall-kubeslice/#delete-slices) the slice.
+
+3. On the worker cluster, undeploy the kubeslice-worker charts.
+
+```bash
+# uninstall all the resources
+make chart-undeploy
+```
+
+## License
+
+Apache License 2.0