Quick Start Guide

Welcome to KtrlPlane! This guide will help you get started with the Control Plane for the Konnektr Platform in just a few minutes.

What is KtrlPlane?

KtrlPlane is the centralized management system for the Konnektr Platform. It provides:

• Organization Management: Create and manage teams and workspaces
• Project Management: Organize your applications and resources
• Resource Lifecycle: Deploy and manage Konnektr products (Graph, Flow, Assembler, Compass)
• Access Control: Role-based permissions for secure collaboration
• Billing: Integrated subscription and usage-based billing

Prerequisites

To use KtrlPlane, you need:

• A modern web browser (Chrome, Firefox, Safari, Edge)
• An internet connection
• An email address for account creation

Step 1: Create Your Account

1. Visit the KtrlPlane login page
2. Click "Sign Up" to create a new account
3. Enter your email address and create a secure password
4. Verify your email address by clicking the link sent to your inbox
5. Complete your profile setup

Step 2: Create Your First Organization

Organizations are the top-level containers in KtrlPlane. They represent your company, team, or personal workspace.

1. After logging in, you'll be prompted to create your first organization
2. Enter your organization name (e.g., "Acme Corp", "Personal Projects")
3. Add an optional description
4. Click "Create Organization"

Step 3: Create Your First Project

Projects are workspaces within your organization where you'll deploy and manage your resources.

1. From your organization dashboard, click "Create Project"
2. Enter a project name (e.g., "IoT Dashboard", "Customer Analytics")
3. Add a description explaining what this project is for
4. Click "Create Project"

Step 4: Deploy Your First Resource

Resources are the actual Konnektr products and services you'll use in your project.

1. Navigate to your project dashboard
2. Click "Add Resource"
3. Choose from available resource types:
   • Graph: High-performance graph database for digital twin data
   • Flow: Real-time data and event processing
   • Assembler: AI-powered digital twin builder
   • Compass: Navigation and discovery tools (coming soon)
4. Select a resource tier (Free, Pro, Enterprise)
5. Configure your resource settings
6. Click "Create Resource"

Step 5: Invite Team Members

If you're working with a team, you can invite collaborators to your organization or specific projects.

1. Go to your organization or project settings
2. Click "Access Control"
3. Click "Invite User"
4. Enter their email address
5. Select their role:
   • Viewer: Can view resources but not modify them
   • Editor: Can create and modify resources
   • Admin: Full access including billing and user management
   • Owner: Complete control (only one per organization/project)
6. Click "Send Invitation"

What's Next?

Now that you have KtrlPlane set up, you can:

• Create More Projects: Learn advanced project management
• Explore Resource Types: Understand what each Konnektr product offers
• Set Up Billing: Configure payment methods and subscriptions
• Manage Access Control: Fine-tune permissions for your team

Need Help?

If you run into any issues:

• Check our FAQ for common questions
• Visit our Troubleshooting Guide
• Reach out to our Community for help