diff --git a/docs/add-ons/add-on-deployment.md b/docs/add-ons/add-on-deployment.md index 35edcc2..e8ae79a 100644 --- a/docs/add-ons/add-on-deployment.md +++ b/docs/add-ons/add-on-deployment.md @@ -37,7 +37,8 @@ When you are ready to continue, click **Deploy App**. On the **Configure Add-on** page, choose where the add-on should run and review the services that will be deployed. - **Server** — select the server where the add-on should be deployed -- **Environment** — select from your available environments, or create a new one. PipeOps includes Production and Beta by default, but you can create additional environments up to the limit your plan allows. [Learn more about environments](/docs/how-to-guides/tutorials/managing-environments) +- **Environment** — select from your available environments, or create a new one. PipeOps includes Production and Beta by default, but you can create additional environments up to the limit your plan allows. + - **Services** — review the services included in the deployment. Click **Add More** to include additional services if your setup requires them - **Estimated usage** — review the projected resource cost before deploying diff --git a/docs/add-ons/add-on-overview.md b/docs/add-ons/add-on-overview.md index d1a669f..a412b93 100644 --- a/docs/add-ons/add-on-overview.md +++ b/docs/add-ons/add-on-overview.md @@ -21,10 +21,10 @@ The overview page for non-database add-ons contains the following sections: The tab navigation along the top provides access to: -- [**Metrics**](/docs/addons/addon-metrics) — detailed charts for CPU, memory, storage, and network I/O activity. -- [**Logs**](/docs/addons/logs-and-events) — real-time log output for the add-on. -- [**Events**](/docs/addons/logs-and-events) — a chronological record of deployment events, configuration changes, and system notifications. -- [**Settings**](/docs/addons/addon-settings) — options to update environment variables, resource allocations, and other configuration settings. +- [**Metrics**](/docs/add-ons/add-on-metrics) — detailed charts for CPU, memory, storage, and network I/O activity. +- [**Logs**](/docs/add-ons/logs-and-events) — real-time log output for the add-on. +- [**Events**](/docs/add-ons/logs-and-events) — a chronological record of deployment events, configuration changes, and system notifications. +- [**Settings**](/docs/add-ons/add-on-settings) — options to update environment variables, resource allocations, and other configuration settings. ## Database Add-on Overview @@ -45,4 +45,4 @@ Below the status bar, the page contains: The tab navigation for database add-ons includes all the tabs available on non-database add-ons, plus: -- [**Studio**](/docs/addons/addon-studio) — a built-in interface for interacting directly with your database without needing an external client. +- [**Studio**](/docs/add-ons/add-on-database-studio) — a built-in interface for interacting directly with your database without needing an external client. diff --git a/docs/projects/project-deployment.md b/docs/projects/project-deployment.md index 1e1a3ef..57fff6e 100644 --- a/docs/projects/project-deployment.md +++ b/docs/projects/project-deployment.md @@ -196,15 +196,15 @@ top-right corner to open your application in a new tab. Explore the rest of your project from the tabs below: -| Tab | Description | -| --------------------------------------------------------- | --------------------------------------------------- | -| [History](/docs/projects/project-history) | Full deployment history with logs and statuses. | -| [Metrics](/docs/projects/project-metrics) | CPU, memory, and network usage over time. | -| [Logs](/docs/projects/logs-and-events#accessing-logs) | Real-time and historical application log output. | -| [Events](/docs/projects/logs-and-events#accessing-events) | Infrastructure-level events such as pod scheduling. | -| [Worker](/docs/projects/worker-and-jobs) | Background worker process management. | -| [Jobs](/docs/projects/worker-and-jobs) | Scheduled and on-demand job management. | -| [Settings](/docs/projects/project-setting) | Full project configuration. | +| Tab | Description | +| ------------------------------------------- | --------------------------------------------------- | +| [History](/docs/projects/project-history) | Full deployment history with logs and statuses. | +| [Metrics](/docs/projects/project-metrics) | CPU, memory, and network usage over time. | +| [Logs](/docs/projects/logs-and-events) | Real-time and historical application log output. | +| [Events](/docs/projects/logs-and-events) | Infrastructure-level events such as pod scheduling. | +| [Worker](/docs/projects/worker-and-jobs) | Background worker process management. | +| [Jobs](/docs/projects/worker-and-jobs) | Scheduled and on-demand job management. | +| [Settings](/docs/projects/project-settings) | Full project configuration. | To delete a project, see the [Delete Project](/docs/projects/project-actions#delete-project) guide. diff --git a/docs/projects/project-settings.md b/docs/projects/project-settings.md index 0162cf8..b03836d 100644 --- a/docs/projects/project-settings.md +++ b/docs/projects/project-settings.md @@ -168,7 +168,7 @@ Existing environment variables with the same key will be overwritten. Rename any ::: :::tip -Don't have a database add-on yet? Browse available database add-ons on the [PipeOps Add-on Marketplace](https://pipeops.io/addons) and deploy one in minutes. [Learn more about Add-ons](/docs/addons/addon-overview). +Don't have a database add-on yet? Browse available database add-ons on the [PipeOps Add-on Marketplace](https://pipeops.io/addons) and deploy one in minutes. [Learn more about Add-ons](/docs/add-ons/add-on-overview). ::: Click **Save** to apply any manually added or edited variables. diff --git a/docs/servers/server-add-ons.md b/docs/servers/server-add-ons.md new file mode 100644 index 0000000..f0eafb6 --- /dev/null +++ b/docs/servers/server-add-ons.md @@ -0,0 +1,58 @@ +--- +slug: server-add-ons +sidebar_position: 5 +title: Server Add-ons +description: "Browse pre-installed and available server add-ons like +autoscaler, cert-manager, ingress-nginx, and Prometheus in PipeOps." +--- + +# Server Add-ons + +The **Add-ons** tab shows the extensions installed on your server +and any additional add-ons available to enable. Add-ons handle +infrastructure concerns like autoscaling, TLS certificate management, +traffic routing, and monitoring. + +:::note +The Add-ons tab is only available on servers provisioned using the +**Bring Your Own Cloud** path. +::: + +## Accessing Server Add-ons + +From the **Servers** section, select a BYOC server and click the +**Add-ons** tab. + +![Server Add-ons tab showing pre-installed and available add-ons](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-add-ons.png) + +## Pre-installed Add-ons + +The following add-ons are installed automatically when you create +a server: + +| Add-on | Description | +| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Cluster Autoscaler** | Automatically adds nodes to the cluster when workloads need more capacity and removes them when idle, keeping infrastructure costs efficient. | +| **Sealed Secrets** | Encrypts Kubernetes secrets so they can be safely stored in version control. Secrets are only decrypted inside the cluster. | +| **Certificate Manager** | Automatically provisions and renews TLS certificates and stores them as Kubernetes secrets for use by your workloads. | +| **Ingress-Nginx Controller** | Manages external traffic routing into the cluster, including SSL termination and load balancing. | +| **Metrics Server** | Collects resource usage data (CPU and memory) from containers and nodes, providing the data Kubernetes needs for built-in autoscaling. | +| **Kubernetes Dashboard** | A web-based interface for viewing and managing cluster resources, workloads, and configurations. | +| **External DNS** | Automatically manages DNS records with external providers such as Amazon Route 53, Azure DNS, or Google Cloud DNS based on your cluster's services. | +| **Prometheus** | Collects and stores cluster metrics for monitoring and alerting. See [Accessing Prometheus Credentials](#accessing-prometheus-credentials) below. | + +## Accessing Prometheus Credentials + +Prometheus requires authentication to access its monitoring +interface. To retrieve the credentials for your server's Prometheus +instance: + +1. Locate **Prometheus** in the add-ons list. +2. Click **View Credentials** in the **Action** column. +3. A modal will appear displaying the **username** and **password** + needed to log in to the Prometheus monitoring system. + +## Managing Add-ons + +For steps on deploying, configuring, or removing add-ons, see the +[Add-ons](/docs/add-ons/add-on-deployment.md) section. diff --git a/docs/servers/server-addons.md b/docs/servers/server-addons.md deleted file mode 100644 index b0598b2..0000000 --- a/docs/servers/server-addons.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -slug: server-addons -sidebar_position: 5 -title: Server Add-ons -description: "Browse pre-installed and available server add-ons like autoscaler, cert-manager, ingress-nginx, and Prometheus in PipeOps." ---- - -# Server Add-Ons - -This guide introduces the **Server Add-ons** functionality on PipeOps. Add-ons are extensions that enhance the functionality, security, and automation of server environments. They are designed to streamline server management, improve performance, and integrate essential services, ensuring that your infrastructure is optimized for efficiency and scalability. - -Note that this tab is available only for servers deployed using the **cloud provider** path on PipeOps. - -## Accessing Server Add-Ons -To access server add-ons, follow these steps: -1. Navigate to the **"Servers"** section. -2. Select the desired server from the list. -3. Click on the **"Add-ons"** tab. - -![Server AddOn Page](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-addon-page.png) - -The following add-ons are pre-installed when you create a server: - -- **Cluster autoscaler:** This component minimizes costs by ensuring that nodes are added to the server when needed and are removed when unused. -- **Sealed secret:** This provides a mechanism to securely manage sensitive data in your server. -- **Certificate manager:** This automatically creates and renews **TLS** certificates and stores them as Kubernetes secrets for easy use. -- **Ingress-Nginx controller:** This manages external traffic coming into the server. It may also handle **SSL** configurations and load-balancing. -- **Metrics server:** A scalable, efficient source of container resource metrics for Kubernetes built-in autoscaling pipelines. It gathers data on how resources like CPU and memory are utilized. This data can be used for autoscaling. -- **K8 dashboard:** A web-based Kubernetes dashboard for managing applications in a cluster. -- **External DNS:** This refers to Domain Name System (DNS) records managed outside of an internal network. Examples of external DNS include Amazon Route 53, Azure DNS, and Google Cloud DNS. -- **Prometheus:** Stores and collects metrics necessary for monitoring and troubleshooting issues. -For the Prometheus add-on, the "Action" column shows "View Credentials." Clicking this button will display a pop-up window containing the username and password required to access the Prometheus monitoring system. - -Check out our [Add-ons section](/docs/addons/addon-deployment.md) for detailed steps on deploying add-ons to your server. diff --git a/docs/servers/server-dashboard.md b/docs/servers/server-dashboard.md index 4cd5d58..0b3ec9e 100644 --- a/docs/servers/server-dashboard.md +++ b/docs/servers/server-dashboard.md @@ -1,36 +1,43 @@ --- slug: server-dashboard - sidebar_position: 7 title: Server Dashboard -description: "Access the Kubernetes Dashboard for real-time cluster monitoring and alerting on your PipeOps server." +description: "Access the Prometheus monitoring +tool for your PipeOps server." --- # Server Dashboard -The **Dashboard** section provides direct access to critical monitoring and management tools for server deployments. It integrates Kubernetes (K8) Dashboard, allowing you to visualize and analyze your infrastructure. - -## Accessing Dashboard Section +The **Dashboard** tab gives you direct access to the Prometheus monitoring tool for your server. Use it to +inspect cluster resources in real time and review performance metrics +without leaving PipeOps. -To access Server Dashboard, follow these steps: +:::note +The Dashboard tab is not available on all server types. Availability +depends on your provisioning method and server configuration. +::: -1. Navigate to the **"Servers"** section. -2. Select the desired server from the list. -3. Click on the **Dashboard** tab. +## Accessing the Dashboard -## Key Components +From the **Servers** section, select a server and click the +**Dashboard** tab. -### K8 Dashboard - -This provides a web-based user interface for managing Kubernetes clusters. It allows users to view the status of pods, deployments, services, and other Kubernetes resources. +## Dashboard Tools ### Prometheus -This is a powerful monitoring and alerting system that collects real-time metrics from Kubernetes clusters. It helps you track resource usage and performance trends. +Prometheus is a monitoring and alerting system that collects +real-time metrics from your Kubernetes cluster. In PipeOps, it gives +you access to: + +- Resource usage trends for CPU, memory, and storage. +- Custom metric queries for deeper performance analysis. +- Alerting data for conditions you want to track over time. -## Benefits of the Dashboard Section + -- **Real-Time Monitoring:** Get up-to-date insights into cluster health and resource utilization. -- **Performance Optimization:** Identify issues and optimize workloads for better efficiency. -- **Enhanced Observability:** Gain a detailed view of system metrics, logs, and events. -- **Simplified Management:** Access a user-friendly interface to monitor Kubernetes resources without complex configurations. +:::note +If the tool is unavailable for your server, the relevant section +will indicate that it has not been configured or is not supported +for your server type. +::: diff --git a/docs/servers/server-environments.md b/docs/servers/server-environments.md index 8de3346..1db13a4 100644 --- a/docs/servers/server-environments.md +++ b/docs/servers/server-environments.md @@ -2,90 +2,78 @@ slug: server-environments sidebar_position: 10 title: Server Environments -description: "Create, manage, and delete isolated server environments for development, staging, and production workloads in PipeOps." +description: "Create, manage, and delete isolated server environments +for development, staging, and production workloads in PipeOps." --- -# Server Environments +# Server Environments -Server environments in PipeOps allow you to organize and manage different stages of your application, such as development, staging, and production. Each environment is isolated and can have its own configuration, including environment variables, making it easier to maintain and deploy projects across various stages. +Server environments let you organize deployments into isolated stages +— such as development, staging, and production — each with its own +configuration and environment variables. Variables set at the +environment level are shared across all projects deployed within +that environment. -This section will guide you through creating, managing, and deleting server environments directly from your PipeOps dashboard. +:::note +The number of environments you can create on a server depends on +your subscription plan. See [Pricing](/docs/pricing.md) for plan limits. +::: ## Accessing Environments -To access server environments, follow these steps: +From the **Servers** section, select a server and click the +**Environments** tab. -1. Navigate to the **Servers** section from the sidebar menu. -2. Select the desired server for which you want to manage environments. -3. Click on the **Environments** tab. +By default, every server has two environments: **beta** and +**production**. -There are two environments created for you by default: **beta** and **production**. +![Server Environments tab showing default beta and production environments](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-environment-page.png) +## Create an Environment -![Environments](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-environments.png) +1. Click **+ New Environment** on the right side of the page. +![New Environment button](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-environment-new-button.png) -## Creating a New Environment +2. A modal will appear. Enter a unique name for the environment + (e.g. Development, Staging) and add any environment variables + the environment requires. For each variable, provide a **Name** + (key) and a **Value**. -1. Click on the "+ New Environment" button located on the right-hand side of the screen. +![New environment modal showing name field and environment variables](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-environments-create-modal.png) -![New Environment Button](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/new-server-environment-btn.png) +3. Click **Save**. The new environment will appear alongside + the existing ones. -2. Fill in Environment Details: - - A modal will appear where you can: - - - Enter a unique name for your environment (e.g., Development, Staging). - - - Add environment variables. For each variable, specify the name (key) and value. - -![Edit Environment](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/new-server-environment.png) - -3. Click Save to finalize. - - Once all details are filled in, click the **Save** button to create your new environment. The newly created environment will appear alongside existing ones. - - -## Managing Environments - -For each of your environments, you can perform any of the following actions: - -1. Edit Environment - -2. Delete Environment - -### Edit an Environment: - -To edit your environment, follow these steps: - -1. Click on the three-dot menu (...) next to the environment name. +## Edit an Environment +1. Click the three-dot menu (⋮) next to the environment you want + to update. 2. Select **Edit Environment** from the dropdown. -![Edit Environment](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/edit-server-env.png) - +![Three-dot menu with Edit Environment option highlighted](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-environment-delete.png) -This will open a modal where you can edit your environment name and manage environment variables. +3. A modal will open where you can update the environment name + and manage its environment variables. -![Edit Modal](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/edit-server-modal.png) +![Edit environment modal showing name and variable fields](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-environment-rename-modal.png) -3. Click **Save** to apply changes. +4. Click **Save** to apply your changes. +## Delete an Environment -### Delete an Environment: - -To delete an environment, follow these steps: - -1. Click on the three-dot menu (...) next to the environment name. +:::warning +Deleting an environment is permanent. Ensure no active projects +depend on the environment before proceeding. +::: +1. Click the three-dot menu (⋮) next to the environment you want + to remove. 2. Select **Delete Environment** from the dropdown. -![Delete Env](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/delete-server-env.png) - -3. A confirmation prompt will appear asking you to confirm deletion. Confirm by typing in the environment name and clicking **Delete**. - -![Delete Env Modal](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/delete-server-env-modal.png) - +![Three-dot menu with Delete Environment option highlighted](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-environment-edit.png) +3. A confirmation modal will appear. Type the environment name + to confirm, then click **Delete**. -Server environments simplify organizing and managing different stages of your application lifecycle. Whether you're managing existing environments or creating new ones, PipeOps provides a user-friendly interface to edit, delete, or customize environments as needed. +![Delete environment confirmation modal with name input field](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-environments-delete-modal.png) diff --git a/docs/servers/server-events.md b/docs/servers/server-events.md index bb829a2..57fc935 100644 --- a/docs/servers/server-events.md +++ b/docs/servers/server-events.md @@ -2,38 +2,48 @@ slug: server-events sidebar_position: 4 title: Server Events -description: "View a chronological log of server activities and status changes for monitoring and troubleshooting in PipeOps." +description: "View a chronological log of server activities and status +changes for monitoring and troubleshooting in PipeOps." --- # Server Events -This documentation offers a comprehensive guide to navigating and leveraging the Server Events functionality within PipeOps. +The **Events** tab shows a chronological record of significant +activities and status changes on your server. Use it to track what +has happened on the server, understand state changes, and investigate +issues before diving into metrics or logs. -The Server Events tab shows a chronological record of significant activities and status changes related to your server. From this tab, you can: -- Monitor the health and behavior of your server -- Troubleshoot issues -- Gain insights into its operational history +## Accessing Server Events +From the **Servers** section, select a server and click the +**Events** tab. -## Accessing Server Events +![Server Events tab showing event entries with severity, time, and summary columns](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-events.png) -To access events, follow these steps: -1. Navigate to the **"Servers"** section. -2. Select the desired server from the list. -3. Click on the **Events** tab to open its dashboard. +## Filtering Events -Each event entry on your PipeOps dashboard has three features: **Severity, Time,** and **Summary.** +Use the **Severity** dropdown to filter the event list by level. +This is useful when you want to focus on warnings or errors without +scrolling through normal activity. -![Server Events](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-events.png) +## Event Columns -### Severity -This indicates the seriousness of the event, allowing you to prioritize critical issues. PipeOps categorizes events by different severity levels, such as **warning** and **normal**. +Each entry in the events table includes three columns: -### Time -This shows the date and time an event occurred. PipeOps delivers real-time notifications for status changes. Whether it's a critical issue or a system update, users receive timely alerts. +| Column | Description | +| ------------ | ---------------------------------------------------------------------------------------------------------------------------------- | +| **Severity** | The level of the event — such as **Normal** or **Warning** — indicating how much attention it requires. | +| **Time** | The date and time the event occurred. | +| **Summary** | A short description of what happened, such as a pod being scheduled, a container failing to start, or a node becoming unavailable. | -### Summary -This section provides a brief description of the event. When troubleshooting, **Summary** gives you insight into what went wrong, making it easier to fix issues. +## Using Events for Troubleshooting +Events give you server-level context that sits between high-level +status indicators and detailed logs. When a deployment behaves +unexpectedly or a server changes state, check the Events tab first +to identify what occurred and when before moving into metrics or +application logs. -In conclusion, the events tab records significant occurences within your server environment. Analyzing events is a powerful way to identify causes and their potential troubleshooting steps. +Look for **Warning** severity events as a starting point — these +typically indicate resource pressure, scheduling failures, or +connectivity issues that may affect running workloads. diff --git a/docs/servers/server-metrics.md b/docs/servers/server-metrics.md index e1487ed..1f43c9c 100644 --- a/docs/servers/server-metrics.md +++ b/docs/servers/server-metrics.md @@ -2,57 +2,156 @@ sidebar_position: 3 title: Server Metrics slug: server-metrics -description: "Access and explore server performance metrics in PipeOps including CPU, memory, and other resource utilization graphs." +description: "Monitor server performance in PipeOps with CPU, memory, +storage, network I/O, control plane, and overview metric charts." --- # Server Metrics +The **Metrics** tab gives you a real-time and historical view of your +server's performance. Use it to monitor resource consumption, identify +bottlenecks, and understand how your server behaves over time. + +## Accessing Server Metrics + +From the **Servers** section, select a server and click the +**Metrics** tab. + +The metrics page has a left sidebar for navigating between metric +categories and a **Period** dropdown for adjusting the time range +shown across all charts. + +## Filtering by Time Period + +Use the **Period** dropdown to filter metrics by a relative time +window. Available options include `5m`, `15m`, `1h`, and longer +ranges. When you change the period, all charts in the active metric +section update together. + +## Metric Categories + +Use the left sidebar to move between the following sections, each +covering a different aspect of server health: + +- **Overview** — A summary of key metrics across all categories. +- **CPU** — Processing capacity and throttling. +- **Memory** — Memory usage and capacity. +- **Storage** — Disk usage and total available size. +- **Network I/O** — Traffic, requests, errors, latency, and connections. +- **Control Plane** — Health of the server's control plane components. + +Each chart includes controls for switching the graph view and +expanding it for a closer look at trends. + ## Overview -This documentation guides you through the process of accessing and exploring metrics for your deployed servers using PipeOps. +The **Overview** section gives you a consolidated summary of the most +important metrics across CPU, memory, storage, and network — all in +one place. Use it for a quick server health check before diving into +a specific category. -PipeOps allows users to gain valuable insights into the performance of deployed servers. By analyzing key metrics, you can identify potential issues, ensure efficient resource allocation, and maintain overall system health. +![Server Metrics Overview](/img/server-metrics/metrics-overview.png) -## Accessing Server Metrics +## CPU + +The **CPU** section shows how much processing capacity your server +is using and whether workloads are being constrained by CPU limits. + +![Server CPU metrics](/img/server-metrics/metrics-cpu.png) + +| Chart | What it shows | How to use it | +| ------------------------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | +| **CPU Usage** | CPU consumption over the selected period. | Look for spikes or sustained high usage that may indicate compute-heavy workloads or a need to scale up. | +| **CPU Throttled Periods** | Periods where workloads were restricted for exceeding CPU limits. | Identify workloads consuming more CPU than their configured limits allow — a signal to adjust limits or optimize the workload. | +| **Total CPU Capacity** | Total CPU available to the server over time. | Compare against usage to understand available headroom and plan capacity changes. | + +## Memory + +The **Memory** section shows how server memory is being consumed and +whether usage is approaching available capacity. + +![Server memory metrics](/img/server-metrics/metrics-memory.png) + +| Chart | What it shows | How to use it | +| ------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | +| **Memory Usage** | Current memory consumption over the selected period. | Watch for steady increases or repeated peaks — these may require workload optimization or additional memory. | +| **Memory Max Usage** | The highest recorded memory usage during the selected period. | Understand peak demand, especially during traffic spikes or scheduled jobs, to size memory appropriately. | +| **Total Memory Capacity** | Total memory available to the server over time. | Cross-reference with usage and max usage to catch memory pressure before it affects stability. | + +## Storage + +The **Storage** section helps you track disk usage and understand +how much total storage your server has available. -To view the metrics for your server, follow these steps: +![Server storage metrics](/img/server-metrics/metrics-storage.png) -1. Navigate to the **Servers** section. -2. Select the desired server from the list. -3. Click on the **Metrics** tab to open the metrics dashboard. +| Chart | What it shows | How to use it | +| ---------------------- | ----------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| **Storage Usage** | Disk space consumed over the selected period. | Track growth trends and investigate sudden increases that could indicate log accumulation or data growth. | +| **Total Storage Size** | Total storage capacity available to the server. | Compare against usage to plan capacity increases before storage becomes constrained. | -![server Metrics Overview](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-overview-metric.png) +## Network I/O -The image above illustrates the server metrics overview, offering a quick glimpse of how your server is performing across various metrics. +The **Network I/O** section covers traffic volume, request handling, +response times, error rates, and connection activity. Use it to +understand how traffic moves through the server and how reliably +the server responds. -## Exploring Individual Metrics +### Traffic and Requests -The **Metrics** dashboard includes various performance indicators that can help you monitor resource usage. Each one is represented by detailed graphs and data points. Let's explore some key metrics available: +![Server network traffic and request metrics](/img/server-metrics/metrics-network-top.png) -### CPU Metric +| Chart | What it shows | How to use it | +| --------------------------- | ------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- | +| **Network Traffic** | Inbound and outbound traffic over the selected period. | Identify traffic spikes, drops, or unusual transfer patterns that may need investigation. | +| **Request Count** | Total requests handled by the server. | Use alongside response time and error charts to understand whether volume changes correlate with performance degradation. | +| **Response Duration (P95)** | The 95th percentile response duration. | Captures high-end latency without being skewed by averages — a better indicator of what slower users experience. | +| **HTTP 2xx** | Successful HTTP responses. | Confirm that healthy response volume is tracking with request count. A drop here without a drop in requests may indicate errors. | -The CPU metric displays real-time CPU utilization. It helps you understand the processing power consumed by your server. Here's an example of how the CPU metric might be visualized: +### Errors and Latency -![CPU Metric Example](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-cpu-metric.png) +![Server network error and latency metrics](/img/server-metrics/metrics-network-errors.png) -### Memory Metric +| Chart | What it shows | How to use it | +| -------------------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | +| **HTTP 4xx** | Client-side error responses. | Investigate unexpected increases — these may point to invalid requests, missing routes, or authentication failures. | +| **HTTP 5xx** | Server-side error responses. | Treat spikes as a signal to inspect application logs, upstream services, or infrastructure health. | +| **Error Ratio (%)** | Percentage of requests ending in errors. | Quickly assess whether error volume is isolated or affecting a meaningful share of traffic. | +| **Upstream Latency (P95)** | The 95th percentile latency from upstream services. | Identify whether slow responses originate from the server itself or from dependencies behind it. | -This metric provides insight into how much memory your server and applications are utilizing. Here's an example of how the memory metric might be represented: +### Bandwidth and Connections -![Memory Metric Example](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-memory-metric.png) +![Server network retry, bandwidth, and connection metrics](/img/server-metrics/metrics-network-connections.png) -### Storage Metric +| Chart | What it shows | How to use it | +| ---------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------- | +| **Backend Retries** | Requests retried against backend services. | Rising retries may indicate unstable upstreams or transient network failures worth investigating. | +| **Network Bandwidth** | Bandwidth consumed by network traffic. | Compare against request count and traffic volume to catch unexpected bandwidth growth. | +| **Active Connections** | Open connections over the selected period. | Monitor connection load and detect sudden growth that could strain server capacity. | -The storage metric helps you monitor disk space usage by your server. Here's an example of how the storage metric might be displayed: +## Control Plane -![Storage Metric Example](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-storage-metric.png) +The **Control Plane** section shows the health and availability of +the components responsible for coordinating and managing the server. +Use it to monitor the stability of the server's orchestration layer. -### Network I/O Metric +![Server control plane metrics](/img/server-metrics/metrics-control-plane.png) -This metric shows inbound and outbound data traffic. It helps you understand data transfer between your server and the outside world. +## Interpreting Metrics -![Network I/O Metric Example](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-network-metric.png) +Read related charts together rather than in isolation. A few +patterns to watch for: -Monitoring the control plane metric enables you to identify potential issues and optimize server management. Keep a close eye on this metric to ensure smooth operation and maximize performance. +- **High CPU usage with throttled periods** — Workloads are likely + hitting their CPU limits. Consider raising limits or optimizing + the workloads involved. +- **Rising HTTP 5xx with higher upstream latency** — Slow or failing + responses may originate from a dependency, not the server itself. +- **Steady storage growth** — Investigate log accumulation or + unmanaged data growth before storage becomes constrained. +- **Spikes in active connections with no matching traffic increase** + — May indicate connection leaks or clients not closing connections + cleanly. -By continuously monitoring these metrics, you can optimize your server’s performance, prevent resource exhaustion, and troubleshoot proactively. +Use the **Period** dropdown to compare a short spike against a longer +baseline before making scaling or configuration changes. diff --git a/docs/servers/server-nodes.md b/docs/servers/server-nodes.md index dfa3ce1..cf23303 100644 --- a/docs/servers/server-nodes.md +++ b/docs/servers/server-nodes.md @@ -2,33 +2,46 @@ slug: server-nodes sidebar_position: 6 title: Server Nodes -description: "View individual node details in your server cluster including roles, IP addresses, CPU and RAM usage, pods, and status." +description: "View individual node details in your server cluster +including roles, IP addresses, CPU and RAM usage, pods, and status." --- # Server Nodes -Welcome to the guide for PipeOps' Server Nodes feature. The **Server Nodes** tab offers a comprehensive overview of the individual nodes that make up your server cluster, along with their key resource metrics. +The **Nodes** tab gives you a view of the individual nodes that make +up your server cluster, along with their current resource usage and +status. Use it to check node health, understand resource distribution +across the cluster, and identify nodes that may need attention. ## Accessing Nodes -To access server nodes, follow these steps: -1. Navigate to the **Servers** section. -2. Select the desired server from the list. -3. Click on **Nodes** to open its dashboard. -![Server Nodes](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-nodes-page.png) -## Filtering Options -The Nodes tab offers filtering options to help you narrow down and focus on specific nodes: +From the **Servers** section, select a server and click the +**Nodes** tab. -- **Severity:** The dropdown menu provides options to filter nodes by their severity. -- **Periods:** Allows you to filter the data based on different time periods. +![Server Nodes tab showing node list with resource metrics and status](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-nodes.png) +## Node Information -Each node includes the following information: +Each node in the list displays the following: -- **Name:** The name or identifier of the node. -- **Roles:** The functions the node performs within the cluster, such as worker nodes or control plane nodes. -- **External/Internal IP:** The external and internal IP addresses of the node. -- **CPU:** The CPU utilization of the node. -- **RAM:** The RAM utilization of the node. -- **Pods:** Number of pods running on the node. Pods represent one or more application containers. -- **Status:** The current status of the node (e.g., running, stopped). +| Field | Description | +| --------------- | -------------------------------------------------------------------------- | +| **Name** | The name or identifier of the node within the cluster. | +| **Roles** | The function the node performs — such as worker or control plane. | +| **External IP** | The node's externally reachable IP address. | +| **Internal IP** | The node's internal cluster IP address. | +| **CPU** | Current CPU utilization for the node. | +| **RAM** | Current memory utilization for the node. | +| **Pods** | The number of pods currently running on the node. | +| **Status** | The node's current health state — **Ready**, **NotReady**, or **Unknown**. | + +## Using the Nodes Tab + +Check the **Status** column first when investigating cluster issues. +A node in **NotReady** or **Unknown** state may be causing pod +scheduling failures or deployment instability. Cross-reference high +CPU or RAM utilization with the **Pods** count to identify nodes +that are overloaded relative to others in the cluster. + +For a broader view of server performance, use the +[Metrics](/docs/servers/server-metrics) tab alongside the Nodes tab. diff --git a/docs/servers/server-overview.md b/docs/servers/server-overview.md index b874f21..9fe4400 100644 --- a/docs/servers/server-overview.md +++ b/docs/servers/server-overview.md @@ -2,82 +2,136 @@ slug: server-overview sidebar_position: 2 title: Server Overview -description: "View your server dashboard in PipeOps including node details, deployments, resource usage, cost breakdown, and Grafana monitoring." +description: "View server details in PipeOps across Nova, Bring Your +Own Cloud, and Bring Your Own Server provisioning methods." --- # Server Overview -Here, we’ll talk about the Server Overview feature on PipeOps. This dashboard provides a snapshot of your server’s essential details and associated resources. +The **Overview** tab is the default page when you open a server in +PipeOps. It gives you a quick summary of the server's status, +infrastructure details, resource usage, active deployments, and +recent events. + +The exact layout and available sections vary depending on how the +server was provisioned — [On PipeOps](/docs/getting-started/choose-your-deployment-path/on-pipeops), +[Bring Your Own Cloud](/docs/getting-started/choose-your-deployment-path/on-cloud-provider), +or [Bring Your Own Server](/docs/getting-started/choose-your-deployment-path/bring-your-own-server) +— but the core questions it answers are the same: where is this +server running, what is deployed on it, how much capacity is in use, +and are there any events that need attention? -The Overview tab is the default landing page when you select a server. Some details may vary depending on whether you created your server using **PipeOps** or a **cloud provider**. +## Accessing the Overview -On this page, you will see your server's name and a banner containing the following information: +From the **Servers** section, select a server. The **Overview** tab +opens by default. If you are in another tab, click **Overview** in +the server navigation to return to it. -- **Created**: The date and time your server was created. -- **Region**: The location where your server is currently deployed. -- **Provider**: The cloud provider on which your server is hosted. -- **Kubernetes Version**: The current Kubernetes version running on your server. +## Server Details Banner -![Server Overview](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/pks-server-overview.png) +At the top of every Overview tab, a details banner summarizes the +server's infrastructure metadata. -Additionally, you will find cards displaying the following server-related information: +| Field | Description | +| ---------------------- | --------------------------------------------------------------------------------------------- | +| **Created** | How long ago the server was created or connected. | +| **Region** | The deployment region or gateway region associated with the server. | +| **Provider** | The infrastructure provider — such as PipeOps PKS, Amazon EKS, or another connected provider. | +| **Kubernetes Version** | The Kubernetes version running on the server. | +| **Egress IP** | The outbound IP address used by the server. Availability depends on the server type. | + +## Summary Cards + +Below the details banner, three summary cards show the server's +current scale and activity. + +| Card | What it shows | +| ------------------- | ----------------------------------------------------------------------------------------------------------------------- | +| **Nodes** | The number of nodes currently attached to the server. Click to open node-level details. | +| **Deployments** | The number of projects and add-ons deployed to this server. | +| **Total Resources** | The combined count of Kubernetes resources — such as pods, services, and config maps — currently tracked on the server. | + +## PipeOps Nova Server Overview + +Nova servers are provisioned and managed by PipeOps. Their overview +focuses on the resources PipeOps provisions and bills for on your +behalf. + +![PipeOps Nova server overview](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-create-nova%20server-overview-page.png) + +| Section | What it shows | +| --------------------------------------- | ------------------------------------------------------------------ | +| **Server Details** | Created date, region, provider, Kubernetes version, and egress IP. | +| **Nodes, Deployments, Total Resources** | High-level counts for the server. | +| **Current Usage** | CPU, memory, and storage costs for the current month. | +| **Usage & Capacity** | Capacity indicators for pods, CPU cores, and memory. | +| **K8 Dashboard** | A shortcut for Kubernetes cluster monitoring, when available. | +| **Events** | Recent server events with severity, time, and summary. | + +## Bring Your Own Cloud Server Overview + +BYOC servers run in a cloud account you connected to PipeOps. The +overview reflects cloud-provider-specific infrastructure and may +include additional sections depending on the provider and +configuration method selected during provisioning. + +![Cloud provider server overview](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-created-custom-overview-details.png) + +| Section | What it shows | +| --------------------------------------- | --------------------------------------------------------------------------------------------------------------- | +| **Server Details** | Created date, region, connected provider, and Kubernetes version. | +| **Nodes, Deployments, Total Resources** | A summary of the resources PipeOps tracks in the connected cluster. | +| **Add-ons** | Installed or available cluster add-ons such as autoscaling, certificate management, or secret management tools. | +| **Events** | Recent server events with severity, time, and summary. | + +## Bring Your Own Server Overview + +BYOS servers are machines or VMs you connected to PipeOps. The +overview reflects the connected machine's agent-reported state. + +![Bring Your Own Server overview](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-byos-overview-page.png) + +| Section | What it shows | +| --------------------------------------- | --------------------------------------------------------------------------------- | +| **Server Details** | Created date, gateway region, provider, and Kubernetes version. | +| **Nodes, Deployments, Total Resources** | Summary counts for the connected server. | +| **Current Usage** | CPU, memory, storage, and bandwidth costs for the current month where applicable. | +| **K8 Dashboard** | A shortcut for Kubernetes-level visibility, when available. | +| **Usage & Capacity** | Capacity indicators for pods, CPU cores, and memory. | +| **Events** | Recent server events with severity, time, and summary. | + +## Server Navigation Tabs + +The tabs available on a server vary by provisioning method and +enabled features. + +| Tab | Description | +| ---------------- | ------------------------------------------------------------------------ | +| **Overview** | Server status, infrastructure details, resource usage, and events. | +| **Metrics** | CPU, memory, storage, network I/O, and control plane performance charts. | +| **Events** | A dedicated full-page view of server events. | +| **Nodes** | Node-level details, resource usage, and status. | +| **Environments** | Environments configured for deployments on this server. | +| **Settings** | Server configuration and management options. | + +Depending on the server type, you may also see tabs such as +**Add-ons**, **Pricing**, **Update History**, **Dashboard**, or +**K8 Dashboard**. -- **Nodes**: The number of active nodes currently running on your server. -- **Deployments**: The total number of deployments on your server, including both projects and add-ons. -- **Total Resources**: Get a summary of your server’s capacity and utilization here. Stay informed about the number of unused environments, active subscriptions, team members, your current plan, and available credits. -- **Current Usage**: This field provides a cost breakdown of your infrastructure usage powered by **OpenCost**. - - **Grafana Labs:** This metric is available to users who have installed the Grafana add-on. You can open the Grafana dashboard and monitor your server in real time. +## Events -![Grafana Server Overview](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/grafana.png) +Every server type includes an **Events** section on the Overview tab. +If it is not immediately visible, scroll down the page. +Use the **Severity** filter to narrow the event list by level. +Each event row shows: -From the overview page, you will also see a **navigation menu** to other sections related to your server. - -- If you created a server on **PipeOps**, your navigation menu will include: - - - **Overview** tab - - **Metrics** tab - - **Events** tab - - **Nodes** tab - - **Environments** tab - - **Settings** tab - - ![PKS Server Overview](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/pks-server-overview.png) - -- If you deployed a server using a **cloud provider**, your navigation menu will include everything from the **PipeOps** server, plus: - - **Add-ons** tab - - **Dashboard/Prometheus** tab - - **Pricing** tab - - **Update History** tab - -![Created Server](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/no-karpenter-no-opencost.png) - - -You can also view real-time server events with a **Severity** filter to display specific event types. Events are displayed in a table with the following columns: - -- **Severity**: Filters events by severity level (**Normal**, **Warning**, and **Error**). -- **Time**: Displays the timestamp of when the event occurred. -- **Summary**: Provides a brief summary of the incident details. - -## Conclusion - -This page serves as a central hub for managing and monitoring your server, providing all the essential information at a glance. Use the tab navigation menu to explore additional aspects of your server. - -## Managing Servers via CLI - -You can also manage your servers using the PipeOps CLI: - -```bash -# List all servers -pipeops server list - -# Get server details -pipeops server info my-server - -# Provision a new server -pipeops server create --name prod-server --provider aws -``` - -For server management and agent installation, see: -- [CLI Server Commands](/docs/cli/commands/servers) -- [CLI Agent Commands](/docs/cli/commands/agents) - Install PipeOps agents on your infrastructure +| Column | Description | +| ------------ | -------------------------------------------- | +| **Severity** | The event level — normal, warning, or error. | +| **Time** | When the event occurred. | +| **Summary** | A short description of what happened. | + +Check the Events section when a server changes state unexpectedly, +a deployment behaves abnormally, or you want server-level context +before moving into metrics, logs, or node details. diff --git a/docs/servers/server-pricing.md b/docs/servers/server-pricing.md index eede5ba..a857044 100644 --- a/docs/servers/server-pricing.md +++ b/docs/servers/server-pricing.md @@ -2,39 +2,59 @@ slug: server-pricing sidebar_position: 8 title: Server Pricing -description: "Understand estimated cloud cost breakdowns for servers deployed through PipeOps including per-resource pricing details." +description: "Understand estimated cloud cost breakdowns for servers +deployed through PipeOps including per-resource pricing details." --- # Server Pricing -This documentation provides an overview of the **Server Pricing** feature on PipeOps. Server Pricing gives you an estimated breakdown of cloud costs based on the resources provisioned through PipeOps. This feature is useful for users deploying servers to their cloud accounts, offering transparency on monthly cost estimates. + +The **Pricing** tab shows an estimated monthly cost breakdown for +the resources provisioned on your server through PipeOps. + +:::note +The Pricing tab is available on **Bring Your Own Cloud** servers +only. Nova server costs are tracked separately in the +[Usage](/docs/usage) section. +::: ## Accessing Server Pricing -To access server pricing, follow these steps: -1. Navigate to the **Servers** section. -2. Select the desired server from the list. -3. Click on **Pricing** to open its dashboard. +From the **Servers** section, select a BYOC server and click the +**Pricing** tab. + +![Server Pricing Breakdown](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-pricing.png) + +## Pricing Information -### Key Sections +The Pricing tab displays the following: -The main information displayed on the Server Pricing page includes: +| Field | Description | +| ------------------ | ------------------------------------------------------------------------------ | +| **Total Costs** | The total estimated monthly cost for all provisioned resources on this server. | +| **Region** | The geographic region where the server is deployed. Pricing varies by region. | +| **Default Node** | The primary node instance type configured for the server. | +| **Cost Breakdown** | An itemized estimate of monthly costs per resource type. | -**Total Costs** -You will view the total estimated monthly cost for the provisioned resources here. +## Cost Breakdown -**Region** -This shows the geographical region where the server is deployed. Cloud costs often vary based on region due to differences in infrastructure, energy costs, and demand. +The cost breakdown lists estimated monthly costs for each resource +component provisioned through PipeOps. The specific line items +depend on the cloud provider your server is connected to. -**Default Node** -This specifies the primary node configuration for the server. +For example, an AWS-connected server may show: -**Cost Breakdown** -PipeOps details the monthly cost estimate of what you are provisioning through the platform. You will be able to view an estimate for resources, such as: - Memory - Dedicated instance - Storage volume - Elastic Kubernetes Service (EKS) - Elastic Load Balancer -The **Server Pricing** section in PipeOps is designed to offer a clear breakdown of estimated costs for servers deployed to your cloud account. This feature enhances cost predictability, helping you budget effectively while avoiding unexpected charges. +A GCP or Azure-connected server will display equivalent cost +components for those providers. +:::note +All costs shown are **estimates** based on the resources currently +provisioned. Actual charges are determined by your cloud provider +and may differ based on usage, reserved pricing, or provider +discounts. +::: diff --git a/docs/servers/server-provisioning.md b/docs/servers/server-provisioning.md index da2ff72..5b33904 100644 --- a/docs/servers/server-provisioning.md +++ b/docs/servers/server-provisioning.md @@ -18,17 +18,17 @@ much control you want over the underlying infrastructure. 1. Log in to your [PipeOps dashboard](https://console.pipeops.io/auth/signin). 2. Create a new server using one of the following methods: - Click **+ New** in the top-right corner and select - **Provision a Server** from the dropdown. + **Add Server** from the dropdown. - Click **Servers** in the left sidebar to open the Servers list, then click **+ Create new Server** in the top-right corner. -![Servers list page showing existing servers and the Create new Server button](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/provision-server-nav.png) +![Servers list page showing existing servers and the Create new Server button](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-create-nav.png) ## Select a Hosting Method Select how you want to provision your server. -![Server hosting method selection showing On PipeOps, Bring Your Own Cloud, and Bring Your Own Server options](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/onboarding/onboarding-deployment-path.png) +![Server hosting method selection showing On PipeOps, Bring Your Own Cloud, and Bring Your Own Server options](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-create-choose-path.png) | Option | Description | | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | @@ -56,7 +56,7 @@ that region: for the selected region so you can estimate your usage costs before proceeding. - ![Nova server configuration showing provider selection, region, and per-hour pricing](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/onboarding/onboarding-select-csp.png) + ![Nova server configuration showing provider selection, region, and per-hour pricing](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-create-nova.png) Click **Proceed** to create the server. @@ -78,7 +78,7 @@ following tabs: | **Environments** | Environments configured on this server. | | **Settings** | Server configuration and management options. | -![Nova server overview page showing nodes, deployments, usage, and events](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/pks-server-overview.png) +![Nova server overview page showing nodes, deployments, usage, and events](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-create-nova-server-details..png) ## Provisioning with Bring Your Own Cloud (BYOC) @@ -98,7 +98,7 @@ connected, click **Proceed** to continue. Configure the deployment settings for your cloud server. -![Create A New Server page showing region selection and security specification](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/onboarding/byoc-5.png) +![Create A New Server page showing region selection and security specification](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-create-region-config.png) 1. **Select Region** — Choose the geographic location to deploy your server. @@ -117,7 +117,7 @@ Click **Next: Configure Method** to proceed. Select how you want to manage server resources. -![Create A New Server page showing Custom Configuration and Karpenter options](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/onboarding/byoc-custom-config-7.png) +![Create A New Server page showing Custom Configuration and Karpenter options](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-create-custom-config.png) | Method | Description | | ------------------------ | ----------------------------------------------------------------------------------------------------- | @@ -136,7 +136,7 @@ method you selected. Choose from predefined instance templates suited for different environments. -![Configure Scaling and Resources Management page showing Dev/Staging, Production, and Expert Settings tabs with instance options and estimated cost](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/onboarding/byoc-custom-config-8.png) +![Configure Scaling and Resources Management page showing Dev/Staging, Production, and Expert Settings tabs with instance options and estimated cost](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-create-custom-config-2.png) - **Environment Tab** — Switch between **Dev/Staging**, **Production**, or **Expert Settings** to see relevant @@ -157,7 +157,7 @@ architecture, and define minimum and maximum node counts. Configure how your infrastructure scales, or leave settings on default and proceed. -![Karpenter configuration screen](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/onboarding/byoc-karpentar-12.png) +![Karpenter configuration screen](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-create-karpenter-config-2.png) ### Step 5: Create the Server @@ -169,17 +169,17 @@ method you chose. **Custom Configuration:** -![Server overview page for a Custom Configuration server](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/no-karpenter-no-opencost.png) +![Server overview page for a Custom Configuration server](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-created-custom-overview-details.png) **Karpenter:** -![Server overview page for a Karpenter server](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/has-karpenter-has-opencost-no-grafana.png) +![Server overview page for a Karpenter server](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-created-karpenta-overview-details.png) ## Provisioning with Bring Your Own Server (BYOS) The **Bring Your Own Server** option lets you connect an existing private or public machine, or a VM you control, directly to PipeOps. -See [Bring Your Own Server](/docs/servers/bring-your-own-server) for +See [Bring Your Own Server](/docs/getting-started/choose-your-deployment-path/bring-your-own-server.md) for the full setup steps. ## Deleting a Server @@ -195,10 +195,10 @@ and add-ons on the server must be removed before deletion can proceed. 3. Click the three-dot menu in the top-right corner of the server page. -![Three-dot menu on the server page revealing the delete option](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/delete-pipeops-server.png) +![Three-dot menu on the server page revealing the delete option](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-create-delete.png) 4. Select **Delete Server**. A confirmation modal will appear. -![Server deletion confirmation modal](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/confirm-server-deletion%20modal.png) +![Server deletion confirmation modal](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-create-delete-modal.png) 5. Type the server name to confirm, then click **Delete**. diff --git a/docs/servers/server-update-history.md b/docs/servers/server-update-history.md index a07972b..f2d1f1f 100644 --- a/docs/servers/server-update-history.md +++ b/docs/servers/server-update-history.md @@ -2,38 +2,53 @@ slug: server-update-history sidebar_position: 9 title: Server Update History -description: "View the log of all server updates including version changes, deployment status, build SHAs, and execution details." +description: "View the log of all server updates including version +changes, deployment status, build SHAs, and execution details." --- # Server Update History -The **Update History** feature provides a detailed log of all server updates, including version changes, deployment status, and execution logs. It helps users track deployment progress, view build logs, and troubleshoot issues. -## Accessing Server Update History -1. Navigate to the **"Servers"** section. -2. Select the desired server from the list. -3. Click on the **"Update History"** tab. +The **Update History** tab shows a log of all updates applied to +your server, including version changes, build details, and the +outcome of each update. Use it to track when updates ran, confirm +which Kubernetes version is active, and investigate failed updates +through their logs. -![Server Update History](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-update-history.png) +## Accessing Update History +From the **Servers** section, select a server and click the +**Update History** tab. -Your server update history consists of the following information per each deployment: +![Server Update History tab showing the update log](https://pub-950943fa1bc54978bed46ef104f9d81a.r2.dev/Documentation%20Images/server-creation/server-update-history.png) -- **Build SHA:** This is the unique identifier for each build or update. Clicking the link allows you to inspect the specific build log. +## Update Log Fields -- **Server Type:** This displays the type of server that was used during each build. +Each entry in the update log includes the following: -- **Version:** This displays the version of the update applied to the server. It helps you know which Kubernetes version is currently running or failed. - -- **Start Time:** The timestamp when the update process began. This is useful for tracking update durations. - -- **End Time:** This indicates when the update process was completed. - -- **Action:** This provides a **View Logs** button, allowing you to access detailed deployment logs. Logs provide insights into what occurred during the update process, including errors. - -- **Status:** This indicates whether the update was successful or failed. - -With PipeOps' **update history** functionality, you can efficiently monitor all your server update records. +| Field | Description | +| --------------- | ------------------------------------------------------------------------------------------------------------- | +| **Build SHA** | The unique identifier for the build. Click the link to open the specific build log for that update. | +| **Server Type** | The type of server used during the update. | +| **Version** | The Kubernetes version applied or attempted during the update. | +| **Start Time** | When the update process began. | +| **End Time** | When the update process completed or stopped. | +| **Status** | The outcome of the update — such as **Success** or **Failed**. | +| **Action** | A **View Logs** button that opens the full execution log for that update, including any errors that occurred. | +:::note +The **Build SHA** link and the **View Logs** button both provide +access to build log information. The Build SHA link opens the log +for that specific build, while **View Logs** opens the full +execution log for the update process. +::: +## Using Update History for Troubleshooting +When an update shows a **Failed** status, click **View Logs** to +review the execution log for that entry. The log shows what occurred +during the update process and where it stopped, giving you the +context needed to identify the cause before retrying or escalating. +Cross-reference the **Version** and **Start Time** columns to +confirm which Kubernetes version is currently running and when it +was last successfully applied. diff --git a/docusaurus.config.js b/docusaurus.config.js index d7249cb..b87ee3c 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -65,6 +65,19 @@ const config = { ], ], + plugins: [ + [ + "@cmfcmf/docusaurus-search-local", + { + indexDocs: true, + indexDocSidebarParentCategories: 2, + indexPages: true, + language: "en", + maxSearchResults: 10, + }, + ], + ], + scripts: [ { src: "/js/iframe-compatibility.js", @@ -90,6 +103,10 @@ const config = { src: "img/pipeops-light.svg", }, items: [ + { + type: "search", + position: "right", + }, { href: "https://github.com/pipeops-dev", label: "GitHub", diff --git a/package.json b/package.json index 94b678d..fad6a50 100644 --- a/package.json +++ b/package.json @@ -14,6 +14,7 @@ "write-heading-ids": "docusaurus write-heading-ids" }, "dependencies": { + "@cmfcmf/docusaurus-search-local": "^2.0.1", "@docusaurus/core": "^3.10.0", "@docusaurus/plugin-google-tag-manager": "^3.10.0", "@docusaurus/preset-classic": "^3.10.0", diff --git a/src/css/custom.css b/src/css/custom.css index c2bbda6..445fb69 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -131,6 +131,44 @@ a.navbar__brand { align-items: center; } +.dsla-search-wrapper { + display: flex; + align-items: center; + min-width: 10rem; +} + +.dsla-search-wrapper .aa-Autocomplete, +.dsla-search-wrapper .dsla-search-field { + width: 100%; +} + +.dsla-search-wrapper .aa-DetachedSearchButton, +.dsla-search-wrapper .aa-Form { + background: #1f1f21; + border: 1px solid #363538; + border-radius: 9999px; + color: #d8d8d8; +} + +.dsla-search-wrapper .aa-DetachedSearchButton { + height: 2.25rem; + padding: 0 0.85rem; +} + +.dsla-search-wrapper .aa-Input, +.dsla-search-wrapper .aa-DetachedSearchButtonPlaceholder { + color: #d8d8d8; +} + +.dsla-search-wrapper .aa-Input::placeholder { + color: #a0a0a0; +} + +.dsla-search-wrapper .aa-DetachedSearchButtonIcon, +.dsla-search-wrapper .aa-SubmitIcon { + color: #825dff; +} + a.card { background: #1f1f21; border-radius: 28px; diff --git a/static/img/server-metrics/metrics-control-plane.png b/static/img/server-metrics/metrics-control-plane.png new file mode 100644 index 0000000..39ffcdc Binary files /dev/null and b/static/img/server-metrics/metrics-control-plane.png differ diff --git a/static/img/server-metrics/metrics-cpu.png b/static/img/server-metrics/metrics-cpu.png new file mode 100644 index 0000000..1d9da35 Binary files /dev/null and b/static/img/server-metrics/metrics-cpu.png differ diff --git a/static/img/server-metrics/metrics-memory.png b/static/img/server-metrics/metrics-memory.png new file mode 100644 index 0000000..e63b8b4 Binary files /dev/null and b/static/img/server-metrics/metrics-memory.png differ diff --git a/static/img/server-metrics/metrics-network-connections.png b/static/img/server-metrics/metrics-network-connections.png new file mode 100644 index 0000000..c460c8e Binary files /dev/null and b/static/img/server-metrics/metrics-network-connections.png differ diff --git a/static/img/server-metrics/metrics-network-errors.png b/static/img/server-metrics/metrics-network-errors.png new file mode 100644 index 0000000..3ec2ec6 Binary files /dev/null and b/static/img/server-metrics/metrics-network-errors.png differ diff --git a/static/img/server-metrics/metrics-network-top.png b/static/img/server-metrics/metrics-network-top.png new file mode 100644 index 0000000..a6b8f83 Binary files /dev/null and b/static/img/server-metrics/metrics-network-top.png differ diff --git a/static/img/server-metrics/metrics-overview.png b/static/img/server-metrics/metrics-overview.png new file mode 100644 index 0000000..18f26c8 Binary files /dev/null and b/static/img/server-metrics/metrics-overview.png differ diff --git a/static/img/server-metrics/metrics-storage.png b/static/img/server-metrics/metrics-storage.png new file mode 100644 index 0000000..a60336d Binary files /dev/null and b/static/img/server-metrics/metrics-storage.png differ diff --git a/yarn.lock b/yarn.lock index 4ae4a82..57bc1cd 100644 --- a/yarn.lock +++ b/yarn.lock @@ -20,7 +20,7 @@ "@algolia/autocomplete-plugin-algolia-insights" "1.19.2" "@algolia/autocomplete-shared" "1.19.2" -"@algolia/autocomplete-core@^1.19.2": +"@algolia/autocomplete-core@1.19.8", "@algolia/autocomplete-core@^1.19.2": version "1.19.8" resolved "https://registry.npmjs.org/@algolia/autocomplete-core/-/autocomplete-core-1.19.8.tgz#7c84c771d28643fb00d09026c05013fb97aeea23" integrity sha512-3YEorYg44niXcm7gkft3nXYItHd44e8tmh4D33CTszPgP0QWkaLEaFywiNyJBo7UL/mqObA/G9RYuU7R8tN1IA== @@ -28,6 +28,17 @@ "@algolia/autocomplete-plugin-algolia-insights" "1.19.8" "@algolia/autocomplete-shared" "1.19.8" +"@algolia/autocomplete-js@^1.8.2": + version "1.19.8" + resolved "https://registry.npmjs.org/@algolia/autocomplete-js/-/autocomplete-js-1.19.8.tgz#35960525442d741a0a4ee5ac4e1fcd6c550355ff" + integrity sha512-9Sfr9Un3vObdtnj6IqzxoD9XisjFJxA9WAyVxmOkwTD9aVluyNwDeEWeGLy12xhRyILjA5C7byto159cZcdEEA== + dependencies: + "@algolia/autocomplete-core" "1.19.8" + "@algolia/autocomplete-preset-algolia" "1.19.8" + "@algolia/autocomplete-shared" "1.19.8" + htm "^3.1.1" + preact "^10.13.2" + "@algolia/autocomplete-plugin-algolia-insights@1.19.2": version "1.19.2" resolved "https://registry.npmjs.org/@algolia/autocomplete-plugin-algolia-insights/-/autocomplete-plugin-algolia-insights-1.19.2.tgz#3584b625b9317e333d1ae43664d02358e175c52d" @@ -42,6 +53,13 @@ dependencies: "@algolia/autocomplete-shared" "1.19.8" +"@algolia/autocomplete-preset-algolia@1.19.8": + version "1.19.8" + resolved "https://registry.npmjs.org/@algolia/autocomplete-preset-algolia/-/autocomplete-preset-algolia-1.19.8.tgz#1bfffba816d497193d89692e17aa31cba875e96a" + integrity sha512-5XhJe5uXXLrt+C1MjIv1/BfGNHZyD1xkAYMVANTjdY+PXwO4o+3YIK2XGU0MxHTGryy70G6+xVO9TB7xA+3hGQ== + dependencies: + "@algolia/autocomplete-shared" "1.19.8" + "@algolia/autocomplete-shared@1.19.2": version "1.19.2" resolved "https://registry.npmjs.org/@algolia/autocomplete-shared/-/autocomplete-shared-1.19.2.tgz#c0b7b8dc30a5c65b70501640e62b009535e4578f" @@ -52,6 +70,30 @@ resolved "https://registry.npmjs.org/@algolia/autocomplete-shared/-/autocomplete-shared-1.19.8.tgz#5d723d8bdb448efbb1b0e1c7ff94cc18e5b1dc0e" integrity sha512-h5hf2t8ejF6vlOgvLaZzQbWs5SyH2z4PAWygNAvvD/2RI29hdQ54ldUGwqVuj9Srs+n8XUKTPUqb7fvhBhQrnQ== +"@algolia/autocomplete-theme-classic@^1.8.2": + version "1.19.8" + resolved "https://registry.npmjs.org/@algolia/autocomplete-theme-classic/-/autocomplete-theme-classic-1.19.8.tgz#33706300a2f711ac9386ec8008a0f119ffdccd7b" + integrity sha512-FYmpeOyL5Wy444ZGp1IW57fevpMSBMewN37j+0WULMTJZGobnvTgVEKjYIgtv5Ku4/RNNp54rtEx2/OU6l8GYA== + +"@algolia/cache-browser-local-storage@4.27.0": + version "4.27.0" + resolved "https://registry.npmjs.org/@algolia/cache-browser-local-storage/-/cache-browser-local-storage-4.27.0.tgz#fed0538982fd21858f452f176a7f1678bdc91c55" + integrity sha512-YGog2s57sO20lvpa+hv5XLAAmiTI1kHsCMRtPVfiaOdIQnvRla21lfH08onqEbZihOPVI8GULwt79zQB2ymKzg== + dependencies: + "@algolia/cache-common" "4.27.0" + +"@algolia/cache-common@4.27.0": + version "4.27.0" + resolved "https://registry.npmjs.org/@algolia/cache-common/-/cache-common-4.27.0.tgz#fa49e1be284182dc7124447bea0157781ff03763" + integrity sha512-Sr8zjNXj82p6lO4W9CdzfF0m0/9h/H6VAdSHOTtimm/cTzXIYXRI2IZq7+Nt2ljJ7Ukx+7dIFcxQjE57eQSPsw== + +"@algolia/cache-in-memory@4.27.0": + version "4.27.0" + resolved "https://registry.npmjs.org/@algolia/cache-in-memory/-/cache-in-memory-4.27.0.tgz#0f001a6208ad68dbc2fbbfaf6ca69367b7f81b3c" + integrity sha512-abgMRTcVD0IllNvMM9JFhxtyLn1v6Ey7mQ7+BGS3JCzvkCX7KZqlS0BIuVUDgx9sPIfOeNsG/awGzMmP50TwZw== + dependencies: + "@algolia/cache-common" "4.27.0" + "@algolia/client-abtesting@5.50.2": version "5.50.2" resolved "https://registry.npmjs.org/@algolia/client-abtesting/-/client-abtesting-5.50.2.tgz#0fa6442c8792221d77bbfd42308d7f60aafe4edd" @@ -62,6 +104,25 @@ "@algolia/requester-fetch" "5.50.2" "@algolia/requester-node-http" "5.50.2" +"@algolia/client-account@4.27.0": + version "4.27.0" + resolved "https://registry.npmjs.org/@algolia/client-account/-/client-account-4.27.0.tgz#d0c8e2dfd22806c5238efe8d01431e4b593ed549" + integrity sha512-sSHxwrKTKJrwfoR/LcQJZfmiWJcM5d9Rp7afMChxOcdGdkSdIwrNBC8SCcHRenA3GsZ6mg+j6px7KWYxJ34btA== + dependencies: + "@algolia/client-common" "4.27.0" + "@algolia/client-search" "4.27.0" + "@algolia/transporter" "4.27.0" + +"@algolia/client-analytics@4.27.0": + version "4.27.0" + resolved "https://registry.npmjs.org/@algolia/client-analytics/-/client-analytics-4.27.0.tgz#dc782c08d121cd7c71bc5fa5143d6abe14c73e36" + integrity sha512-MqIDyxODljn9ZC4oqjQD0kez2a4zjIJ9ywA/b7cIiUiK/tDjZNTVjYd9WXMKQlXnWUwfrfXJZClVVqN1iCXS+Q== + dependencies: + "@algolia/client-common" "4.27.0" + "@algolia/client-search" "4.27.0" + "@algolia/requester-common" "4.27.0" + "@algolia/transporter" "4.27.0" + "@algolia/client-analytics@5.50.2": version "5.50.2" resolved "https://registry.npmjs.org/@algolia/client-analytics/-/client-analytics-5.50.2.tgz#458d2c4119ff543dfd2c0ebd685ac6c3c279bdec" @@ -72,6 +133,14 @@ "@algolia/requester-fetch" "5.50.2" "@algolia/requester-node-http" "5.50.2" +"@algolia/client-common@4.27.0": + version "4.27.0" + resolved "https://registry.npmjs.org/@algolia/client-common/-/client-common-4.27.0.tgz#6fd6f61d97d5208da3c38aebe8c54fb052902d95" + integrity sha512-ZrT6l/YPQgyIUuBCxcYPeXol2VBLUMuNb1rKXrm6z1f/iTiwqtnEEb16/6CC11+Re0ZGXrdcMVrgDRrzveQ1aQ== + dependencies: + "@algolia/requester-common" "4.27.0" + "@algolia/transporter" "4.27.0" + "@algolia/client-common@5.50.2": version "5.50.2" resolved "https://registry.npmjs.org/@algolia/client-common/-/client-common-5.50.2.tgz#059ff282b52106f592d77a59b3993d01e51d2918" @@ -87,6 +156,15 @@ "@algolia/requester-fetch" "5.50.2" "@algolia/requester-node-http" "5.50.2" +"@algolia/client-personalization@4.27.0": + version "4.27.0" + resolved "https://registry.npmjs.org/@algolia/client-personalization/-/client-personalization-4.27.0.tgz#dd9597c8baff815c7667706abb333ba8d53b5d09" + integrity sha512-OZqaFFVm+10hAlmxpiTWi/o2n+YKBESbSqSy2yXAumPH/kaK4moJHFblbh8IkV3KZR0lLm4hzPtn8Q2nWNiDUA== + dependencies: + "@algolia/client-common" "4.27.0" + "@algolia/requester-common" "4.27.0" + "@algolia/transporter" "4.27.0" + "@algolia/client-personalization@5.50.2": version "5.50.2" resolved "https://registry.npmjs.org/@algolia/client-personalization/-/client-personalization-5.50.2.tgz#a3b536106afe5940fb0ad4c864ada2c8c8a11f04" @@ -107,6 +185,15 @@ "@algolia/requester-fetch" "5.50.2" "@algolia/requester-node-http" "5.50.2" +"@algolia/client-search@4.27.0", "@algolia/client-search@^4.12.0": + version "4.27.0" + resolved "https://registry.npmjs.org/@algolia/client-search/-/client-search-4.27.0.tgz#90a5846144636a0a1facea5813fde2b206067739" + integrity sha512-qmX/f67ay0eZ4V5Io8fWWOcUVo/gqre2yei1PnmEhQU2Gul6ushg25QnNrfu4BODiRrw1rwYveZaLCiHvcUxrQ== + dependencies: + "@algolia/client-common" "4.27.0" + "@algolia/requester-common" "4.27.0" + "@algolia/transporter" "4.27.0" + "@algolia/client-search@5.50.2": version "5.50.2" resolved "https://registry.npmjs.org/@algolia/client-search/-/client-search-5.50.2.tgz#27501c5c0a457891c5246d6c23e3c4b81bba8e8e" @@ -132,6 +219,18 @@ "@algolia/requester-fetch" "5.50.2" "@algolia/requester-node-http" "5.50.2" +"@algolia/logger-common@4.27.0": + version "4.27.0" + resolved "https://registry.npmjs.org/@algolia/logger-common/-/logger-common-4.27.0.tgz#af11004baea4469f2028594257e5dfec8c6d3f68" + integrity sha512-pIrmQRXtDV+zTMVXKtKCosC2rWhn0F0TdUeb9etA6RiAz6jY6bY6f0+JX7YekDK09SnmZMLIyUa7Jci+Ied9bw== + +"@algolia/logger-console@4.27.0": + version "4.27.0" + resolved "https://registry.npmjs.org/@algolia/logger-console/-/logger-console-4.27.0.tgz#a82089b51290bbb4fe11f899cae1487c9acbec72" + integrity sha512-UWvta8BxsR/u5z9eI088mOSLQaGtmoCtXeN3DYJurlxAdJwPuKtEb5+433kxA6/E9f2/JgoW89KZ1vNP9pcHBQ== + dependencies: + "@algolia/logger-common" "4.27.0" + "@algolia/monitoring@1.50.2": version "1.50.2" resolved "https://registry.npmjs.org/@algolia/monitoring/-/monitoring-1.50.2.tgz#2a346a7445bb965b2930bdb6303a7f9361da3320" @@ -142,6 +241,23 @@ "@algolia/requester-fetch" "5.50.2" "@algolia/requester-node-http" "5.50.2" +"@algolia/recommend@4.27.0": + version "4.27.0" + resolved "https://registry.npmjs.org/@algolia/recommend/-/recommend-4.27.0.tgz#159f230c9a123e5781499cba8b7d05c235bfca5e" + integrity sha512-CFy54xDjrsazPi3KN04yPmLRDT72AKokc3RLOdWQvG0/uEUjj7dhWqe9qenxpL4ydsjO7S1eY5YqmX+uMGonlg== + dependencies: + "@algolia/cache-browser-local-storage" "4.27.0" + "@algolia/cache-common" "4.27.0" + "@algolia/cache-in-memory" "4.27.0" + "@algolia/client-common" "4.27.0" + "@algolia/client-search" "4.27.0" + "@algolia/logger-common" "4.27.0" + "@algolia/logger-console" "4.27.0" + "@algolia/requester-browser-xhr" "4.27.0" + "@algolia/requester-common" "4.27.0" + "@algolia/requester-node-http" "4.27.0" + "@algolia/transporter" "4.27.0" + "@algolia/recommend@5.50.2": version "5.50.2" resolved "https://registry.npmjs.org/@algolia/recommend/-/recommend-5.50.2.tgz#8f0264ffbbfe183198e3ee8dbe9d621bfa0d248c" @@ -152,6 +268,13 @@ "@algolia/requester-fetch" "5.50.2" "@algolia/requester-node-http" "5.50.2" +"@algolia/requester-browser-xhr@4.27.0": + version "4.27.0" + resolved "https://registry.npmjs.org/@algolia/requester-browser-xhr/-/requester-browser-xhr-4.27.0.tgz#bab981bb46dded2897e4ad327e222e7ec836df28" + integrity sha512-dTenMBIIpyp5o3C2ZnfbsuSlD/lL9jPkk6T+2+qm38fyw2nf49ANbcHFE79NgiGrnmw7QrYveCs9NIP3Wk4v6g== + dependencies: + "@algolia/requester-common" "4.27.0" + "@algolia/requester-browser-xhr@5.50.2": version "5.50.2" resolved "https://registry.npmjs.org/@algolia/requester-browser-xhr/-/requester-browser-xhr-5.50.2.tgz#8285f922d2ac4ff5663cb0b22f28e3f32727b9cf" @@ -159,6 +282,11 @@ dependencies: "@algolia/client-common" "5.50.2" +"@algolia/requester-common@4.27.0": + version "4.27.0" + resolved "https://registry.npmjs.org/@algolia/requester-common/-/requester-common-4.27.0.tgz#0586c4df662f9dce712a5e99db61932b82328700" + integrity sha512-VC3prAQVgWTubMStb3mJz6i61Hqbtagi2LeIbgNtoFJFff3XZDcAaO1D5r0GYl2+DrB2VzUHnQXbkiuI+HHYyg== + "@algolia/requester-fetch@5.50.2": version "5.50.2" resolved "https://registry.npmjs.org/@algolia/requester-fetch/-/requester-fetch-5.50.2.tgz#a0c33f399be213d6f678d2b7ca91fc5e9435a619" @@ -166,6 +294,13 @@ dependencies: "@algolia/client-common" "5.50.2" +"@algolia/requester-node-http@4.27.0": + version "4.27.0" + resolved "https://registry.npmjs.org/@algolia/requester-node-http/-/requester-node-http-4.27.0.tgz#ba3637ff150b1161e793f7a2722ec5033ea74f77" + integrity sha512-y8nUqaUQeSOQ5oaNo0b2QPznyBFW9LoIwljyUphJ+gUZpU6O/j2/C8ovoqDpIe6J0etqHg5RCcBizrCFZuLpyw== + dependencies: + "@algolia/requester-common" "4.27.0" + "@algolia/requester-node-http@5.50.2": version "5.50.2" resolved "https://registry.npmjs.org/@algolia/requester-node-http/-/requester-node-http-5.50.2.tgz#c5e3a3cf2863393c7d9f012a455973c48fd140a4" @@ -173,6 +308,15 @@ dependencies: "@algolia/client-common" "5.50.2" +"@algolia/transporter@4.27.0": + version "4.27.0" + resolved "https://registry.npmjs.org/@algolia/transporter/-/transporter-4.27.0.tgz#525935ca0333101a3c6cff1304e4191d061cf629" + integrity sha512-PvSbELU4VjN3xSX79ki+zIdOGhTxyJXWvRDzkUjfTx2iNfPWDdTjzKbP1o+268coJztxrkuBwJz90Urek7o1Kw== + dependencies: + "@algolia/cache-common" "4.27.0" + "@algolia/logger-common" "4.27.0" + "@algolia/requester-common" "4.27.0" + "@babel/code-frame@^7.0.0", "@babel/code-frame@^7.28.6", "@babel/code-frame@^7.29.0": version "7.29.0" resolved "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.29.0.tgz#7cd7a59f15b3cc0dcd803038f7792712a7d0b15c" @@ -1067,6 +1211,21 @@ "@babel/helper-string-parser" "^7.27.1" "@babel/helper-validator-identifier" "^7.28.5" +"@cmfcmf/docusaurus-search-local@^2.0.1": + version "2.0.1" + resolved "https://registry.npmjs.org/@cmfcmf/docusaurus-search-local/-/docusaurus-search-local-2.0.1.tgz#0b41d75084fb3f0552e76838240ca1ae30d49819" + integrity sha512-4Gk313a+9HGetIFB9f087Qrmba5svx0zY9xZ10QKd79Nic0IsY0/JktDqFMZ51IDuL+9yIMOsdeKb313ce2mnw== + dependencies: + "@algolia/autocomplete-js" "^1.8.2" + "@algolia/autocomplete-theme-classic" "^1.8.2" + "@algolia/client-search" "^4.12.0" + algoliasearch "^4.12.0" + cheerio "^1.0.0" + clsx "^2.0.0" + lunr-languages "^1.4.0" + mark.js "^8.11.1" + tslib "^2.6.3" + "@colors/colors@1.5.0": version "1.5.0" resolved "https://registry.npmjs.org/@colors/colors/-/colors-1.5.0.tgz#bb504579c1cae923e6576a4f5da43d25f97bdbd9" @@ -3303,6 +3462,27 @@ algoliasearch-helper@^3.26.0: dependencies: "@algolia/events" "^4.0.1" +algoliasearch@^4.12.0: + version "4.27.0" + resolved "https://registry.npmjs.org/algoliasearch/-/algoliasearch-4.27.0.tgz#cc4fcffb79013dd14b182f63b2182d59ab1eb050" + integrity sha512-C88C5grLa5VOCp9eYZJt+q99ik7yNdm92l7Q9+4XK0Md8kL05Lg8l2v9ZVX0uMW3mH9pAFxMMXlLOvqNumA4lw== + dependencies: + "@algolia/cache-browser-local-storage" "4.27.0" + "@algolia/cache-common" "4.27.0" + "@algolia/cache-in-memory" "4.27.0" + "@algolia/client-account" "4.27.0" + "@algolia/client-analytics" "4.27.0" + "@algolia/client-common" "4.27.0" + "@algolia/client-personalization" "4.27.0" + "@algolia/client-search" "4.27.0" + "@algolia/logger-common" "4.27.0" + "@algolia/logger-console" "4.27.0" + "@algolia/recommend" "4.27.0" + "@algolia/requester-browser-xhr" "4.27.0" + "@algolia/requester-common" "4.27.0" + "@algolia/requester-node-http" "4.27.0" + "@algolia/transporter" "4.27.0" + algoliasearch@^5.37.0: version "5.50.2" resolved "https://registry.npmjs.org/algoliasearch/-/algoliasearch-5.50.2.tgz#0ce5bc3ca15c7854e4845b9cbbe29fc2854d9627" @@ -3761,6 +3941,23 @@ cheerio@1.0.0-rc.12: parse5 "^7.0.0" parse5-htmlparser2-tree-adapter "^7.0.0" +cheerio@^1.0.0: + version "1.2.0" + resolved "https://registry.npmjs.org/cheerio/-/cheerio-1.2.0.tgz#f23b777c49021ead7475dcf3390d3535a7f896d6" + integrity sha512-WDrybc/gKFpTYQutKIK6UvfcuxijIZfMfXaYm8NMsPQxSYvf+13fXUJ4rztGGbJcBQ/GF55gvrZ0Bc0bj/mqvg== + dependencies: + cheerio-select "^2.1.0" + dom-serializer "^2.0.0" + domhandler "^5.0.3" + domutils "^3.2.2" + encoding-sniffer "^0.2.1" + htmlparser2 "^10.1.0" + parse5 "^7.3.0" + parse5-htmlparser2-tree-adapter "^7.1.0" + parse5-parser-stream "^7.1.2" + undici "^7.19.0" + whatwg-mimetype "^4.0.0" + chokidar@^3.5.3, chokidar@^3.6.0: version "3.6.0" resolved "https://registry.npmjs.org/chokidar/-/chokidar-3.6.0.tgz#197c6cc669ef2a8dc5e7b4d97ee4e092c3eb0d5b" @@ -4426,7 +4623,7 @@ domutils@^2.5.2, domutils@^2.8.0: domelementtype "^2.2.0" domhandler "^4.2.0" -domutils@^3.0.1: +domutils@^3.0.1, domutils@^3.2.2: version "3.2.2" resolved "https://registry.npmjs.org/domutils/-/domutils-3.2.2.tgz#edbfe2b668b0c1d97c24baf0f1062b132221bc78" integrity sha512-6kZKyUajlDuqlHKVX1w7gyslj9MPIXzIFiz/rGu35uC1wMi+kMhQwGhl4lt9unC9Vb9INnY9Z3/ZA3+FhASLaw== @@ -4509,6 +4706,14 @@ encodeurl@~2.0.0: resolved "https://registry.npmjs.org/encodeurl/-/encodeurl-2.0.0.tgz#7b8ea898077d7e409d3ac45474ea38eaf0857a58" integrity sha512-Q0n9HRi4m6JuGIV1eFlmvJB7ZEVxu93IrMyiMsGC0lrMJMWzRgx6WGquyfQgZVb31vhGgXnfmPNNXmxnOkRBrg== +encoding-sniffer@^0.2.1: + version "0.2.1" + resolved "https://registry.npmjs.org/encoding-sniffer/-/encoding-sniffer-0.2.1.tgz#396ec97ac22ce5a037ba44af1992ac9d46a7b819" + integrity sha512-5gvq20T6vfpekVtqrYQsSCFZ1wEg5+wW0/QaZMWkFr6BqD3NfKs0rLCx4rrVlSWJeZb5NBJgVLswK/w2MWU+Gw== + dependencies: + iconv-lite "^0.6.3" + whatwg-encoding "^3.1.1" + enhanced-resolve@^5.20.0: version "5.20.1" resolved "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.20.1.tgz#eeeb3966bea62c348c40a0cc9e7912e2557d0be0" @@ -4532,6 +4737,11 @@ entities@^6.0.0: resolved "https://registry.npmjs.org/entities/-/entities-6.0.1.tgz#c28c34a43379ca7f61d074130b2f5f7020a30694" integrity sha512-aN97NXWF6AWBTahfVOIrB/NShkzi5H7F9r1s9mD3cDj4Ko5f2qhhVoYMibXF7GlLveb/D2ioWay8lxI97Ven3g== +entities@^7.0.1: + version "7.0.1" + resolved "https://registry.npmjs.org/entities/-/entities-7.0.1.tgz#26e8a88889db63417dcb9a1e79a3f1bc92b5976b" + integrity sha512-TWrgLOFUQTH994YUyl1yT4uyavY5nNB5muff+RtWaqNVCAK408b5ZnnbNAUEWLTCpum9w6arT70i1XdQ4UeOPA== + error-ex@^1.3.1: version "1.3.4" resolved "https://registry.npmjs.org/error-ex/-/error-ex-1.3.4.tgz#b3a8d8bb6f92eecc1629e3e27d3c8607a8a32414" @@ -5280,6 +5490,11 @@ hpack.js@^2.1.6: readable-stream "^2.0.1" wbuf "^1.1.0" +htm@^3.1.1: + version "3.1.1" + resolved "https://registry.npmjs.org/htm/-/htm-3.1.1.tgz#49266582be0dc66ed2235d5ea892307cc0c24b78" + integrity sha512-983Vyg8NwUE7JkZ6NmOqpCZ+sh1bKv2iYTlUkzlWmA5JD2acKoxd4KVxbMmxX/85mtfdnDmTFoNKcg5DGAvxNQ== + html-escaper@^2.0.2: version "2.0.2" resolved "https://registry.npmjs.org/html-escaper/-/html-escaper-2.0.2.tgz#dfd60027da36a36dfcbe236262c00a5822681453" @@ -5332,6 +5547,16 @@ html-webpack-plugin@^5.6.0: pretty-error "^4.0.0" tapable "^2.0.0" +htmlparser2@^10.1.0: + version "10.1.0" + resolved "https://registry.npmjs.org/htmlparser2/-/htmlparser2-10.1.0.tgz#fe3f2e12c73b6e462d4e10395db9c1119e4d6ae4" + integrity sha512-VTZkM9GWRAtEpveh7MSF6SjjrpNVNNVJfFup7xTY3UpFtm67foy9HDVXneLtFVt4pMz5kZtgNcvCniNFb1hlEQ== + dependencies: + domelementtype "^2.3.0" + domhandler "^5.0.3" + domutils "^3.2.2" + entities "^7.0.1" + htmlparser2@^6.1.0: version "6.1.0" resolved "https://registry.npmjs.org/htmlparser2/-/htmlparser2-6.1.0.tgz#c4d762b6c3371a05dbe65e94ae43a9f845fb8fb7" @@ -5427,6 +5652,13 @@ hyperdyperid@^1.2.0: resolved "https://registry.npmjs.org/hyperdyperid/-/hyperdyperid-1.2.0.tgz#59668d323ada92228d2a869d3e474d5a33b69e6b" integrity sha512-Y93lCzHYgGWdrJ66yIktxiaGULYc6oGiABxhcO5AufBeOyoIdZF7bIfLaOrbM0iGIOXQQgxxRrFEnb+Y6w1n4A== +iconv-lite@0.6.3, iconv-lite@^0.6.3: + version "0.6.3" + resolved "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz#a52f80bf38da1952eb5c681790719871a1a72501" + integrity sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw== + dependencies: + safer-buffer ">= 2.1.2 < 3.0.0" + iconv-lite@~0.4.24: version "0.4.24" resolved "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz#2022b4b25fbddc21d2f524974a474aafe733908b" @@ -5941,6 +6173,16 @@ lru-cache@^5.1.1: dependencies: yallist "^3.0.2" +lunr-languages@^1.4.0: + version "1.20.0" + resolved "https://registry.npmjs.org/lunr-languages/-/lunr-languages-1.20.0.tgz#d145555fdeb546300b1394860d768487b8e0e182" + integrity sha512-3LVgE7ekWXt04NBci/hjm+NXJxXZeRXuyClL0kA0HONyBOjxhP3ZQkuWIM4Ok3pbeptUW/rj3XcJcJuJVPwPYA== + +mark.js@^8.11.1: + version "8.11.1" + resolved "https://registry.npmjs.org/mark.js/-/mark.js-8.11.1.tgz#180f1f9ebef8b0e638e4166ad52db879beb2ffc5" + integrity sha512-1I+1qpDt4idfgLQG+BNWmrqku+7/2bi5nLf4YwF8y8zXvmfiTBY3PV3ZibfrjBueCByROpuBjLLFCajqkgYoLQ== + markdown-extensions@^2.0.0: version "2.0.0" resolved "https://registry.npmjs.org/markdown-extensions/-/markdown-extensions-2.0.0.tgz#34bebc83e9938cae16e0e017e4a9814a8330d3c4" @@ -7020,7 +7262,7 @@ parse-numeric-range@^1.3.0: resolved "https://registry.npmjs.org/parse-numeric-range/-/parse-numeric-range-1.3.0.tgz#7c63b61190d61e4d53a1197f0c83c47bb670ffa3" integrity sha512-twN+njEipszzlMJd4ONUYgSfZPDxgHhT9Ahed5uTigpQn90FggW4SA/AIPq/6a149fTbE9qBEcSwE3FAEp6wQQ== -parse5-htmlparser2-tree-adapter@^7.0.0: +parse5-htmlparser2-tree-adapter@^7.0.0, parse5-htmlparser2-tree-adapter@^7.1.0: version "7.1.0" resolved "https://registry.npmjs.org/parse5-htmlparser2-tree-adapter/-/parse5-htmlparser2-tree-adapter-7.1.0.tgz#b5a806548ed893a43e24ccb42fbb78069311e81b" integrity sha512-ruw5xyKs6lrpo9x9rCZqZZnIUntICjQAd0Wsmp396Ul9lN/h+ifgVV1x1gZHi8euej6wTfpqX8j+BFQxF0NS/g== @@ -7028,7 +7270,14 @@ parse5-htmlparser2-tree-adapter@^7.0.0: domhandler "^5.0.3" parse5 "^7.0.0" -parse5@^7.0.0: +parse5-parser-stream@^7.1.2: + version "7.1.2" + resolved "https://registry.npmjs.org/parse5-parser-stream/-/parse5-parser-stream-7.1.2.tgz#d7c20eadc37968d272e2c02660fff92dd27e60e1" + integrity sha512-JyeQc9iwFLn5TbvvqACIF/VXG6abODeB3Fwmv/TGdLk2LfbWkaySGY72at4+Ty7EkPZj854u4CrICqNk2qIbow== + dependencies: + parse5 "^7.0.0" + +parse5@^7.0.0, parse5@^7.3.0: version "7.3.0" resolved "https://registry.npmjs.org/parse5/-/parse5-7.3.0.tgz#d7e224fa72399c7a175099f45fc2ad024b05ec05" integrity sha512-IInvU7fabl34qmi9gY8XOVxhYyMyuH2xUNpb2q8/Y+7552KlejkRvqvD19nMoUW/uQGGbqNpA6Tufu5FL5BZgw== @@ -7702,6 +7951,11 @@ posthog-js@^1.372.6: query-selector-shadow-dom "^1.0.1" web-vitals "^5.1.0" +preact@^10.13.2: + version "10.29.2" + resolved "https://registry.npmjs.org/preact/-/preact-10.29.2.tgz#3e6069c471718b8d124d1cd67565114532e88d70" + integrity sha512-7tNmwg/7mzzAoB/8kSg6Hl37JraAZw3Z3A0JSY7VXlZwo82Xn0G7wKbNNs2qoF4ZEEsQGTwDAroNdqKs1ofJxQ== + preact@^10.28.2: version "10.29.1" resolved "https://registry.npmjs.org/preact/-/preact-10.29.1.tgz#2a5b936efe91cfe1e773cdb55dceb55d148d1d4b" @@ -8290,7 +8544,7 @@ safe-buffer@~5.1.0, safe-buffer@~5.1.1: resolved "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz#991ec69d296e0313747d59bdfd2b745c35f8828d" integrity sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g== -"safer-buffer@>= 2.1.2 < 3": +"safer-buffer@>= 2.1.2 < 3", "safer-buffer@>= 2.1.2 < 3.0.0": version "2.1.2" resolved "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz#44fa161b0187b9549dd84bb91802f9bd8385cd6a" integrity sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg== @@ -8888,7 +9142,7 @@ tslib@^1.9.3: resolved "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz#cf2d38bdc34a134bcaf1091c41f6619e2f672d00" integrity sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg== -tslib@^2.0.0, tslib@^2.0.3, tslib@^2.6.0, tslib@^2.8.1: +tslib@^2.0.0, tslib@^2.0.3, tslib@^2.6.0, tslib@^2.6.3, tslib@^2.8.1: version "2.8.1" resolved "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz#612efe4ed235d567e8aba5f2a5fab70280ade83f" integrity sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w== @@ -8930,6 +9184,11 @@ undici-types@~7.19.0: resolved "https://registry.npmjs.org/undici-types/-/undici-types-7.19.2.tgz#1b67fc26d0f157a0cba3a58a5b5c1e2276b8ba2a" integrity sha512-qYVnV5OEm2AW8cJMCpdV20CDyaN3g0AjDlOGf1OW4iaDEx8MwdtChUp4zu4H0VP3nDRF/8RKWH+IPp9uW0YGZg== +undici@^7.19.0: + version "7.27.0" + resolved "https://registry.npmjs.org/undici/-/undici-7.27.0.tgz#8f1d99dfc28273fe8a5736aa93a507850fda78c9" + integrity sha512-+t2Z/GwkZQDtu00813aP66ygViGtPHKhhoFZpQKpKrE+9jIgES+Zw+mFNaDWOVRKiuJjuqKHzD3B1sfGg8+ZOQ== + unicode-canonical-property-names-ecmascript@^2.0.0: version "2.0.1" resolved "https://registry.npmjs.org/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-2.0.1.tgz#cb3173fe47ca743e228216e4a3ddc4c84d628cc2" @@ -9302,6 +9561,18 @@ websocket-extensions@>=0.1.1: resolved "https://registry.npmjs.org/websocket-extensions/-/websocket-extensions-0.1.4.tgz#7f8473bc839dfd87608adb95d7eb075211578a42" integrity sha512-OqedPIGOfsDlo31UNwYbCFMSaO9m9G/0faIHj5/dZFDMFqPTcx6UwqyOy3COEaEOg/9VsGIpdqn62W5KhoKSpg== +whatwg-encoding@^3.1.1: + version "3.1.1" + resolved "https://registry.npmjs.org/whatwg-encoding/-/whatwg-encoding-3.1.1.tgz#d0f4ef769905d426e1688f3e34381a99b60b76e5" + integrity sha512-6qN4hJdMwfYBtE3YBTTHhoeuUrDBPZmbQaxWAqSALV/MeEnR5z1xd8UKud2RAkFoPkmB+hli1TZSnyi84xz1vQ== + dependencies: + iconv-lite "0.6.3" + +whatwg-mimetype@^4.0.0: + version "4.0.0" + resolved "https://registry.npmjs.org/whatwg-mimetype/-/whatwg-mimetype-4.0.0.tgz#bc1bf94a985dc50388d54a9258ac405c3ca2fc0a" + integrity sha512-QaKxh0eNIi2mE9p2vEdzfagOKHCcj1pJ56EEHGQOVxp8r9/iszLUUV7v89x9O1p/T+NlTM5W7jW6+cz4Fq1YVg== + which@^2.0.1: version "2.0.2" resolved "https://registry.npmjs.org/which/-/which-2.0.2.tgz#7c6a8dd0a636a0327e10b59c9286eee93f3f51b1"