Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/add-ons/add-on-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
<!-- [Learn more about environments](/docs/how-to-guides/tutorials/managing-environments) -->
- **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

Expand Down
10 changes: 5 additions & 5 deletions docs/add-ons/add-on-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
18 changes: 9 additions & 9 deletions docs/projects/project-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/projects/project-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
58 changes: 58 additions & 0 deletions docs/servers/server-add-ons.md
Original file line number Diff line number Diff line change
@@ -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.
34 changes: 0 additions & 34 deletions docs/servers/server-addons.md

This file was deleted.

45 changes: 26 additions & 19 deletions docs/servers/server-dashboard.md
Original file line number Diff line number Diff line change
@@ -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
<!-- PLACEHOLDER: Screenshot of the Prometheus view or metrics interface -->

- **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.
:::
Loading