rebrand subsystem docs to beOS Pro
This commit is contained in:
@@ -2,6 +2,6 @@
|
||||
|
||||
## Overview
|
||||
|
||||
The `authelia` component integrates Authelia, an open-source authentication and authorization server, into the Olares framework. It provides robust security features, including multi-factor authentication (MFA) and single sign-on (SSO), to protect applications and services within the Olares ecosystem.
|
||||
The `authelia` component integrates Authelia, an open-source authentication and authorization server, into the beOS Pro framework. It provides robust security features, including multi-factor authentication (MFA) and single sign-on (SSO), to protect applications and services within the beOS Pro ecosystem.
|
||||
|
||||
For more information, visit the official [Authelia website](https://www.authelia.com/).
|
||||
|
||||
@@ -2,4 +2,4 @@
|
||||
|
||||
## Overview
|
||||
|
||||
The `backup-server` component provides a comprehensive backup solution for the Olares ecosystem. It supports backing up directories, applications, and even entire clusters, ensuring that your data is safe and can be restored in case of any issues.
|
||||
The `backup-server` component provides a comprehensive backup solution for the beOS Pro ecosystem. It supports backing up directories, applications, and even entire clusters, ensuring that your data is safe and can be restored in case of any issues.
|
||||
|
||||
@@ -2,6 +2,6 @@
|
||||
|
||||
## Overview
|
||||
|
||||
The `docker-nginx-headers-more` component provides a Docker image for Nginx that includes the `headers-more` module. This module allows for more advanced manipulation of HTTP headers than what is available in the standard Nginx distribution, which is useful for fine-tuning the behavior of web applications and services within the Olares ecosystem.
|
||||
The `docker-nginx-headers-more` component provides a Docker image for Nginx that includes the `headers-more` module. This module allows for more advanced manipulation of HTTP headers than what is available in the standard Nginx distribution, which is useful for fine-tuning the behavior of web applications and services within the beOS Pro ecosystem.
|
||||
|
||||
For more information, see the [docker-nginx-headers-more GitHub repository](https://github.com/anroe/docker-nginx-headers-more).
|
||||
|
||||
@@ -2,4 +2,4 @@
|
||||
|
||||
## Overview
|
||||
|
||||
The `files` component provides essential file management services within Olares. It is a core component that enables users to store, retrieve, and manage their files in a secure and efficient manner.
|
||||
The `files` component provides essential file management services within beOS Pro. It is a core component that enables users to store, retrieve, and manage their files in a secure and efficient manner.
|
||||
|
||||
@@ -2,6 +2,6 @@
|
||||
|
||||
## Overview
|
||||
|
||||
The `headscale` component integrates Headscale, a self-hosted, open-source implementation of the Tailscale control server, into the Olares framework. This allows for the creation and management of secure, private networks for your Olares nodes and services, without relying on the public Tailscale service.
|
||||
The `headscale` component integrates Headscale, a self-hosted, open-source implementation of the Tailscale control server, into the beOS Pro framework. This allows for the creation and management of secure, private networks for your beOS Pro nodes and services, without relying on the public Tailscale service.
|
||||
|
||||
For more information, visit the official [Headscale website](https://headscale.net).
|
||||
|
||||
@@ -2,6 +2,6 @@
|
||||
|
||||
## Overview
|
||||
|
||||
The `infisical` component integrates Infisical, a tool for managing sensitive information, into the Olares development workflow. This helps to prevent secret leaks and ensures that sensitive data, such as API keys and passwords, is handled securely throughout the development process.
|
||||
The `infisical` component integrates Infisical, a tool for managing sensitive information, into the beOS Pro development workflow. This helps to prevent secret leaks and ensures that sensitive data, such as API keys and passwords, is handled securely throughout the development process.
|
||||
|
||||
For more information, visit the official [Infisical website](https://infisical.com/).
|
||||
|
||||
@@ -2,6 +2,6 @@
|
||||
|
||||
## Overview
|
||||
|
||||
The `kube-state-metrics` component integrates `kube-state-metrics` into the Olares framework. This service listens to the Kubernetes API server and generates metrics about the state of various Kubernetes objects, such as deployments, nodes, and pods. These metrics are crucial for monitoring the health and performance of the Kubernetes clusters within the Olares ecosystem.
|
||||
The `kube-state-metrics` component integrates `kube-state-metrics` into the beOS Pro framework. This service listens to the Kubernetes API server and generates metrics about the state of various Kubernetes objects, such as deployments, nodes, and pods. These metrics are crucial for monitoring the health and performance of the Kubernetes clusters within the beOS Pro ecosystem.
|
||||
|
||||
For more information, visit the official [kube-state-metrics GitHub repository](https://github.com/kubernetes/kube-state-metrics).
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# Olares Framework: L4 BFL Proxy
|
||||
# beOS Pro Framework: L4 BFL Proxy
|
||||
|
||||
## Overview
|
||||
|
||||
The `l4-bfl-proxy` component provides a Layer 4 network proxy specifically designed for the [BFL (Backend For Launcher) service](../bfl) within the Olares framework. This proxy enhances the network communication for BFL, ensuring efficient and reliable data transfer at the transport layer.
|
||||
The `l4-bfl-proxy` component provides a Layer 4 network proxy specifically designed for the [BFL (Backend For Launcher) service](../bfl) within the beOS Pro framework. This proxy enhances the network communication for BFL, ensuring efficient and reliable data transfer at the transport layer.
|
||||
|
||||
@@ -2,4 +2,4 @@
|
||||
|
||||
## Overview
|
||||
|
||||
The `market` component provides a decentralized and permissionless app store within the Olares framework. It facilitates the installation, uninstallation, and updating of applications, and also incorporates recommendation algorithms to enhance user experience.
|
||||
The `market` component provides a decentralized and permissionless app store within the beOS Pro framework. It facilitates the installation, uninstallation, and updating of applications, and also incorporates recommendation algorithms to enhance user experience.
|
||||
@@ -2,4 +2,4 @@
|
||||
|
||||
## Overview
|
||||
|
||||
The `monitor` component is responsible for comprehensive system monitoring and resource usage tracking within the Olares framework. It collects and analyzes data related to system performance, application health, and resource consumption, providing valuable insights for maintaining the stability and efficiency of the Olares ecosystem.
|
||||
The `monitor` component is responsible for comprehensive system monitoring and resource usage tracking within the beOS Pro framework. It collects and analyzes data related to system performance, application health, and resource consumption, providing valuable insights for maintaining the stability and efficiency of the beOS Pro ecosystem.
|
||||
|
||||
@@ -2,4 +2,4 @@
|
||||
|
||||
## Overview
|
||||
|
||||
The `notifications` component is responsible for delivering system-wide notifications within the Olares framework. It provides a centralized mechanism for applications and system services to send alerts, updates, and other important information to users, ensuring timely communication and an enhanced user experience.
|
||||
The `notifications` component is responsible for delivering system-wide notifications within the beOS Pro framework. It provides a centralized mechanism for applications and system services to send alerts, updates, and other important information to users, ensuring timely communication and an enhanced user experience.
|
||||
|
||||
@@ -2,4 +2,4 @@
|
||||
|
||||
## Overview
|
||||
|
||||
The `osnode-init` component is crucial for the initial setup and configuration of an Olares node. It handles the necessary initialization processes to bring a new node online and integrate it into the Olares ecosystem, ensuring proper functionality and connectivity.
|
||||
The `osnode-init` component is crucial for the initial setup and configuration of an beOS Pro node. It handles the necessary initialization processes to bring a new node online and integrate it into the beOS Pro ecosystem, ensuring proper functionality and connectivity.
|
||||
|
||||
@@ -2,4 +2,4 @@
|
||||
|
||||
## Overview
|
||||
|
||||
The `reverse-proxy` component provides various options for implementing reverse proxy functionalities within the Olares framework. These options include integrating with external services like Cloudflare Tunnel, utilizing the Olares Tunnel, or setting up a self-built FRP (Fast Reverse Proxy) solution.
|
||||
The `reverse-proxy` component provides various options for implementing reverse proxy functionalities within the beOS Pro framework. These options include integrating with external services like Cloudflare Tunnel, utilizing the beOS Pro Tunnel, or setting up a self-built FRP (Fast Reverse Proxy) solution.
|
||||
|
||||
@@ -2,6 +2,6 @@
|
||||
|
||||
## Overview
|
||||
|
||||
The `seahub` component integrates the web frontend for the Seafile file hosting platform into the Olares framework. Seafile is an open-source, self-hosted file synchronization and sharing solution, and Seahub provides the web interface for users to manage their files, collaborate, and access Seafile's features within the Olares ecosystem.
|
||||
The `seahub` component integrates the web frontend for the Seafile file hosting platform into the beOS Pro framework. Seafile is an open-source, self-hosted file synchronization and sharing solution, and Seahub provides the web interface for users to manage their files, collaborate, and access Seafile's features within the beOS Pro ecosystem.
|
||||
|
||||
For more information, visit the [Seafile GitHub repository](https://github.com/haiwen/seafile).
|
||||
|
||||
@@ -2,4 +2,4 @@
|
||||
|
||||
## Overview
|
||||
|
||||
The `search3` component provides robust full-text search capabilities for content stored within the Olares framework, specifically integrating with the Knowledge and Files components. This enables users to efficiently locate information across various types of stored data, enhancing the overall usability and accessibility of content within the Olares ecosystem.
|
||||
The `search3` component provides robust full-text search capabilities for content stored within the beOS Pro framework, specifically integrating with the Knowledge and Files components. This enables users to efficiently locate information across various types of stored data, enhancing the overall usability and accessibility of content within the beOS Pro ecosystem.
|
||||
|
||||
@@ -2,5 +2,5 @@
|
||||
|
||||
## Overview
|
||||
|
||||
The `system-server` component is responsible for managing permissions for inter-application API calls and handling network routing between applications and database middlewares. It ensures secure and efficient communication within the Olares ecosystem.
|
||||
The `system-server` component is responsible for managing permissions for inter-application API calls and handling network routing between applications and database middlewares. It ensures secure and efficient communication within the beOS Pro ecosystem.
|
||||
|
||||
@@ -2,4 +2,4 @@
|
||||
|
||||
## Overview
|
||||
|
||||
The `upgrade` component provides robust support for automated system upgrades within the Olares framework. This ensures that the Olares system and its components can be updated seamlessly and efficiently, maintaining system stability and security with minimal manual intervention.
|
||||
The `upgrade` component provides robust support for automated system upgrades within the beOS Pro framework. This ensures that the beOS Pro system and its components can be updated seamlessly and efficiently, maintaining system stability and security with minimal manual intervention.
|
||||
|
||||
@@ -2,6 +2,6 @@
|
||||
|
||||
## Overview
|
||||
|
||||
The `vault` component is implemented based on Padloc, designed to protect sensitive data within the Olares framework. It provides secure storage and management for critical information such as accounts, passwords, and mnemonics, ensuring that these sensitive assets are safeguarded against unauthorized access and breaches.
|
||||
The `vault` component is implemented based on Padloc, designed to protect sensitive data within the beOS Pro framework. It provides secure storage and management for critical information such as accounts, passwords, and mnemonics, ensuring that these sensitive assets are safeguarded against unauthorized access and breaches.
|
||||
|
||||
For more information, visit the official [Padloc website](https://padloc.app/).
|
||||
|
||||
@@ -2,4 +2,4 @@
|
||||
|
||||
## Overview
|
||||
|
||||
CUDA is a parallel computing platform and programming model developed by NVIDIA. It acts as the core interface between the GPU hardware and the operating system. When an NVIDIA GPU is detected, CUDA drivers are installed along with Olares upon installation. For more information, visit [developer.nvidia.com/cuda-toolkit](https://developer.nvidia.com/cuda-toolkit).
|
||||
CUDA is a parallel computing platform and programming model developed by NVIDIA. It acts as the core interface between the GPU hardware and the operating system. When an NVIDIA GPU is detected, CUDA drivers are installed along with beOS Pro upon installation. For more information, visit [developer.nvidia.com/cuda-toolkit](https://developer.nvidia.com/cuda-toolkit).
|
||||
@@ -2,4 +2,4 @@
|
||||
|
||||
## Overview
|
||||
|
||||
This component manages and provisions GPU resources effectively. Olares maintains its own fork of HAMi to enable users to manage GPU resources across different applications.
|
||||
This component manages and provisions GPU resources effectively. beOS Pro maintains its own fork of HAMi to enable users to manage GPU resources across different applications.
|
||||
@@ -2,4 +2,4 @@
|
||||
|
||||
## Overview
|
||||
|
||||
Helm is the package manager for Kubernetes, which helps manage Kubernetes applications. The application management framework in Olares is built on top of Helm. For more information, visit [helm.sh](https://helm.sh).
|
||||
Helm is the package manager for Kubernetes, which helps manage Kubernetes applications. The application management framework in beOS Pro is built on top of Helm. For more information, visit [helm.sh](https://helm.sh).
|
||||
@@ -2,4 +2,4 @@
|
||||
|
||||
## Overview
|
||||
|
||||
K3s is a lightweight Kubernetes distribution for container orchestration in Olares. It is the default Kubernetes distribution that Olares installs and runs on, with lower resource consumption than the official, full-featured one. For more information, visit [k3s.io](https://k3s.io/).
|
||||
K3s is a lightweight Kubernetes distribution for container orchestration in beOS Pro. It is the default Kubernetes distribution that beOS Pro installs and runs on, with lower resource consumption than the official, full-featured one. For more information, visit [k3s.io](https://k3s.io/).
|
||||
@@ -2,4 +2,4 @@
|
||||
|
||||
## Overview
|
||||
|
||||
Kubernetes is the full-featured Kubernetes distribution for advanced or custom deployments. The core components and all the apps of Olares run as container workloads on the Kubernetes cluster. For more information, visit [kubernetes.io](https://kubernetes.io/).
|
||||
Kubernetes is the full-featured Kubernetes distribution for advanced or custom deployments. The core components and all the apps of beOS Pro run as container workloads on the Kubernetes cluster. For more information, visit [kubernetes.io](https://kubernetes.io/).
|
||||
@@ -2,4 +2,4 @@
|
||||
|
||||
## Overview
|
||||
|
||||
KubeSphere is a distributed operating system for cloud-native application management, used as a management layer on top of Kubernetes. Some parts of the user management component and the monitoring stack in Olares are based on KubeSphere. For more information, visit [kubesphere.io](https://kubesphere.io/).
|
||||
KubeSphere is a distributed operating system for cloud-native application management, used as a management layer on top of Kubernetes. Some parts of the user management component and the monitoring stack in beOS Pro are based on KubeSphere. For more information, visit [kubesphere.io](https://kubesphere.io/).
|
||||
@@ -4,4 +4,4 @@
|
||||
|
||||
Minikube is a tool that lets you run Kubernetes locally by deploying it within a Linux virtual machine on macOS.
|
||||
|
||||
For a quick hands-on experience of Olares in a MacOS environment, Olares uses minikube as a basic Kubernetes cluster. For more information, visit [minikube.sigs.k8s.io](https://minikube.sigs.k8s.io/).
|
||||
For a quick hands-on experience of beOS Pro in a MacOS environment, beOS Pro uses minikube as a basic Kubernetes cluster. For more information, visit [minikube.sigs.k8s.io](https://minikube.sigs.k8s.io/).
|
||||
@@ -2,4 +2,4 @@
|
||||
|
||||
## Overview
|
||||
|
||||
MinIO is a distributed storage backend. It can be set up as a MinIO cluster through Olares or an existing one can be mounted. When deploying Olares as a distributed service across different machines, MinIO is used as the data storage backend for JuiceFS, to provide a unified view of the Olares filesystem. For more information, visit [min.io](https://min.io/).
|
||||
MinIO is a distributed storage backend. It can be set up as a MinIO cluster through beOS Pro or an existing one can be mounted. When deploying beOS Pro as a distributed service across different machines, MinIO is used as the data storage backend for JuiceFS, to provide a unified view of the beOS Pro filesystem. For more information, visit [min.io](https://min.io/).
|
||||
@@ -2,4 +2,4 @@
|
||||
|
||||
## Overview
|
||||
|
||||
OpenEBS is a containerized block storage for cloud-native applications that provides persistent storage for stateful applications. Olares uses OpenEBS local PV provisioner as the default StorageClass for creating Persistent Volumes in the Kubernetes cluster. For more information, visit [openebs.io](https://openebs.io/).
|
||||
OpenEBS is a containerized block storage for cloud-native applications that provides persistent storage for stateful applications. beOS Pro uses OpenEBS local PV provisioner as the default StorageClass for creating Persistent Volumes in the Kubernetes cluster. For more information, visit [openebs.io](https://openebs.io/).
|
||||
@@ -2,4 +2,4 @@
|
||||
|
||||
## Overview
|
||||
|
||||
Restic is a fast, secure, efficient backup program used for backing up data. It is used by the Backup component of Olares for syncing data. For more information, visit [restic.net](https://restic.net/).
|
||||
Restic is a fast, secure, efficient backup program used for backing up data. It is used by the Backup component of beOS Pro for syncing data. For more information, visit [restic.net](https://restic.net/).
|
||||
@@ -2,4 +2,4 @@
|
||||
|
||||
## Overview
|
||||
|
||||
NATS is a lightweight and high-performance message-oriented middleware; used as the messaging system in Olares. For more information, visit [nats.io](https://nats.io/).
|
||||
NATS is a lightweight and high-performance message-oriented middleware; used as the messaging system in beOS Pro. For more information, visit [nats.io](https://nats.io/).
|
||||
@@ -2,4 +2,4 @@
|
||||
|
||||
## Overview
|
||||
|
||||
OpenTelemetry enables tracing of request workflows within Olares using eBPF-based monitoring. For more information, visit [opentelemetry.io](https://opentelemetry.io/).
|
||||
OpenTelemetry enables tracing of request workflows within beOS Pro using eBPF-based monitoring. For more information, visit [opentelemetry.io](https://opentelemetry.io/).
|
||||
@@ -2,8 +2,8 @@
|
||||
|
||||
## Overview
|
||||
|
||||
This directory contains for PostGreSQL, a powerful, open source object-relational database system; It functions as the primary relational database and vector database in Olares.
|
||||
This directory contains for PostGreSQL, a powerful, open source object-relational database system; It functions as the primary relational database and vector database in beOS Pro.
|
||||
For more information, visit [postgresql.org](https://www.postgresql.org/).
|
||||
|
||||
In addition, Citus is supported in Olares as a distributed SQL solution.
|
||||
In addition, Citus is supported in beOS Pro as a distributed SQL solution.
|
||||
|
||||
|
||||
@@ -2,4 +2,4 @@
|
||||
|
||||
## Overview
|
||||
|
||||
Prometheus is an open-source monitoring system used for system monitoring and resource usage tracking in Olares. For more information, visit [prometheus.io](https://prometheus.io/).
|
||||
Prometheus is an open-source monitoring system used for system monitoring and resource usage tracking in beOS Pro. For more information, visit [prometheus.io](https://prometheus.io/).
|
||||
@@ -1,5 +1,5 @@
|
||||
# redis
|
||||
|
||||
## Overview
|
||||
This repo contains the code for redis-like persistent key-value store services for KV cache in Olares.
|
||||
This repo contains the code for redis-like persistent key-value store services for KV cache in beOS Pro.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
## Overview
|
||||
|
||||
The Olares application runtime that includes core sidecars & operators that solve the “boring but critical” plumbing required by most self-hosted apps—file uploads, secret storage, event streaming, WebSockets, and turnkey data services.
|
||||
The beOS Pro application runtime that includes core sidecars & operators that solve the “boring but critical” plumbing required by most self-hosted apps—file uploads, secret storage, event streaming, WebSockets, and turnkey data services.
|
||||
|
||||
### image-uploader
|
||||
An HTTP gateway that lets any authenticated component upload images directly to the requesting user’s **`$HOME`** directory (`~/Pictures` by default).
|
||||
|
||||
Reference in New Issue
Block a user