compute

Compute Service

Overview

The compute service is essentially a cut down version of the Kubernetes service that provisions its own compute servers using hardware abstraction provided by the Region service.

Where possible, as the Compute service is very similar to the Kubernetes service, we must maintain type and API parity to ease creation of UX tools and services.

Installation

Prerequisites

To use the Compute service you first need to install:

• The identity service to provide API authentication and authorization.
• The region service to provide provider agnostic cloud services (e.g. images, flavors and identity management).

Installing the Service

Installing Prerequisites

The compute server component has a couple prerequisites that are required for correct functionality. If not installing the server component, skip to the next section.

You'll need to install:

• cert-manager (used to generate keying material for JWE/JWS and for ingress TLS)
• nginx-ingress (to perform routing, avoiding CORS, and TLS termination)

Installing the Compute Service

global:
  identity:
    host: https://identity.unikorn-cloud.org
  region:
    host: https://region.unikorn-cloud.org
  compute:
    host: https://compute.unikorn-cloud.org

helm install unikorn-compute charts/compute --namespace unikorn-compute --create-namespace --values values.yaml

apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
  name: unikorn-compute
  namespace: argocd
spec:
  project: default
  source:
    repoURL: https://unikorn-cloud.github.io/compute
    chart: compute
    targetRevision: v0.1.0
  destination:
    namespace: unikorn
    server: https://kubernetes.default.svc
  syncPolicy:
    automated:
      prune: true
      selfHeal: true
    syncOptions:
    - CreateNamespace=true

Configuring Service Authentication and Authorization

The Identity Service describes how to configure a service organization, groups and role mappings for services that require them.

This service requires asynchronous access to the Region API in order to poll cloud identity and physical network status during cluster creation, and delete those resources on cluster deletion.

This service defines the unikorn-compute user that will need to be added to a group in the service organization. It will need the built in role infra-manager-service that allows:

• Read access to the region endpoints to access external networks
• Read/delete access to the identites endpoints to poll and delete cloud identities
• Read/delete access to the physicalnetworks endpoints to poll and delete physical networks
• Create/Read/Delete access to the servers endpoints to manage compute instances

Testing

API Integration Tests

The compute service includes comprehensive API integration tests that validate instance operations, security, and authentication.

Test Configuration

Tests are configured via environment variables using a .env file in the test/ directory.

Setup:

1. Set up your environment configuration:

   Copy the example config and update with your values:

   cp test/.env.example test/.env
   

   Or create environment-specific files (not tracked in git):

   # Create .env.dev with your dev credentials
   cp test/.env.example test/.env.dev
   # Edit test/.env.dev with dev values
   
   # Create .env.uat with your UAT credentials
   cp test/.env.example test/.env.uat
   # Edit test/.env.uat with UAT values
   
   # Use the appropriate environment
   cp test/.env.dev test/.env    # For dev environment
   cp test/.env.uat test/.env    # For UAT environment
   

2. Configure the required values in test/.env:

   • API_BASE_URL - Compute API server URL
   • API_AUTH_TOKEN - Service token from console
   • TEST_ORG_ID, TEST_PROJECT_ID - Test organization and project IDs
   • TEST_REGION_ID - Test region ID
   • TEST_NETWORK_ID - Test network ID
   • TEST_FLAVOR_ID, TEST_IMAGE_ID - Test flavor and image IDs

Note: All test/.env and test/.env.* files are gitignored and contain sensitive credentials. They should never be committed to the repository. You can use either test/.env directly or create environment-specific files like test/.env.dev, test/.env.uat, etc.

Running Tests Locally (run from project root)

Run all tests:

make test-api

Run all tests in parallel (not yet implemeted):

make test-api-parallel

Run specific test suite using focus:

# Example: run only instance operations tests
make test-api-focus FOCUS="Instance Operations"

Run specific test spec using focus:

# Example: run only a specific test spec by name
make test-api-focus FOCUS="should successfully stop a running instance"

Advanced Ginkgo options:

# Run with different parallel workers
cd test/api/suites && ginkgo run --procs=8 --json-report=test-results.json

# Run with verbose output
cd test/api/suites && ginkgo run -v --show-node-events

# Skip specific tests
cd test/api/suites && ginkgo run --skip="Security and Authentication"

# Randomize test order
cd test/api/suites && ginkgo run --randomize-all

GitHub Actions Workflow

The API tests can be triggered manually via GitHub Actions using workflow_dispatch:

Workflow Inputs:

Available Test Suite Options:

• All - Run all test suites
• Instance Operations - Instance lifecycle and power operation tests
• Security and Authentication - Authentication and input validation tests

Triggering Manually:

1. Navigate to Actions tab in GitHub
2. Select API Tests workflow
3. Click Run workflow
4. Select which environments to test:
   • Run Dev tests (checked by default)
   • Run UAT tests (unchecked by default)
5. Choose test suite from the focus dropdown
6. Click Run workflow

Test Artifacts:

After each run, test results are uploaded as artifacts per environment:

• api-test-results-dev / api-test-results-uat - JSON format test results
• api-test-junit-dev / api-test-junit-uat - JUnit XML format for CI integration

Cleaning Up Test Artifacts locally.

make test-api-clean

Contract Testing

The compute service uses consumer-driven contract testing to validate interactions with dependent services (e.g., uni-region, uni-identity) without requiring full service deployments.

Prerequisites

Install Pact FFI Library:

Consumer contract tests require the Pact FFI library to be installed locally.

macOS:

brew tap pact-foundation/pact-ruby-standalone
brew install pact-ruby-standalone
mkdir -p $HOME/Library/pact
cp /usr/local/opt/pact-ruby-standalone/libexec/lib/*.dylib $HOME/Library/pact/

Start Pact Broker:

The Pact Broker is required for publishing and managing contracts. Reference the uni-core repository's make target for starting a local broker instance, or run:

docker run -d --name pact-broker \
  -p 9292:9292 \
  -e PACT_BROKER_DATABASE_URL=sqlite:///pact_broker.sqlite \
  pactfoundation/pact-broker:latest

Running Consumer Contract Tests

Run all consumer tests:

make test-contracts-consumer

Publish pacts to broker:

make publish-pacts

Available make targets:

• test-contracts-consumer - Run consumer contract tests
• publish-pacts - Publish generated pacts to Pact Broker
• can-i-deploy - Check if service version is safe to deploy
• record-deployment - Record deployment to an environment
• clean-contracts - Clean generated pact files

Configuration:

Broker settings can be configured via environment variables or Makefile defaults:

• PACT_BROKER_URL - Broker base URL (default: http://localhost:9292)
• PACT_BROKER_USERNAME - Broker username (default: pact)
• PACT_BROKER_PASSWORD - Broker password (default: pact)

Writing Consumer Tests

Consumer tests follow a standard pattern:

1. Create a Pact mock provider using contract.NewV4Pact()
2. Define interactions with Given(), UponReceiving(), WithRequest(), WillRespondWith()
3. Execute the test using your actual client code against the mock server
4. Verify expectations using Gomega matchers (you can and should use the OpenAPI spec as a guide here for building tests)

Example structure:

var _ = Describe("Provider Service Contract", func() {
    var pact *consumer.V4HTTPMockProvider

    BeforeEach(func() {
        pact, _ = contract.NewV4Pact(contract.PactConfig{
            Consumer: "uni-compute",
            Provider: "uni-region",
            PactDir:  "../pacts",
        })
    })

    It("returns expected response", func() {
        pact.AddInteraction().
            GivenWithParameter(...).
            UponReceiving("a request").
            WithRequest("GET", "/api/v1/endpoint").
            WillRespondWith(200, func(b *consumer.V4ResponseBuilder) {
                b.JSONBody(...)
            })

        test := func(config consumer.MockServerConfig) error {
            // Use actual client code here
            return nil
        }

        Expect(pact.ExecuteTest(testingT, test)).To(Succeed())
    })
})

For complete examples, see:

• test/contracts/consumer/region/regions_test.go - Region service consumer tests
• test/contracts/consumer/identity/identity_test.go - Identity service consumer tests

Consumer Contracts with uni-identity

The compute service defines consumer contracts for interactions with the identity service resource allocation API:

• Create allocation - Track resource usage when clusters/instances are created
• Update allocation - Update resource counts when scaling operations occur
• Delete allocation - Release resource allocations during cleanup

Emergency Escape Hatch

In exceptional circumstances (e.g. a hotfix that can't wait for contract tests to be updated), contract testing can be bypassed by adding the skip-contract-tests label to a PR.

When this label is present, both the ConsumerContractTests and CanIDeploy CI jobs are skipped. Skipped jobs show as neutral (green) in GitHub and satisfy required status checks, so the PR can still be merged.

This label should only be used as a last resort. Its use is visible in the PR timeline and auditable. After merging, the contract tests must be updated and the label removed before the next PR.