> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Orchestrate the full lifecycle of Lerian applications in customer-owned infrastructure: install, upgrade, roll back, undeploy, and monitor deployments.

**Lifecycle Management** builds on the [Distr platform](https://distr.sh/docs/getting-started/what-is-distr/) to orchestrate the full lifecycle of Lerian applications in customer-owned infrastructure. This tool gives your team direct access to our official **Helm Charts** for self-managed deployments.

<Note>
  Lifecycle Management is the operational backbone of the [BYOC deployment model](/en/start-here/evaluate-and-deploy/deployment-models). If you're using the **SaaS** model, Lerian handles deployment and lifecycle operations for you. You do not need this tool.
</Note>

## Why use Lifecycle Management?

***

Lifecycle Management supports customer-managed infrastructure:

* **Bring Your Own Cluster (BYOC)**: Run Lerian services in Kubernetes environments you fully control, whether on-premises, in a private cloud, or in a hybrid setup.
* **Token-protected distribution**: All artifact access is token-protected. Only authenticated users can retrieve Helm Charts and container images.
* **Operational visibility**: Our support team can remotely monitor deployed versions, health and availability signals, and compatibility with supported releases, without infringing on your autonomy.
* **Full autonomy**: Take full control over installations, upgrades, rollbacks, and version pinning, from the dashboard or from native Kubernetes tools.

We ship our applications as OCI images and Helm Charts, so you can use standard Kubernetes tools to deploy, configure, and operate your services.

## Accessing the Lifecycle dashboard

***

<Note>
  The Lifecycle dashboard is available to **Enterprise BYOC** customers only. Customers without the Lifecycle dashboard manage deployments directly with Helm.
</Note>

Before you can install Lerian applications through Lifecycle Management, you need access to the Lifecycle dashboard.

To begin:

<Steps>
  <Step>
    Send a valid **company email** to the **Implementation Team,** or via email to [suporte@lerian.studio](mailto:suporte@lerian.studio).
  </Step>

  <Step>
    We'll register your email and trigger an invite from the platform.
  </Step>

  <Step>
    Check your inbox and follow the invitation link.
  </Step>

  <Step>
    Create your password to activate your account.
  </Step>

  <Step>
    Log in at [https://lifecycle.lerian.studio/](https://lifecycle.lerian.studio/) and begin managing your deployments.
  </Step>
</Steps>

## Installation guide

***

Once you have dashboard access, follow these steps to install and configure the Lerian product you want to deploy.

### 1. Access the Lifecycle Management dashboard

Go to [https://lifecycle.lerian.studio/login](https://lifecycle.lerian.studio/login) and log in with your credentials.

### 2. Create a new deployment

<Steps>
  <Step>
    In the navigation bar, click Deployments.

    * If you don't have any deployments yet, the **Install a new Agent** window appears automatically.
    * Otherwise, click **+ New Agent.**
  </Step>

  <Step>
    Select **Kubernetes via Helm Chart**.
  </Step>

  <Step>
    Fill in the **Agent Name** and the **Kubernetes Namespace**.
  </Step>

  <Step>
    Leave **Enable cluster-scope permissions** off.
  </Step>

  <Step>
    Click Continue .
  </Step>
</Steps>

### 3. Install the agent in your cluster

After selecting the agent type, the following screen shows a custom `kubectl` command for your deployment.

#### 3.1. Before running the command:

Check if the namespace exists:

```
kubectl get namespace
```

If it doesn't exist, create the namespace you selected for the deployment:

```
kubectl create namespace <namespace>
```

#### 3.2. Copy the Helm install command from the install new Agent window.

It typically looks like this, but with your unique token and environment:

```
kubectl apply -n <namespace> -f "https://app.distr.sh/api/v1/connect?targetId=<target-id>&targetSecret=<target-secret>"
```

<Danger>
  Always copy the command exactly as shown in the UI. It includes deployment-specific values.
</Danger>

#### 3.3. Run the command in your terminal.

Use a terminal connected to your Kubernetes cluster and run the command you copied.

#### 3.4. Confirm that the agent was installed

To verify the agent installation:

```
kubectl get pods -n <namespace>
```

You should see a pod named `distr-agent-xxxxx` with the status Running.

#### 3.5. Click the Continue button in the Install a new Agent window.

### 4. Configure your application

<Steps>
  <Step>
    Select the application you want to deploy and the version.
  </Step>

  <Step>
    The Helm values appear automatically. You can use the **Helm values** section to apply environment-specific configuration, like:

    * Replica counts.
    * Secrets and environment variables.
    * Domain and ingress settings.
  </Step>
</Steps>

<Danger>
  **Never** use the Helm default information. It is example information. Do not use it in a production environment.
</Danger>

After you define your secrets and variables in Helm, save a copy of your secrets in your secrets manager service.

### 5. Monitor your deployment

You can track the status in two ways:

* In your Kubernetes cluster, using kubectl or your preferred dashboard.
* In the Lifecycle dashboard, with a centralized view of agent status and deployed versions.

<Note>
  For detailed Helm agent configuration and advanced capabilities, refer to the official Distr documentation: [Onboarding a Helm App](https://distr.sh/docs/guides/onboarding-a-helm-app/#creating-a-new-deployment)
</Note>

## Manage a deployed application

***

After the agent runs your application, the Lifecycle dashboard lets you:

1. Update your application.
2. Roll back to a previous version.
3. Undeploy the application.
4. Monitor and alert app health and drift.

<Note>
  Reach out to the Lerian support team if you'd like help configuring alerts or managing your update schedule.
</Note>

### Update or roll back your application

To update your application:

<Steps>
  <Step title="Open the update dialog">
    Click the **Update** button on the **Deployments** page.
  </Step>

  <Step title="Select the version">
    Select the version from the **Version** dropdown.
  </Step>

  <Step title="Adjust the Helm values">
    Adjust the Helm values if needed.
  </Step>

  <Step title="Deploy">
    Click **Deploy**.
  </Step>
</Steps>

<Note>
  To roll back, follow the same steps but choose a previously deployed version.
</Note>

### Undeploy the application

To undeploy the application:

<Steps>
  <Step>
    From the **Deployments** page, click the three dots (<Icon icon="ellipsis-vertical" />) next to the **Update** button and select **Undeploy**.
  </Step>

  <Step>
    A confirmation window will appear. Follow the instructions to continue.
  </Step>
</Steps>

### Delete the application

To delete:

<Steps>
  <Step>
    After undeploying, click the three dots (<Icon icon="ellipsis-vertical" />) next to **+ Deployment** and select **Delete**.
  </Step>

  <Step>
    A confirmation window will appear. Follow the instructions to continue.
  </Step>
</Steps>