Merge pull request #11 from DioCrafts/feature/fix-functionality

Feature/fix functionality

.gitignore

@@ -23,3 +23,7 @@
 *.dylib        # Dynamic libraries on MacOS
 *.stackdump    # Stack dumps on Windows (crash logs)
 *.profraw      # Profile-guided optimization data, generated during profiling
+
+# Ignore any other target directories (including for the api-gateway and ingress module)
+api-gateway/target/**
+ingress-controller/target/**

CODE_OF_CONDUCT.md

@@ -0,0 +1,68 @@
+
+# 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, 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 toward 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 [[email protected]]. 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](https://www.contributor-covenant.org), version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
+
+For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq.

README.md

@@ -1,7 +1,7 @@
 
-# 🚀 Flusso - Secure, High-Performance Kubernetes Ingress Controller in Rust 🦀🔒
+# 🚀 Flusso - Secure, High-Performance Kubernetes Ingress Controller and API Gateway in Rust 🦀🔒
 
-**Flusso** is a powerful, secure, and high-performance Ingress Controller for Kubernetes, written in Rust. Tailored for modern cloud-native environments, Flusso offers a lightweight alternative to popular ingress solutions.
+**Flusso** is a secure, high-performance solution for Kubernetes, combining the functionalities of an **Ingress Controller** and an **API Gateway**. Written in **Rust**, Flusso is designed to meet the needs of modern cloud-native environments, offering a lightweight and efficient alternative to traditional solutions.
 
 <div align="center">
 
@@ -41,33 +41,64 @@
 
 ## Installation
 
-To get started with Flusso, you can use Docker or Helm to deploy the Ingress Controller in your Kubernetes cluster.
+Flusso provides two components for deployment: the **Ingress Controller** and the **API Gateway**. You can choose to deploy either or both of them depending on your needs. Both components can be deployed using **Helm** or **Docker**, and here are the instructions for each.
 
-### Docker Installation
+### 1. **Install Ingress Controller using Helm**
 
-1. Pull the Docker image:
-   ```sh
-   docker pull diocrafts/flusso-ingress-controller:latest
+To install the Flusso Ingress Controller in your Kubernetes cluster, you can use Helm. Follow these steps:
+
+1. **Add the Flusso Helm Chart repository:**
+
+   ```bash
+   helm repo add flusso https://diocrafts.github.io/flusso
+   helm repo update
+   ```
+
+2. **Install the Ingress Controller:**
+
+   ```bash
+   helm install flusso-ingress-controller flusso/flusso-ingress-controller        --namespace ingress-system        --create-namespace
+   ```
+
+   This will install the Flusso Ingress Controller in the `ingress-system` namespace. You can customize your deployment by modifying values in the Helm chart.
+
+3. **Verify the deployment:**
+
+   Check the status of the Ingress Controller to ensure it is running:
+
+   ```bash
+   kubectl get pods -n ingress-system
    ```
 
-2. Run the Docker container:
-   ```sh
-   docker run -p 8080:8080 -p 8081:8081 -e SERVER_ADDR="0.0.0.0:8080" -e TLS_ENABLED="true" diocrafts/flusso-ingress-controller
+---
+
+### 2. **Install API Gateway using Helm**
+
+To install the Flusso API Gateway in your Kubernetes cluster, follow these steps:
+
+1. **Add the Flusso Helm Chart repository:**
+
+   ```bash
+   helm repo add flusso https://diocrafts.github.io/flusso
+   helm repo update
    ```
 
-### Kubernetes Installation with Helm
+2. **Install the API Gateway:**
 
-1. Add your Helm repository (if not added yet):
-   ```sh
-   helm repo add flusso-repo https://your-helm-repo.com/charts
+   ```bash
+   helm install flusso-api-gateway flusso/flusso-api-gateway        --namespace api-gateway-system        --create-namespace
    ```
 
-2. Install Flusso Ingress Controller:
-   ```sh
-   helm install flusso-ingress flusso-repo/flusso-ingress
+   This will install the Flusso API Gateway in the `api-gateway-system` namespace. You can modify the Helm chart values to customize your deployment.
+
+3. **Verify the deployment:**
+
+   Check the status of the API Gateway to ensure it is running:
+
+   ```bash
+   kubectl get pods -n api-gateway-system
    ```
 
-For more configuration options, refer to the [values.yaml](chart/values.yaml).
 
 ---