Skip to main content

Simple setup

Welcome to the VeeCode Platform DevPortal complete product installation guide. This guide will help you install the product. In this simplified version of the tutorial, you won't need a database in the Kubernetes cluster. We will be using SQLite for this installation.

Overview​

This guide will cover the following steps:

  1. Creating a Repository for Hosting Your Catalog in the DevPortal
  2. Configuring the DevPortal with your credentials and deploying it to your cluster
  3. Accessing the DevPortal

By following these steps, you'll be able to install the DevPortal product on your cluster and explore its features.

To continue, select your preferred provider:

Prerequisites (GitHub)​

Before you start, you'll need to have the following:

  • An existing Kubernetes cluster for the installation.
  • A GitHub account.
  • A GitHub OAuth App Client ID and Client Secret
  • A GitHub personal access token
  • A DNS name you will use to access the DevPortal (say, "devportal.yourdomain.com")

In the next sections, we will provide a brief tutorial on how to generate the GitHub OAuth App Client ID, Client Secret, and a personal access token. If you already know how to generate these or have them readily available, feel free to skip the upcoming tutorial and proceed directly to Step 1 of the installation guide.

Create a new GitHub OAuth App​

1. Create a New OAuth App

First, click here and then click on "New OAuth App". Fill in the required information, including:

  • Application name: Choose a name that's easily identifiable, such as "devportal".
  • Homepage URL: https://devportal.yourdomain.com
  • Description: (Optional) Add a brief description of the application, such as "VeeCode DevPortal".
  • Authorization callback URL: https://devportal.yourdomain.com/api/auth/github/handler/frame

Make sure to replace "devportal.yourdomain.com" with the actual domain used in your kubernetes applications.

Leave the "Enable device flow" checkbox unselected and click on "Register application".

2. Write down the Client ID and click on "Generate a New Client Secret"

After registering the OAuth App, save the Client ID displayed on the screen. Then, click on "Generate a new client secret" and save the generated Client Secret.

Finally, click on "Update application" at the bottom of the page to save your changes.

By completing these steps, you have successfully generated a GitHub OAuth App and collected the Client ID and Client Secret to use in your application.

The reason for generating these credentials is to enable the Devportal to authenticate users via GitHub. The Client ID uniquely identifies your application, while the Client Secret serves as a secret key for authentication. This OAuth App allows the Devportal to securely connect to GitHub's API and access user information, ensuring a seamless integration between the Devportal and users' GitHub accounts.

Create an Access Token on GitHub​

1. Create a new Access Token

To generate an access token, click here and then click "Generate new token". Choose the classic mode option and fill in the requested information.

  • Name: any proper label, such as "devportal-token"
  • Expiration date: we recommend setting it to 90 days

2. Select the Correct Scopes for the Token In the "Select scopes" section, select the "repo" scopes (select all) and "workflow" scopes. Make sure no other option is selected.

3. Create the Token

Click "Generate token" to create the access token. Copy the token and store it in a secure location, as it will only be displayed once.

With these three steps, you have successfully generated an access token on GitHub. Make sure to use to keep those safe.

The reason for the generation of these credentials is so that you can have access to the Devportal plugins.

Step 1: Creating a Repository for Hosting Your Catalog in the DevPortal​

The initial step to using the DevPortal involves setting up a repository to host your catalog. The catalog maps and exposes specifications, APIs, templates, and other resources. Depending on your preferred provider (GitHub or GitLab), the process may differ slightly.

First, select your preferred provider:

Creating a repository on Github with the files you have, follows this process:

  1. Go to public-catalog on GitHub.
  2. In the upper right corner of the page, click the "Fork" button.
  3. In "Owner", select your account or the organization that you want to fork the repository to. Keep the original repository name and then click "Create fork"
  4. The repository will be forked to your account.
  5. You will be redirected to your forked repository.

Now you can make changes to your forked repository without affecting the original repository.

Important: Please remember to save the name of the repository you created, as you will need it in subsequent steps of the installation process.

And there you have it! Your GitHub repository is now set up correctly for the DevPortal to map and expose your catalog's contents.

Step 2: Configuring the DevPortal with your credentials and deploying it to your cluster​

To configure DevPortal deployment, edit the YAML file provided below and replace the following information with your own:

The file should be created with the name "values" by default.

  1. Copy this values.yaml file:

    replicas: 1
    image:
      repository: veecode/devportal-bundle
      tag: latest
      pullPolicy: IfNotPresent

    environment: development

    service:
      enabled: true
      name: devportal
      type: ClusterIP
      containerPort: 7007

    ingress:
      enabled: true
      host: <devportal-host> #devportal.com
      className: nginx
      # className: kong
      # annotations:
      #   konghq.com/https-redirect-status-code: "308"
      #   konghq.com/preserve-host: "true"
      #   konghq.com/protocols: "https"
      #   konghq.com/strip-path: "false"
      tls:
        secretName: devportal-secret

    resources:
      requests:
        cpu: 500m
        memory: 512Mi
      limits:
        cpu: 1000m
        memory: 1Gi

    appConfig:
      title: Devportal
      app:
        baseUrl: <devportal-host>
      backend:
        baseUrl: <devportal-host>
        secret: 56616a93-ac28-42ab-929d-6ec1fc008c54
      database:
        client: better-sqlite3

    auth:
      providers:
        github:
          clientId: <github-client-id>
          clientSecret: <github-client-secret>

    integrations:
      github:
        token: <github-token>

    catalog:
      providers:
        github:
          organization: <github-organization> # string
          catalogPath: /catalog-info.yaml # string
          filters:
            branch: main # Optional. Uses `master` as default
            repository: <repository-name> #suggestion devportal-catalog
            validateLocationsExist: true

    platform:
      guest:
        enabled: true
      apiManagement:
        enabled: false
        readOnlyMode: false

  2. Replace <devportal-host>: This placeholder appears in two places: under ingress.host, and in appConfig under app.baseUrl and backend.baseUrl. Replace it with the hostname where your DevPortal will be accessible, such as devportal.yourdomain.com.

  3. Update Database Connection: In the appConfig.database.connection section, you should replace:

    • <database-url>: Replace it with your PostgreSQL database server's hostname.
    • <username> and <password>: Replace these with the appropriate credentials to access your PostgreSQL database.

  4. Set GitHub OAuth Credentials: In the auth.providers.github section, replace:

    • <github-client-id> and <github-client-secret>: Replace these with your GitHub OAuth app's client ID and client secret.

  5. Set GitHub Token: In the integrations.github section, replace <github-token> with your GitHub personal access token.

  6. Configure Catalog Repository: In the catalog.providers.github section:

    • Replace <github-organization>: This should be replaced with your GitHub username or organization name.
    • Replace <repository-name>: This should be replaced with the name of your GitHub repository.

  1. Open a terminal in the same directory as the YAML file.

  2. Add the Veecode Platform repository to Helm by executing the following command:

    helm repo add veecode-platform https://veecode-platform.github.io/public-charts/

    This command enables Helm to access charts from the Veecode Platform repository.

  3. Update Helm with the latest chart versions from all your repositories:

    helm repo update

    This command retrieves the latest version information about all the charts from the repositories that Helm is aware of.

  4. After successfully completing the steps above, you can install or upgrade the Devportal platform using the following command:

    helm upgrade platform-devportal --install --values ./values.yaml veecode-platform/devportal

    This command upgrades (or installs if it does not exist) the platform-devportal release with the configuration specified in the values.yaml file. The chart used is from the veecode-platform repository, specifically the devportal chart.

By following these steps, Helm is properly configured with the Veecode Platform repository and updated with the latest chart information before upgrading or installing the Devportal platform.

Disclaimer

If you're interested in a deeper understanding of the DevPortal chart, visit the documentation on Artifact Hub, click here.

Step 3: Accessing the DevPortal​

Once the DevPortal deployment is completed, you can access it by following this step:

  1. Open your web browser and navigate to the DevPortal host.

You should now have full access to the VeeCode Platform DevPortal and be able to explore its features.

Conclusion​

Congratulations! You have successfully installed the VeeCode Platform DevPortal. By following this product installation guide, you have set up the DevPortal on your cluster and can now begin to use.

If you encounter any issues during the installation process, please reach out to the support team for assistance or join our community.