@eclipse-che/devworkspace-client

DevWorkspace Client

The DevWorkspace Client is a library for interacting with DevWorkspaces and related objects on your cluster. It's node side library that wraps @kubernetes/client-node.

It's built and published on each commit from main branch into @eclipse-che/devworkspace-client

Examples

With custom kubeconfig

import 'reflect-metadata';
import { container, INVERSIFY_TYPES } from '@eclipse-che/devworkspace-client';
import * as k8s from '@kubernes/client-node'

const kubeConfig = new k8s.KubeConfig();
// todo init kubeConfig with the needed values

const dwClient = new DevWorkspaceClient(kubeConfig);
const dwApi = dwClient.devworkspaceApi;
const dwList = await dwApi.listInNamespace('my_namespace');
for (const dw of dwList.items) {
   // process all the DevWorkpsaces in namespace
}

Developer support

Getting Started

1. Install prerequisite tooling:
   • yarn
   • node
2. Install dependencies
   • Run yarn install
3. Build the project
   • Run yarn run build
4. To test the project
   • Run yarn test

Integration tests

Integration tests can be run locally by using export INTEGRATION_TESTS=true. Refer to the Environment variables section to learn more.

The devworkspace-controller must be on the cluster before running the integration tests.

Environment variables

• INTEGRATION_TESTS: When the INTEGRATION_TESTS environment variable is defined and it's value is true, the integration tests will run against current context from KUBECONFIG;
• KUBECONFIG: The KUBECONFIG which should be used for getting the current cluster config, like $HOME/.kube/config;

License

EPL-2