gitpod-io / gitpod-io/gitpod

[tests] tailscale integration test

Open
#13,927 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

aspect: testing feature: tailscale meta: never-stale
Dominant language
TypeScript
Stars
13.8k
Forks
1.4k
Avg merge
17h 58m
Merged PRs (30d)
5

Description

Is your feature request related to a problem? Please describe

We lack integration tests that tell us about the health of our support for the tailscale feature.

Describe the behaviour you'd like

Our integration tests should assert that the tailscale integration, including support for DNS, is working as expected.

Describe alternatives you've considered

Continue doing manual testing.

Additional context

https://github.com/gitpod-io/workspace-images/pull/956
https://github.com/gitpod-io/website/pull/2908
https://github.com/gitpod-io/gitpod/issues/13785

Adding secrets to support this test.

  1. Add the secret to GCP (manually) in gitpod-core-dev project
  2. Copy the secret from GCP to core-dev with TF (docs)
  3. Copy the secret from core-dev to the preview environment as part of the deploy (example)

The secret you'll be storing is a tailscale key (authkey). It should be reusable (so it can support many preview VMs) and ephemeral (so when machines go offline from the tailscale network, that they are removed).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked workspace-images, website, and gitpod issues, then inspect dev/preview/workflow/preview/deploy-gitpod.sh and the referenced secret-deployment steps. Identify the existing integration-test entry point and determine how preview environments receive the Tailscale key. Done means integration tests cover Tailscale support, including DNS, with the required reusable and ephemeral secret configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
gcp, terraform
Domain
cloud, infrastructure, testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.