Example MSP

Development Preview

The local setup is currently under active development. Features and workflows may change.

1. Clone the Repository

git clone https://github.com/platform-mesh/helm-charts.git
cd helm-charts/local-setup

2. Run the Setup

The setup script automates the entire bootstrap process. Choose one of the following options:

Standard Setup

Task

# Full setup (deletes existing cluster and creates new one)
task local-setup:example-data

# Iterate on existing cluster (faster, preserves cluster state)
task local-setup:example-data:iterate

Script

# Full setup (deletes existing cluster and creates new one)
kind delete cluster --name platform-mesh
./scripts/start.sh

After the script completes, it will display Installation Complete ♥ ! along with instructions for accessing the portal.

---

Registering a User

Once the setup completes, access the portal via the link displayed in the terminal.

For first-time access, you must register a new user. Click the Register link to begin.

After registration, email verification is required.

Verify your email through the Mailpit instance. The terminal output from the setup task includes the Mailpit URL.

After verification, follow the redirect links to the login page. Sign in with your newly created credentials to access the organisation page.

---

Onboarding an Organisation

After logging in, you can onboard your first organisation.

Once onboarding is complete, you will receive an email in Mailpit containing a link to set your account credentials.

After completing this step, log in to access the Platform Mesh Portal UI.

---

Account and Namespace

Navigate to the Accounts page to create a new account.

Create a new account within Platform Mesh.

After the account is created, you can step into it. There are two methods of access:

1. Portal UI: Navigate through the Platform Mesh Portal interface
2. Kubeconfig: Download the Kubeconfig file to interact with the account via kubectl

Note that each account operates as its own control plane.

A default namespace is automatically created for you within the account. This namespace corresponds to a Kubernetes Namespace in the Control Plane.

---

Marketplace

The Marketplace displays available services that have been provisioned and are ready for binding and consumption within your account.

---

Managed Service Provider: HttpBin

Within the namespace, you can view and provision services from the Marketplace. The HttpBin service demonstrates managed service provider capabilities.

Create and provision your first service through Platform Mesh.

After provisioning completes, the HttpBin service becomes available in your account.

Access the service via the provided link.

Host Configuration Required

Add the following entry to your /etc/hosts file:

127.0.0.1 httpbin.services.portal.dev.local

For detailed host configuration, refer to the Quick Start guide.

You can also access the HttpBin service running within the local cluster. Note that this is for demonstration purposes only. In production environments, Managed Service Providers operate outside the Platform Mesh scope and are hosted externally. This example illustrates the integration capabilities of Platform Mesh.

---

Related Concepts

• Account Model - How identity and access work in Platform Mesh
• Control Planes - Architecture of distributed control plane management
• Design Decisions - Managed Service Provider patterns
• Scenarios - Real-world service interaction examples