MTX Tool

Multitenancy and Extensibility Tool is a cli to reduce operational overhead for multitenant Cloud Foundry applications, particularly in the areas user authentication, tenant registration, CAP multitenancy, and HANA container management.

Content

Area	Purpose	Related
Tool Setup	initial, project, or ad-hoc setup
User Authentication	obtain and decode access tokens	service: xsuaa
Tenant Registry	list subscribed subaccounts and service dependencies	service: saas-registry
CAP Multitenancy	list, onboard, offboard, and upgrade tenants	library: @sap/cds-mtx
HANA Management	list and access hdi container	service: service-manager
Service Manager	list, refresh, and delete managed service instances and bindings	service: service-manager

Getting Started

Prerequisite is an installed CF cli v8 or newer.

Prepare

npm install --global @cap-js-community/mtx-tool
mtx --setup

Use, for example

cf target -o <my-org> -s <my-space>
mtx regl
mtx hdil

Pipelines

For pipelines, we recommend committing the setup configuration to your project and running MTX Tool on the pipeline runner in the corresponding directory through npx with a stable version:

In project

mtx --setup-local
git add . && git commit -m "mtx-tool config"

In pipeline, for example

npx @cap-js-community/mtx-tool@0.10.1 --svm-repair-bindings all-services
npx @cap-js-community/mtx-tool@0.10.1 --svm-refresh-bindings all-services all-tenants
...
npx @cap-js-community/mtx-tool@0.10.1 --cds-upgrade-all