Skip to main content
Version: v3

Plan your setup

Review each item before you install DevPortal. The links open the sections that cover each decision.

Namespace​

Choose the namespace in Step 1. The example uses devportal; Step 2 creates it, and later kubectl and Helm commands use the same namespace.

Plugins​

The plugin catalog index enables the default plugins. Add plugins or override the defaults through the chart's global.dynamic.plugins values. See Disable a default plugin for the override form.

You can also install a plugin through the portal's Marketplace. See Install a plugin from the marketplace for the Kubernetes flow.

Secrets strategy​

Create the runtime Secret in Step 5 with your PostgreSQL and identity provider settings. The chart passes that Secret to the portal. See Step 5: Create the runtime Secret and Step 6: Install DevPortal.

Database​

The chart installs no database. For production, provide a PostgreSQL database that you operate and give the portal a user that can create databases. DevPortal creates a separate database for each plugin that needs one. The guide starts a disposable PostgreSQL in Step 3 for the example install. See Before you start and Step 3: Start PostgreSQL.

Ingress and TLS​

Choose DNS names for the portal and identity provider, and select your Ingress class. Create a TLS Secret with a certificate that covers both names. See Step 1: Choose names and generate secrets, Step 2: Create the namespace and the TLS Secret, and Step 6: Install DevPortal.

Guest sign-in​

Guest sign-in maps guests to user:default/admin. Chart 1.0.3 and earlier turn it on; from chart 1.0.4 it is off. Set global.veecode.guestAuth.enabled: false in the chart values before you expose the portal to users, whichever chart version you install. See Step 6: Install DevPortal.

RBAC​

The default plugins include the RBAC screens, and the RBAC backend is part of the image. Permission checks are off by default, so every signed-in user can install plugins from the Marketplace. See What ships by default.

Checklist before deploying​

  • Choose the namespace and DNS names, and set the Ingress class.
  • Provide PostgreSQL and a database user that can create databases.
  • Choose an OIDC identity provider and create the runtime Secret.
  • Create a TLS Secret from a certificate that covers the portal and identity provider names.
  • Set chart values for Ingress, OIDC sign-in, and any plugin additions or overrides.
  • Disable guest sign-in before exposing the portal to users.
  • If the cluster has no internet access, prepare the chart archive and registry mirror.