Skip to main content

Get Started with Entigo Portal

This guide walks you through Entigo Portal at app.entigo.com: from first sign-in to a running application.

You need
  • An invitation to your organization from an admin. There is no self sign-up.
  • A cloud account with admin access, to connect to Entigo
  • For command-line access: kubectl, the oidc-login plugin and WireGuard
You'll have
An application running in its own Zone, on a cluster in your AWS account that you manage from the Portal.
  1. 1Sign in
  2. 2Create a workspace
  3. 3Create the infrastructure
  4. 4Create a Zone
  5. 5Deploy your app
  6. 6Add data servicesoptional
  7. 7Invite your team
  8. 8Connect from your machine
  9. 9Keep it up to date
Two ways to create resources
  • Click in the Portal. This guide shows you how.
  • Write YAML files and deploy them with kubectl or ArgoCD. The Guides show you how.

Where a step can also be done with YAML, it links to the matching guide.

1. Sign in​

Open app.entigo.com and select Login.

Access to the Portal is by invitation. If you don't have an account yet, or the Portal says you don't have access to any organizations, ask your organization admin to invite you.

2. Create a workspace​

A Workspace is one cloud account with its own cluster, for example one per environment or business unit.

  1. Open Workspaces in the sidebar and select Add workspace.
  2. Enter a name: lowercase letters, numbers and hyphens, starting with a letter.
  3. Wait a few minutes until the workspace appears in the list.
  4. Select it in the Workspace selector at the top of the page. All the next steps happen inside this workspace.

3. Create the infrastructure​

Open Infrastructure and select Create. The Portal sets up new infrastructure on AWS.

  1. Screen 1Connect your AWS account
    1. Choose AWS and enter your Account ID.
    2. Under AWS CloudFormation Stack, select Create. AWS opens a stack that gives Entigo access. You only do this once per account.
    3. Create the stack in AWS.
    4. Back in the Portal, wait for Stack created successfully, then select Next. The Portal checks by itself; Refresh checks right away.
  2. Screen 2Configure the cluster
    1. Choose the Region and a VPC Network CIDR that does not overlap with your other networks.
    2. Set up the first node pool. The defaults keep costs low.
    3. Select Create.
  3. ThenWait for the build
    • Follow the progress on the Pipelines tab. The first run can take a few minutes to show up.
    • When the cluster is ready, Workloads, Web Access, Registry and Data Services unlock in the sidebar.
Already running Infralib yourself?

Choose one of the Observer options instead of AWS. The Portal then shows the config to add to your Infralib agent, and does not build anything itself.

4. Create a Zone​

A Zone gives a team or product its own Namespaces and node pool, isolated from the rest of the cluster.

Two Zones are created for you during provisioning:

  • main for your applications, with the node pool you configured in step 3. You can deploy into it right away.
  • infralib for the platform's own services. Leave it to the platform.

To give a team or product its own Zone:

  1. Open Infrastructure → Status. In the Zones card, select Add zone.
  2. Enter a zone name and configure its main node group.

On the zone's page you can:

  • Add Namespaces and edit node pools.
  • See under Privilege mapping which user groups have which role.
Role mapping, network policy and other advanced options, in YAMLCreate a Zone›

5. Deploy your application​

  1. Open Workloads and create a new workload. At the top, pick the Workspace and Zone it goes into.

  2. Workload: enter a name, choose the Namespace, and choose the type, a web application or a cron job.

  3. Source: pick an existing image from a Container Repository, or create a new repository and push your image to it with the commands shown. Deploying straight from GitHub is coming soon.

    Tip

    You can also create the repository in Registry first and push your image there. The workload form then lets you pick it.

  4. Configuration: set the container start command, CPU and memory. To make the app reachable from the internet, turn on External traffic and pick a Gateway. Its domain is then created together with the workload.

The workload page has Status, Configuration, Logs, Metrics and Versions tabs.

Later, open Web Access to add aliases to the domain or see its DNS records.

Prefer to deploy from Git?

Use ArgoCD instead of the Workloads wizard:

  1. Connect the VPN, see step 8. ArgoCD is only reachable through it.
  2. Open Infrastructure → AddOns and star Argo CD. It now appears in the sidebar.
  3. Open Argo CD and deploy into your Zone's project. Create a Zone shows how.

6. Add data services (optional)​

If your application needs a database, cache, bucket or message broker, open Data Services, select Add service and pick one:

Configure it and create it. Connection details are stored in a Kubernetes Secret that your workload can read.

Each tile opens the guide for creating the same service as YAML.

7. Invite your team​

Open IAM → Users and select Invite user:

  1. Enter the person's email, first name and last name.
  2. Choose Personal access, or add them to a Group so that access is managed for the whole group.
  3. Choose where the access applies: the organization, a workspace, or a single Zone in a workspace.
  4. Choose a Role and select Send.

Organization admins can invite to any level; workspace owners can invite to their own workspace. The Roles tab lists the roles in the workspace and lets you define your own.

8. Connect from your workstation​

The cluster API, ArgoCD and Grafana are on internal addresses. Connect the VPN to reach them:

  1. Open Infrastructure → VPN and select Configure.
  2. Download the Wireguard Client Config, or scan the QR code on your phone.
  3. Import it into a WireGuard client and connect.

Then download the kubeconfig from the ⋯ menu on the Infrastructure page and use kubectl.

Full setup and troubleshootingAccess a cluster with kubectl›

9. Keep it up to date​

Infrastructure → Updates shows the current and latest Infralib version.

Select Update... to start an update:

  • The infrastructure pipelines run one after another.
  • Follow them on the Pipelines tab. The update can take a few minutes to show up there.

Starting an update needs edit permission on the infrastructure. Only one update can run at a time.

Scheduled updates

The Update policy setting offers Manual and Scheduled, but scheduling updates from the Portal may not be available yet. If your schedule does not take effect, start updates with Update... as described above.

Next steps​

  • Guides for every resource as a Kubernetes manifest, to manage from Git.
  • Zone Management for permissions, node pools and network rules.
  • Core Concepts for how Organizations, Workspaces and Zones fit together.