How to Get Started

Scoutflo Deploy User Flows.

Step 1: Connect Your Git Repository (Seamless GitOps Integration):

  • Streamlined Workflow: Integrate your Git repository with a single click. This enables seamless version control of your infrastructure as code (IaC) and application configurations. IaC refers to managing your infrastructure using code, allowing for automation and repeatability. Manage your deployments through GitOps practices, which leverage Git for version control and deployment workflows.

  • Enhanced Collaboration: Maintain a central repository for your code and infrastructure, facilitating collaboration and ensuring all changes are tracked effectively.

  • You get two options to connect your git account:-

    • GitHub.

    • Gitlab (Coming Soon).

  • We have made an integration to connect your git seamlessly with just one click. Leverage Git for infrastructure as code (IaC) and application configuration management. Deploy and manage changes through GitOps practices.

  • A secure window appears for you to authorize your Git repository connection with Scoutflo Deploy.

  • Once authorized, all your Git commits manage both infrastructure and application deployments, ensuring version control and traceability.

Step 2: Connect Your Container Registry:

  • You get two options to connect your Container registry:-

    • Add your existing Container registry.

    • Create a new Container registry.

  • Currently, Scoutflo Deploy integrates with Amazon ECR. Connect your ECR repository to store and manage Docker container images for your applications.

Connection Details: The specific fields you'll need to fill in will depend on whether you're connecting an existing registry or creating a new one:

These are the fields to be filled before adding a Registry:

  • Registry Type

    • Private Registry

    • Public Registry

  • Registry Name

  • Registry URL (if Private)

  • Username

  • Password/Token (using a token is recommended for enhanced security)

These are the fields to be filled before creating a Registry:

  • Registry Type

    • Private Registry

    • Public Registry

  • Registry Name

  • Username

  • Password/Token (using a token is recommended for enhanced security)

  1. Connect your cloud provider service:

  • Scoutflo Deploy currently supports connecting your AWS account to manage your cloud resources for deployments. This ensures secure access for cluster creation and application deployments within the AWS environment. We understand the importance of choice, and we're actively working on adding support for other major cloud providers:

    • Microsoft Azure (Coming Soon): Expand your deployment flexibility by connecting your Azure account soon.

    • Google Cloud Platform (Coming Soon): Leverage Google Cloud Platform for your deployments with upcoming GCP integration.

  1. Cluster Management

4.1. Cluster Creation

  1. Upon selecting "Add Cluster," choose "Cluster Creation" to initiate the setup process.

  2. Enter details like cluster name, region, and desired instance types.

  3. Scoutflo Deploy offers pre-configured options for common cluster setups, allowing for quick and easy deployment.

  4. Activate a free trial to explore Scoutflo Deploy's functionalities by deploying your chosen open-source application on a dedicated test cluster. A confirmation email will be sent upon successful activation.

4.2. Connecting Your Existing Cluster

  1. Choose the "Connect Cluster" option in Add Cluster.

  2. Provide all the details for connecting a cluster.

  3. Click "Verify Credentials" to establish a connection between Scoutflo Deploy and your cluster.

4.3. Cluster Removal

  • Flow:

    1. Uninstall any applications currently running on the cluster before proceeding.

    2. Once all applications are removed, you can delete the cluster from Scoutflo Deploy's database.

Note: This refers to removing a user-added cluster, not deleting a system-managed cluster.

  • Provide a unique name for your cluster to identify it within the workspace.

  • Choose the desired region for your cluster deployment based on your application's needs.

  • Duplicate Cluster Name: Scoutflo Deploy will prevent the creation of clusters with identical names within the same workspace.

  • Region Mismatch: An error message will be displayed if the selected region is incompatible with the chosen cluster name.

5. Application Management

5.1. Prerequisites

  • An active workspace in Scoutflo Deploy.

  • A cluster in an active state within the chosen workspace.

5.2. Application Installation

  • Flow:

    1. Select the desired workspace for application deployment.

    2. Choose the appropriate cluster from the list of available clusters in active state.

    3. Specify the hosting zone for your application deployment.

Adding a New Hosting Zone:

  • A pop-up window allows you to define a new hosting zone name and provide the necessary authentication credentials.

  • The same hosting zone name can be used across different workspaces but cannot be duplicated within a single workspace.

  • Inactive Cluster: An error message will be displayed if you attempt to deploy an application on a cluster that is not in active state.

  • Duplicate Hosting Zone: Scoutflo Deploy will prevent the creation of duplicate hosting zones within the same workspace.

Special Conditions: Multiple instances of the same application can be deployed within a single cluster.

5.3. Application Removal

  • Flow:

    1. Scoutflo Deploy allows you to uninstall or remove applications from your clusters.

Last updated