diff --git a/docs/cluster/addons/ebs.mdx b/docs/cluster/addons/ebs.mdx new file mode 100644 index 000000000..aa9373eb3 --- /dev/null +++ b/docs/cluster/addons/ebs.mdx @@ -0,0 +1,37 @@ +import { FiExternalLink } from "react-icons/fi"; + +# EBS (Elastic Block Store) + +In SleakOps, AWS EBS (Elastic Block Store) is used to provide persistent block storage for EC2 instances. EBS volumes are especially useful for applications that require low-latency access to data and high performance. + +
+ + **What is AWS EBS?** + +[AWS EBS ](https://aws.amazon.com/ebs/) is a block storage service from AWS designed to provide persistent storage for EC2 instances. EBS volumes are automatically replicated within their Availability Zone, offering high availability and durability, and protecting against hardware failures. +
+ +
+ + **How is EBS used in SleakOps?** + +In SleakOps, EBS is used to deliver persistent storage for applications running on EC2 instances. Each EBS volume can be attached to a single EC2 instance at a time, although multiple volumes can be attached to one instance. Within Kubernetes, EBS is used for persistent volumes, ensuring data consistency across pod restarts and rescheduling. SleakOps manages and configures EBS automatically to suit your application needs. + +
+ +
+ + **What are the benefits of using EBS?** + +EBS provides several key benefits for high-performance applications: +- **High performance**: EBS offers consistent and low-latency performance, ideal for applications requiring quick data access. +- **Durability**: EBS volumes are replicated within their Availability Zone to ensure high durability. +- **Scalability**: Volumes can be easily resized to accommodate growing application demands. +
+ +
+ + **How do I configure volumes with EBS in SleakOps?** + +To set up and manage volumes using EBS within SleakOps, please refer to the [Volumes documentation](/project/volumes). This guide provides instructions on creating and managing EBS volumes to support your application’s storage requirements. +
\ No newline at end of file diff --git a/docs/cluster/addons/efs.mdx b/docs/cluster/addons/efs.mdx new file mode 100644 index 000000000..ef2e6a5df --- /dev/null +++ b/docs/cluster/addons/efs.mdx @@ -0,0 +1,44 @@ +import { FiExternalLink } from "react-icons/fi"; + +# EFS (Elastic File System) + +In SleakOps, AWS EFS (Elastic File System) is primarily used for managing the volumes of Projects. EFS provides a scalable and elastic file system that can be mounted on multiple EC2 instances, allowing pods in a Kubernetes cluster to share the same file system efficiently. + +
+ + **What is AWS EFS?** + +[AWS EFS ](https://aws.amazon.com/efs/) is a cloud file storage service from AWS that provides shared and scalable storage for applications and services. It is ideal for workloads that require concurrent access to a common file system across different services. +
+ +
+ + **How is EFS used in SleakOps?** + +In SleakOps, EFS is utilized for Project volumes. Each Project can have one or more volumes, which are implemented as EFS file systems within the EKS cluster, providing shared storage that can be accessed by different services and pods. + +
+ +
+ + **What are the benefits of using EFS?** + +EFS offers several advantages, making it a powerful option for shared storage in distributed applications: +- **Scalability**: Automatically scales as files are added or removed. +- **High availability**: Designed to be highly available and durable, with data replicated across multiple availability zones. +- **Concurrent access**: Multiple EC2 instances can mount the same EFS file system simultaneously, supporting workloads requiring concurrent access. +
+ +
+ + **What is the EFS Retain Policy in SleakOps?** + +SleakOps enforces a retain policy for EFS volumes, which prevents the deletion of an EFS volume in AWS when a volume is removed from SleakOps. This ensures data persistence even if the volume is detached from the cluster. +
+ +
+ + **How do I configure volumes with EFS in SleakOps?** + +To set up and manage volumes using EFS within SleakOps, follow the instructions in the [Volumes documentation](/project/volumes). This guide covers creating and managing volumes for your Projects and configuring EFS settings within your cluster. +
\ No newline at end of file diff --git a/docs/cluster/addons.mdx b/docs/cluster/addons/index.mdx similarity index 70% rename from docs/cluster/addons.mdx rename to docs/cluster/addons/index.mdx index 746776818..0a102a4f2 100644 --- a/docs/cluster/addons.mdx +++ b/docs/cluster/addons/index.mdx @@ -18,26 +18,26 @@ By default SleakOps includes in your infra:
-**What optional Add-ons are available?** +**Which optional Add-ons are available?** - **Grafana**: Visualize and analyze data with Grafana's dashboards, making it easier to monitor system performance and troubleshoot issues. Perfect for tracking application memory and CPU usage. - **LOKI**: Use Loki for cost-effective log aggregation. It simplifies log management by labeling log streams without indexing content, making it ideal for browsing and monitoring application logs. - **Kubecost**: Gain real-time insights into Kubernetes cloud costs with Kubecost. This add-on helps you monitor and reduce expenses across projects in your cluster. - **Prometheus**: SleakOps deploys Prometheus for monitoring and alerting, providing detailed insights into cluster performance and resource utilization. - **OTEL**: Use OpenTelemetry to collect and analyze distributed traces, enabling you to monitor and optimize application performance across your cluster. +- [**EFS Controller**](./addons/efs): The EFS Controller allows you to manage EFS volumes within your EKS cluster, providing scalable and shared storage for your applications. For more details, refer to the [EFS documentation](/project/efs). +- [**EBS Controller**](./addons/ebs): The EBS Controller allows you to manage EBS volumes within your EKS cluster, providing persistent block storage for your applications. For more details, refer to the [EBS documentation](/project/ebs).
**How do I set up an Add-on?** -Navigate to your Clusters listing, select a cluster, and click the three dots to open the options menu. Choose the desired option to begin configuration. For detailed guidance on each setting, refer to the specific documentation linked below this article. - - - cluster-addons-create - +To set up an add-on, follow these steps: +1. Navigate to the Add-ons section in the [Cluster](../cluster) section +2. Select the desired add-on from the list of available options. +3. Configure the add-on settings as needed. +4. Click "Deploy" to install the add-on in your EKS cluster. +For more detailed instructions, refer to the [Add-ons setup guide](/docs/addons/setup).
\ No newline at end of file diff --git a/docs/project/volumes.mdx b/docs/project/volumes.mdx index 86ee659bb..0cb382085 100644 --- a/docs/project/volumes.mdx +++ b/docs/project/volumes.mdx @@ -4,12 +4,11 @@ import 'react-medium-image-zoom/dist/styles.css'; # Volumes In the context of Sleakops, volumes refer to AWS/Kubernetes storage resources attached to a cluster. They serve as general storage for specified containers. Pods can only interact with these volumes if they are explicitly attached to them. - You can define the volumes in the [Project](/project) form: PROJECT-volumes-form - Whenever a volume is needed, Sleakops deploys an EFS CSI Driver within the [cluster](/cluster). This allows every Project to have its own unique volume mount, storing folders based on the paths you specify. - A practical use-case for Volumes is when you want all your pods to access the same files, such as a shared folder that requires its content to be persistent. + +For more details on how EFS is used for volumes, refer to the [EFS documentation](/cluster/addons/efs). \ No newline at end of file