Getting Started
Scoutflo simplifies infrastructure management with a user-friendly onboarding process.
Last updated
Scoutflo simplifies infrastructure management with a user-friendly onboarding process.
Last updated
Follow these steps to set up your organizational account, integrate necessary tools, and start deploying infrastructure and helm applications.
The first step to using Scoutflo is creating an account. The first individual to sign up will automatically become the Super Admin of the organizational account. Here’s how it works:
Sign Up: Visit deploy.scoutflo.com to sign up.
Super Admin Role: The person who signs up first will hold the Super Admin role for the organization.
Domain-Based Account Creation: An account is automatically created for the domain used in the email. This account serves as the central entity for all users under that domain.
I'll incorporate this additional point into the Account Creation section of the "Get Started" page as follows:
Account Creation Process with Domain Check
When a user first visits the Scoutflo platform and signs up using their official email ID, the following process ensures that only one account is created per organization:
Initial Account Creation:
When a user signs up with their email (e.g., john@xyz.com), Scoutflo performs a domain check (xyz.com) to see if an account already exists for this domain.
If no such account exists, the user is designated as the Super Admin, and a unique Account ID is assigned to them. This starts the account creation process for their organization.
A default workspace is automatically created for the Super Admin, and they can immediately start using the platform, setting up their infrastructure, and inviting other team members.
Handling Subsequent Users from the Same Domain:
If another user attempts to sign up using an email with the same domain (xyz.com), Scoutflo will identify that an account for this domain already exists.
Instead of creating a new account, the user is redirected to a "Request Access" screen.
The screen informs them that an account with their domain already exists and prompts them to send a request to join the existing account.
Requesting Access:
The user can hit the “Request” button, which sends an access request to the Super Admin of the existing account.
Until the Super Admin responds, the requesting user cannot access the Scoutflo platform.
Super Admin's Role in Approving Requests:
The Super Admin receives the access request and can either accept or decline it.
If declined, the user receives an email notification indicating that their request to join the account was denied, and they may attempt to request access again.
If accepted, a Profile is created for the user within the existing account, linking them to the organization's Account ID.
The Super Admin assigns them to a specific workspace and grants them the role of a "User" (the default lowest role). This role can be adjusted later by the 'Workspace Owner or Super Admin' as needed.
This process ensures that each organization has only one account within Scoutflo and maintains centralized access control, allowing the Super Admin to manage all team members efficiently.
Once you've signed up, you’ll be directed to the Onboarding Screens. These screens collect essential details about your company and the specific use case for Scoutflo. This information allows Scoutflo to personalize your experience based on your unique requirements.
Onboarding Process: Complete all required fields regarding your company.
Use Case Information: Provide details about how you intend to use Scoutflo, helping the platform tailor its services to your needs.
After the 'Onboarding' screens, you will be redirected to this 'Connect You Git' screen where you can connect your organization's github account or skip this step, for now, to go inside the platform.
After onboarding, you'll be redirected to the Get Started page. Here, you’ll go through 4 essential steps to fully set up the platform for your organization.
Scoutflo uses GitOps to store and manage configurations for your Kubernetes infrastructure.
Install GitHub Auth App: You will be prompted to install the GitHub authorization app.
Generate Access Token: Generate a User Access Token to allow Scoutflo to interact with your GitHub repositories securely.
Connect Your Container Registry:
Scoutflo integrates with container registries (e.g., AWS ECR) to ensure seamless deployments.
Connect your AWS ECR (Elastic Container Registry) to start storing and managing container images for your Kubernetes clusters.
Set Up Your Cloud Infrastructure:
Choose your preferred cloud provider (AWS, Azure, and GCP (Coming Soon)) and configure your Kubernetes infrastructure. We will guide you through setting up your cluster.
In Scoutflo Deploy, users have two flexible options when setting up clusters:
Creating a New Cluster:
Navigate to the 'Add Cluster' section and select 'Create Cluster'.
You can either choose from standard configurations optimized for various workloads or customize the setup based on your needs (e.g., node size, instance type, AWS region).
For custom configurations, you define instance types, number of nodes, and cluster parameters. Scoutflo Deploy provides a real-time estimated cost via Kubecost to help you make informed decisions.
Upon creation, Scoutflo automatically adds monitoring tools like Kubecost and Grafana to optimize visibility and cost-efficiency.
Connecting an Existing Cluster:
You can connect an existing Amazon EKS cluster by providing your AWS Access Key, Secret Key, and Cluster Name.
Scoutflo will integrate your existing resources and provide observability tools like Kubecost and Grafana for management.
Choosing between the two options depends on factors like setup speed, control, and infrastructure management. Creating a cluster in Scoutflo ensures optimal compatibility, while connecting an existing cluster is quicker if the infrastructure is already set up.
For deploying an application on your connected or newly created cluster, follow these simplified steps:
Select an App: Choose from available applications (e.g., web services, microservices, databases).
Choose a Cluster: Select the target Kubernetes cluster for deployment.
Database Setup (if required): If the app needs a database, either connect to an existing one or create a new database instance.
Configure Advanced Settings: Set options like autoscaling, high availability, and environment variables specific to your application.
Deploy: Once the configurations are set, initiate deployment, and monitor the progress via logs. Post-deployment, you’ll receive access credentials and other important information for managing the application.
Workspaces in Scoutflo allow you to organize and isolate your projects based on your needs. Once your integrations are set, you can start creating workspaces:
Default Workspace: A 'Default' workspace is automatically created for the Super Admin. You can immediately start creating and managing clusters and applications here.
Custom Workspaces: If needed, create additional workspaces tailored to specific use cases or environments (e.g., development, staging, production). This gives you better control over your resources.
Click on the top right CTA button for "Creating a New Custom Workspace".
Scoutflo enables collaboration by allowing you to invite other team members to join your workspace:
Invite Members: After finalizing your workspace setup, you can invite colleagues or team members to the platform.
Collaborate: Your team can now collaborate on cluster management, application deployment, and more within the same workspace.
You can see a section inside your workspace where all the members and invitees are listed.
Click on the top right CTA button "Invite" to invite your team members to Scoutflo.
You can fill in the details of the user you want to invite (Email and select a role to be assigned).
If the information you filled in is valid then you will see this confirmation that "Invitation Successful".
This simple, step-by-step onboarding ensures you can start using Scoutflo efficiently while customizing your setup based on your specific needs.
