director

README

Director

The Director exposes a GraphQL API for managing applications and runtimes.

• Development
  • Prerequisites
  • Configuration
• Local Development
  • Prerequisites
  • Run
• Usage

Development

After you introduce changes in the GraphQL schema, run the gqlgen.sh script.

To run Director with PostgreSQL container on local machine with latest DB schema, run the following command:

./run.sh

The GraphQL API playground is available at localhost:3000. To call the API, send the following headers:

{
  "tenant": "380da7fb-767e-45cf-8fcc-829f97655d1b",
  "authorization": "Bearer eyAiYWxnIjogIm5vbmUiLCAidHlwIjogIkpXVCIgfQo.eyAic2NvcGVzIjogIndlYmhvb2s6d3JpdGUgZm9ybWF0aW9uX3RlbXBsYXRlLndlYmhvb2tzOnJlYWQgcnVudGltZS53ZWJob29rczpyZWFkIGFwcGxpY2F0aW9uLmxvY2FsX3RlbmFudF9pZDp3cml0ZSB0ZW5hbnRfc3Vic2NyaXB0aW9uOndyaXRlIHRlbmFudDp3cml0ZSBmZXRjaC1yZXF1ZXN0LmF1dGg6cmVhZCB3ZWJob29rcy5hdXRoOnJlYWQgYXBwbGljYXRpb24uYXV0aHM6cmVhZCBhcHBsaWNhdGlvbi53ZWJob29rczpyZWFkIGFwcGxpY2F0aW9uLmFwcGxpY2F0aW9uX3RlbXBsYXRlOnJlYWQgYXBwbGljYXRpb25fdGVtcGxhdGU6d3JpdGUgYXBwbGljYXRpb25fdGVtcGxhdGU6cmVhZCBhcHBsaWNhdGlvbl90ZW1wbGF0ZS53ZWJob29rczpyZWFkIGRvY3VtZW50LmZldGNoX3JlcXVlc3Q6cmVhZCBldmVudF9zcGVjLmZldGNoX3JlcXVlc3Q6cmVhZCBhcGlfc3BlYy5mZXRjaF9yZXF1ZXN0OnJlYWQgcnVudGltZS5hdXRoczpyZWFkIGludGVncmF0aW9uX3N5c3RlbS5hdXRoczpyZWFkIGJ1bmRsZS5pbnN0YW5jZV9hdXRoczpyZWFkIGJ1bmRsZS5pbnN0YW5jZV9hdXRoczpyZWFkIGFwcGxpY2F0aW9uOnJlYWQgYXV0b21hdGljX3NjZW5hcmlvX2Fzc2lnbm1lbnQ6cmVhZCBoZWFsdGhfY2hlY2tzOnJlYWQgYXBwbGljYXRpb246d3JpdGUgcnVudGltZTp3cml0ZSBsYWJlbF9kZWZpbml0aW9uOndyaXRlIGxhYmVsX2RlZmluaXRpb246cmVhZCBydW50aW1lOnJlYWQgdGVuYW50OnJlYWQgZm9ybWF0aW9uOnJlYWQgZm9ybWF0aW9uOndyaXRlIGludGVybmFsX3Zpc2liaWxpdHk6cmVhZCBmb3JtYXRpb25fdGVtcGxhdGU6cmVhZCBmb3JtYXRpb25fdGVtcGxhdGU6d3JpdGUgZm9ybWF0aW9uX2NvbnN0cmFpbnQ6cmVhZCBmb3JtYXRpb25fY29uc3RyYWludDp3cml0ZSBjZXJ0aWZpY2F0ZV9zdWJqZWN0X21hcHBpbmc6cmVhZCBjZXJ0aWZpY2F0ZV9zdWJqZWN0X21hcHBpbmc6d3JpdGUgZm9ybWF0aW9uLnN0YXRlOndyaXRlIHRlbmFudF9hY2Nlc3M6d3JpdGUgYnVuZGxlX2luc3RhbmNlX2F1dGg6d3JpdGUiLCAidGVuYW50Ijoie1wiY29uc3VtZXJUZW5hbnRcIjpcIlwiLFwiZXh0ZXJuYWxUZW5hbnRcIjpcIjNlNjRlYmFlLTM4YjUtNDZhMC1iMWVkLTljY2VlMTUzYTBhZVwifSIgfQo."
}

where tenant is any valid UUID and authorization is JWT token with all scopes and tenant in payload. The token is not signed in development mode.

You can set tenant header as any UUID.

Prerequisites

NOTE: To perform the following steps automatically, you can use the run.sh script. For more information, see the section Local Development.

To run the Director, first you must configure access to PostgreSQL database. For development purposes, you can run the PostgreSQL instance in the docker container by running the following command:

$ docker run --rm -p 5432:5432 -e POSTGRES_PASSWORD=pgsql@12345 postgres

When you have the PostgreSQL instance running, you must import the database schema by running the following command:

$ PGPASSWORD=pgsql@12345 psql -U postgres -W -h 127.0.0.1 -f <(cat components/schema-migrator/migrations/director/*.up.sql)

Configuration

The Director binary allows you to override some configuration parameters. To get a list of the configurable parameters, see main.go.

The Director also depends on a configuration file that contains the required scopes for each GraphQL query and mutation. For local development you can use the file at hack/config-local.yaml. For in-cluster setup you can use the file that is located in the Director subchart at chart/compass/charts/director/config.yaml.

Local Development

Prerequisites

• Install kubectl version 1.18 or higher.
• To use --debug flag, first you must install delve.

Run

There is a ./run.sh script that automatically runs director locally with the necessary configuration and environment variables. There are several flags that can be used:

• --skip-db-cleanup - Does not delete the DB on script termination.
• --reuse-db - Can be used in combination with --skip-db-cleanup to reuse an already existing DB.
• --dump-db - Starts director with DB, populated with data from CMP development environment.
• --debug - Starts director in debugging mode on default port 40000.
• --async-enabled - Enables scheduling of asynchronous operations. To use this option, make sure that the Operations Controller component is running.

NOTE: Director component has certificate cache, which is populated with an external certificate through Kubernetes secret. Locally, you can override the secret data with certificate and key that you need for testing or debugging. Check the table below for environment variables.

Environment variable	Default value	Description
APP_EXTERNAL_CLIENT_CERT_VALUE	certValue	External client certificate, which is used to populate the certificate cache
APP_EXTERNAL_CLIENT_KEY_VALUE	keyValue	External client certificate key, which is added into certificate cache

Usage

You can find examples of GraphQL calls at: Examples.

Other Binaries

The Director's source code is also used by other Compass's components. For this reason, the code comprises different binaries, located in the cmd directory. To configure it and run it locally, you can see the following documentation sources:

• ORD Aggregator
• Tenant Fetcher (Deployment)
• Tenant Loader
• System Fetcher
• Scopes Synchronizer Job