Skip to main content

Pre-requisites

Disclaimer

This demonstration will use Github (for code repositories) and Okteto Cloud (for the runtime), for the sake of being freely available for everyone. Please understand that VeeCode Platform can run on pretty much any cloud or on-prem environment and it also supports most version control solutions in the market.

Why we are here

VeeCode Platform is based on Backstage. A core feature from Backstage is software scaffolding - the ability to create new code repositories from predefined customizable templates.

In order to install the Devportal demo there are three prerequisites that you need to complete:

  • Install Helm
  • Create an Okteto Cloud Account
  • Configure kubeconfig for Okteto

In this documentation, we will walk you through prerequisites step by step.

Install Helm

Helm is a package manager that helps you install and manage applications into a Kubernetescluster. To install Helm you can follow the official instructions on "Installing Helm" or simply follow the steps below:

  1. You can fetch and run the Helm installation script by running the following command:
curl "https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3" | bash

Mac users may use Homebrew instead:

brew install helm
  1. Once Helm is installed, open your terminal or command prompt and verify the installation by running the command helm version. You should see the Helm version information displayed.
  2. Run the following command to add the VeeCode Platform Helm repository:
helm repo add veecode-platform "https://veecode-platform.github.io/public-charts/"
helm repo update

This command adds the VeeCode Platform repository to your Helm configuration, allowing you to fetch and install the Devportal demo chart.

Creating an Okteto Cloud Account

A free Okteto Cloud account will grant you a personal namespace in a  free Kubernetes cluster. This namespace provides a convenient way to develop against Kubernetes without complexity. Okteto is a great product we recommend for any Kubernetes environment, so please give it a try!

By following this tutorial you will deploy VeeCode DevPortal on your Okteto Cloud cluster using our own CLI - so rest assured you will not need to learn any Kubernetes at all.

In order to create an account on Okteto Cloud you just need to:

  1. Install the Okteto CLI by running the following command:
curl "https://get.okteto.com" -sSfL | sh

Mac users may use Homebrew instead:

brew install okteto
  1. Go to https://okteto.com/ and click on "Login" in the top-right corner of the page.
  2. Select "Login with GitHub" to continue with your GitHub account.
  3. Authenticate normally to GitHub (we always recommend two-factor authentication to be enabled, by the way).
  4. After successfully signing in, you will be taken to the Okteto Dashboard. Click on "New Namespace" to create a new namespace for your remote cluster.
  5. Provide a name for your namespace and click on "Create". Your namespace will be created, and you will be directed to the namespace dashboard.
  6. You're now ready use your free remote cluster!

With Helm and an Okteto namespace available you have now fulfilled the prerequisites for deploying your own Devportal demo environment. These steps ensure that the demo operates in a safe dedicated namespace within your Okteto cluster.

Configuring kubeconfig for Okteto

To configure your shell environment for Okteto use under your Okteto account use the following commands:

okteto context use https://cloud.okteto.com # login
okteto kubeconfig

The commands above will set your shell environment in a way that every typical kubernetes command (like kubectl or helm) will work against your Okteto cluster.

Conclusion

Completing these three prerequisites is essential to successfully install the Devportal demo. Once you have an installed Helm, created an Okteto account, and configured your kubeconfig file for Okteto, you can continue with the installation process. For more information on how to proceed, please don't hesitate to reach out to us.