Skip to content

Latest commit

 

History

History
273 lines (176 loc) · 12.1 KB

enterprise-license.md

File metadata and controls

273 lines (176 loc) · 12.1 KB

Install Devtron Enterprise Trial

Introduction

With the Enterprise version of Devtron, you can access the premium features beyond the open-source version. For your advanced and challenging use cases, you get comprehensive enterprise features including but not limited to:

  1. Release orchestration
  2. Resource monitoring
  3. Advanced filtering
  4. Fine-grained access control
  5. Security scans
  6. Policies related to approval, deployment, plugins, tags, infra...and many more.

Enjoy an uninterrupted 14-day free trial and explore all the features of Devtron Enterprise to their full potential.

{% hint style="info" %}

Already using Devtron's Open Source version?

This guide is intended for fresh installation of Devtron Enterprise.
If you're currently using the open-source (OSS) version of Devtron, we do not recommend converting your existing setup to the Enterprise edition.

Instead, we suggest you to perform a fresh installation of Devtron Enterprise for the best experience. {% endhint %}

Install Devtron Enterprise

{% hint style="warning" %}

Note

Please ensure that cluster kubeconfig is properly configured and available in your system. {% endhint %}

1. Add Devtron Helm Repository

helm repo add devtron https://helm.devtron.ai
helm repo update devtron

2. Choose an Installation Option

{% tabs %}

{% tab title="Devtron in Full Mode" %}

  • To install Devtron with all core enterprise features except ArgoCD:
helm install devtron devtron/devtron-enterprise --create-namespace --namespace devtroncd
  • To include ArgoCD integration, add --set devtron.argo-cd.enabled=true
helm install devtron devtron/devtron-enterprise --create-namespace --namespace devtroncd --set devtron.argo-cd.enabled=true

{% endtab %}

{% tab title="Devtron without integrations (only Dashboard)" %}

To install only the Devtron Dashboard (without CI/CD, ArgoCD, Security, Notification, or Monitoring):

helm install devtron devtron/devtron-enterprise --create-namespace --namespace devtroncd \
--set devtron.installer.modules={} --set devtron.security.enabled=false  \
--set devtron.notifier.enabled=false  --set devtron.security.trivy.enabled=false --set devtron.monitoring.grafana.enabled=false

{% endtab %}

{% endtabs %}

3. Obtain the Dashboard URL

{% tabs %}

{% tab title="For EKS/AKS/GKE" %}

Run the following command to get the Dashboard URL:

kubectl get svc -n devtroncd devtron-service -o jsonpath='{.status.loadBalancer.ingress}'

You can access your Devtron Dashboard using the LoadBalancer URL displayed in the output. {% endtab %}

{% tab title="MicroK8s/Kind/K3s" %}

Accessing the Dashboard locally (MicroK8s/Kind/K3s)

To obtain the Dashboard URL when MicroK8s/Kind/K3s running locally, run the following command to port-forward the devtron service to port 8000

kubectl -n devtroncd port-forward service/devtron-service 8000:80

After port-forwarding, The Dashboard URL will be: http://127.0.0.1:8000

Accessing the Dashboard via NodePort

To obtain the Dashboard URL on MicroK8s/Kind/K3s using NodePort, run the following command to retrieve the port number assigned to the service:

kubectl get svc -n devtroncd devtron-service -o jsonpath='{.spec.ports[0].nodePort}'

The Dashboard URL will be: http://<HOST_IP>:<NODEPORT>/dashboard

Accessing the Dashboard locally from a remote VM (Port Forwarding via Kubeconfig)

To obtain the Dashboard URL if Devtron is installed on a remote VM (e.g., AWS EC2, Azure VM, GCP Compute Engine) using MicroK8s, Kind, or K3s, run the following commands:

scp user@cloud-vm-ip:/path/to/kubeconfig ~/.kube/config 
# Export the kubeconfig file from the remote VM to your local system.

kubectl config use-context <context-name>
# Set the correct context.

kubectl -n devtroncd port-forward service/devtron-service 8000:80
# This command will forward traffic from the service running on the 
# remote VM's MicroK8s, Kind, or K3s cluster to your local system’s port.

The Dashboard URL will be http://127.0.0.1:8000 on your local machine.

{% endtab %}

{% tab title="Minikube" %}

To access the dashboard on Minikube cluster, run the following command:

minikube service devtron-service --namespace devtroncd

This will directly open the dashboard URL on your browser

{% endtab %}

{% tab title="Cloud VMs" %}

Accessing the Dashboard via NodePort

To obtain the dashboard URL on Cloud VMs using NodePort, run the following command to retrieve the port number assigned to the service:

kubectl get svc -n devtroncd devtron-service -o jsonpath='{.spec.ports[0].nodePort}'

The Dashboard URL will be: http://<HOST_IP>:<NODEPORT>/dashboard

Accessing the Dashboard locally from a remote VM (Port Forwarding via Kubeconfig)

To obtain the Dashboard URL if Devtron is installed on a remote VM (e.g., AWS EC2, Azure VM, GCP Compute Engine) using MicroK8s, Kind, or K3s, run the following commands:

scp user@cloud-vm-ip:/path/to/kubeconfig ~/.kube/config 
# Export the kubeconfig file from the remote VM to your local system.

kubectl config use-context <context-name>
# Set the correct context.

kubectl -n devtroncd port-forward service/devtron-service 8000:80
# This command will forward traffic from the service running on the 
# remote VM's MicroK8s, Kind, or K3s cluster to your local system’s port.

The Dashboard URL will be http://127.0.0.1:8000 on your local machine.

{% endtab %}

{% endtabs %}

License Activation

Upon successfully obtaining the dashboard URL and accessing the dashboard, you will see a License Activation screen upon visiting your Dashboard URL as shown below. If you already have a license key, paste it and click Activate. If not, you can generate a fresh license key.

Figure 1: License Activation Screen

Generate License Key

  1. You will see an installation fingerprint that uniquely identifies your installation. Copy the fingerprint and click the Get License link.

    Figure 2: Copying Installation Fingerprint

{% hint style="info" %}

What if my installation is airgapped and has no Internet access?

In case your installation is not connected to the Internet, clicking the Get License link will display a QR code that you can scan with an Internet-enabled device to obtain a license (check snapshot). {% endhint %}

  1. Log in to the License Dashboard using SSO with a valid work email. Personal email addresses are not allowed.

    Figure 3: Log in to License Dashboard

  2. From your work email address, the system will try to autopopulate the details in the form. If not, you can enter or modify the details too.

    Figure 4: Entering User Details

  3. Paste the fingerprint you copied earlier and click Get License Key.

    Figure 5: Pasting Installation Fingerprint

  4. Your license will be generated. Copy the license key.

    Figure 6: Copying Generated License Key

{% hint style="warning" %}

Note

The license key you generate will be valid only for your enterprise installation. It is uniquely mapped to your installation fingerprint. {% endhint %}

  1. Go back to your License Activation page (from step 1). Paste your license key and click Activate.

    Figure 7: Pasting License Key and Activating

{% hint style="info" %}

Facing Issues?

Visit the Troubleshoot section to identify the issue or connect with Devtron Support. {% endhint %}

Log in to Devtron

  1. After successful license activation, you will see the Devtron login page.

    Figure 8: Devtron Login Page

  2. Initially, log in with the administrator credentials. By default, the username is admin. Run the following command to get the admin password:

kubectl -n devtroncd get secret devtron-secret \
-o jsonpath='{.data.ADMIN_PASSWORD}' | base64 -d

{% hint style="info" %}

Note

When you install Devtron for the first time, it creates a default admin user and password (with unrestricted access to Devtron). You can use it to log in as an administrator.

After the initial login, we recommend you set up any Single Sign-On (SSO) service like Google, GitHub, etc., and then add other users (including yourself). Subsequently, all the users can use the same SSO (let's say, GitHub) to log in to the Dashboard. {% endhint %}

Additional Actions

Check License Details

In Devtron, click the Help menu (top-right corner) → About Devtron to know the following:

  • License details (Key and Expiry)
  • Installation fingerprint
  • Enterprise version

Figure 9: 'About Devtron' Help Menu

Update License

If you have a new license key, you can update the license key directly within Devtron, from the About Devtron page.

Figure 10: Updating License

Renew License

If your trial license has expired and you wish to renew it, email us at [email protected] or reach out to your Devtron representative.

Troubleshoot Issues

Issue What it means Where is it shown Solution
License Claimed
Snapshot		 Someone from your organization has already availed a license License Dashboard Reach out to [email protected] for another trial
Invalid License Key
Snapshot		 The license key is incorrect or partial License Activation Page Go to the License Dashboard and recheck the license
License Key No Longer Valid
Snapshot		 The license key has become invalid for your installation fingerprint License Activation Page Generate a new license from License Dashboard.
Invalid Fingerprint
Snapshot		 The fingerprint is incorrect or partial License Dashboard Go to the License Activation Page and verify the fingerprint
License Has Expired
Snapshot		 You have exhausted the free trial License Activation Page or License Dashboard Reach out to [email protected] for renewal
License Key Already Exists for Fingerprint
Snapshot		 You cannot generate more than 1 license key for 1 fingerprint License Dashboard Contact Support