diff --git a/cloud/guides/getting-started.mdx b/cloud/guides/getting-started.mdx index e604218..fe39408 100644 --- a/cloud/guides/getting-started.mdx +++ b/cloud/guides/getting-started.mdx @@ -45,7 +45,7 @@ To quickly get started with Flipt Hybrid Cloud, follow these steps: - Connect your local Flipt instance to your Flipt Hybrid Cloud account using the following command: + Connect your local Flipt instance to Flipt Hybrid Cloud using the following command: ```bash flipt cloud serve @@ -55,6 +55,8 @@ To quickly get started with Flipt Hybrid Cloud, follow these steps: After following the prompts in the CLI, you should see a success message indicating that your local instance is connected to Flipt Hybrid Cloud along with a unique address for your local instance. + Behind the scenes, Flipt Hybrid Cloud will create a secure tunnel to your local instance via what we call a gateway, allowing you to access it from anywhere in the world. + Next, log in to the Flipt Hybrid Cloud web interface using the unique address provided in the previous step. You can access the web interface by navigating to the provided address in your browser. @@ -62,19 +64,19 @@ To quickly get started with Flipt Hybrid Cloud, follow these steps: ![Cloud Login](/images/cloud/guides/getting-started/login.png) - + -Once you are logged in, you will see the Flipt Hybrid Cloud dashboard. Click on the "Dashboard" tab in the sidebar to view your connected instances. +Once you are logged in, you will see the Flipt Hybrid Cloud dashboard. Click on the "Dashboard" tab in the sidebar to view your gateways. -You should see your local instance listed here. Click on the instance to view more details and manage your instance settings. +You should see your new gateway address listed here. Click on the gateway name to view more details and manage it's settings. ![Cloud Dashboard](/images/cloud/guides/getting-started/dashboard.png) - Click on the your instance address to route to your local instance. The address will look something like `https://{instance}-{organization}.flipt.cloud`. + Click on the gateway address to route to your local instance. The address will look something like `https://{gateway}-{organization}.flipt.cloud`. -This will open your local Flipt instance in your browser. +This will route to your local Flipt instance via your browser. ![Flipt](/images/cloud/guides/getting-started/flipt.png) @@ -83,7 +85,7 @@ This will open your local Flipt instance in your browser. ## What Just Happened? -You have successfully connected your local Flipt instance to Flipt Hybrid Cloud! 🎉 +You have successfully connected your local Flipt instance to Flipt Hybrid Cloud via our secure gateway! 🎉 Note that you didn't have to mess with DNS or firewall settings to enable the @@ -110,4 +112,6 @@ The unique address provided in the CLI is a temporary route to your local instan Now that you have successfully connected your local Flipt instance to Flipt Hybrid Cloud, you can start creating feature flags and managing your feature flag configurations. -After you've had a chance to play around with Flipt Hybrid Cloud and your local instance, you can learn more about the advanced features and capabilities available to you in the [Flipt Hybrid Cloud documentation](/cloud/overview) and how to take your configuration to production. +After you've had a chance to play around with Flipt Hybrid Cloud and your local instance, you can learn more about the advanced features and capabilities available to you in the [Flipt Hybrid Cloud documentation](/cloud/overview). + +Finally, consider connecting your production instance to Flipt Hybrid Cloud to manage your feature flags and configurations in your production environment. You can learn more about how to do this in the [Production Guide](/cloud/guides/production). diff --git a/cloud/guides/production.mdx b/cloud/guides/production.mdx index 24d30e7..d4d1bcf 100644 --- a/cloud/guides/production.mdx +++ b/cloud/guides/production.mdx @@ -29,61 +29,61 @@ experimental: installed on your local machine. -## Create a New Instance +## Create a New Gateway -To move your local Flipt instance to production, you need to create a new instance in Flipt Hybrid Cloud. This instance will be used to manage your feature flags and configurations in a production environment. +To move your local Flipt instance to production, you need to create a new gateway in Flipt Hybrid Cloud. This gateway will be used to manage your feature flags and configurations in a production environment. First, log in to the Flipt Hybrid Cloud web interface. You can access the login page at [https://flipt.cloud](https://flipt.cloud). - + -Once you are logged in, you will see the Flipt Hybrid Cloud dashboard. Click on the `Create Your First Instance` button to create a new instance. +Once you are logged in, you will see the Flipt Hybrid Cloud dashboard. Click on the `Create Your First Gateway` button to create a new gateway. ![Cloud Dashboard](/images/cloud/guides/production/dashboard.png) -You will be taken to the instance creation wizard. Follow the prompts to create a new instance. +You will be taken to the gateway creation wizard. Follow the prompts to create a new gateway. -![Instance Wizard](/images/cloud/guides/production/wizard-1.png) +![Gateway Wizard](/images/cloud/guides/production/wizard-1.png) - + -Give your instance a name and description to help you identify it later. Click `Next` to continue. +Give your gateway a name and description to help you identify it later. Click `Next` to continue. -![Instance Wizard](/images/cloud/guides/production/wizard-2.png) +![Gateway Wizard](/images/cloud/guides/production/wizard-2.png) - + -After you've created your instance, go back to the Dashboard and you should see your instance in the list. +After you've created your gateway, go back to the Dashboard and you should it in the list. -![Instances Dashboard](/images/cloud/guides/production/instances.png) +![Gateway Dashboard](/images/cloud/guides/production/gateways.png) -Next, click on the instance to view more details. +Next, click on the gateway name to view more details. -Here you can view your instance settings and manage your instance. +Here you can view it's settings and manage your gateway. -![Instance Details](/images/cloud/guides/production/instance-details.png) +![Gateway Details](/images/cloud/guides/production/gateway-details.png) - + -In order authenticate your running Flipt instance with the Flipt Hybrid Cloud, you will need to create an API token for your instance. +In order authenticate your running Flipt instance with your new gateway in Flipt Hybrid Cloud, you'll need to create a gateway API token. -Click on the `Configuration` tab in the instance details page and then click on the `Instance API Key` button. +Click on the `Configuration` tab in the gateway details page and then click on the `Gateway API Key` button. -![Instance API Key](/images/cloud/guides/production/instance-api-key.png) +![Gateway API Key](/images/cloud/guides/production/gateway-api-key.png) Copy the API key and save it for later. - The API key is a secret token that allows your Flipt instance to authenticate with the Flipt Hybrid Cloud. Keep it secure and do not share it with anyone. + The API key is a secret token that allows your Flipt instances to authenticate with your gateway in Flipt Hybrid Cloud. Keep it secure and do not share it with anyone. If you lose your API key, you can always generate a new one by following the same steps. @@ -94,7 +94,7 @@ If you lose your API key, you can always generate a new one by following the sam Next, click on the `Download Configuration` button to download the configuration file for your instance. -This configuration file contains the required settings for your instance to connect to the Flipt Hybrid Cloud. +This configuration file contains the required settings for your instance to connect to your gateway in Flipt Hybrid Cloud. Move the configuration file to your local [Flipt instance directory](/configuration/overview#configuration-file) @@ -133,28 +133,28 @@ flipt -f /path/to/your/configuration.yaml - + -After you've started your Flipt instance, go back to the Flipt Hybrid Cloud dashboard and refresh the instance details page. +After you've started your Flipt instance, go back to the Flipt Hybrid Cloud dashboard and refresh the page. -You should see that your instance is now connected and showing one active connection. +You should see that your gateway is now connected and showing one active connection. -![Instance Details](/images/cloud/guides/production/instance-details-connected.png) +![Gateway Details](/images/cloud/guides/production/gateway-connected.png) -Click on the your instance address to route to your instance. The address will look something like `https://{instance}-{organization}.flipt.cloud`. +Click on the your gateway address to route to your instance. The address will look something like `https://{gateway}-{organization}.flipt.cloud`. -This will open your local Flipt instance in your browser. +This will route to your local Flipt instance in your browser. ![Flipt](/images/cloud/guides/production/flipt.png) You are automatically authenticated with your Flipt Hybrid Cloud account and can start managing your feature flags and configurations in your production environment. - - The address provided in the Flipt Hybrid Cloud dashboard is a permanent route to your instance. You can access your instance through this address at any time. + + The address provided in the Flipt Hybrid Cloud dashboard is a permanent route to your instance. You can access your instance through this address at any time. diff --git a/images/cloud/guides/getting-started/dashboard.png b/images/cloud/guides/getting-started/dashboard.png index 4d44313..0ef1ab5 100644 Binary files a/images/cloud/guides/getting-started/dashboard.png and b/images/cloud/guides/getting-started/dashboard.png differ diff --git a/images/cloud/guides/production/dashboard.png b/images/cloud/guides/production/dashboard.png index ec9fc40..6af02d5 100644 Binary files a/images/cloud/guides/production/dashboard.png and b/images/cloud/guides/production/dashboard.png differ diff --git a/images/cloud/guides/production/gateway-api-key.png b/images/cloud/guides/production/gateway-api-key.png new file mode 100644 index 0000000..10a0ba1 Binary files /dev/null and b/images/cloud/guides/production/gateway-api-key.png differ diff --git a/images/cloud/guides/production/gateway-connected.png b/images/cloud/guides/production/gateway-connected.png new file mode 100644 index 0000000..b78d78e Binary files /dev/null and b/images/cloud/guides/production/gateway-connected.png differ diff --git a/images/cloud/guides/production/gateway-details.png b/images/cloud/guides/production/gateway-details.png new file mode 100644 index 0000000..62f1def Binary files /dev/null and b/images/cloud/guides/production/gateway-details.png differ diff --git a/images/cloud/guides/production/gateways.png b/images/cloud/guides/production/gateways.png new file mode 100644 index 0000000..7f1be2f Binary files /dev/null and b/images/cloud/guides/production/gateways.png differ diff --git a/images/cloud/guides/production/instance-api-key.png b/images/cloud/guides/production/instance-api-key.png deleted file mode 100644 index 5582c4e..0000000 Binary files a/images/cloud/guides/production/instance-api-key.png and /dev/null differ diff --git a/images/cloud/guides/production/instance-details-connected.png b/images/cloud/guides/production/instance-details-connected.png deleted file mode 100644 index 9ed6671..0000000 Binary files a/images/cloud/guides/production/instance-details-connected.png and /dev/null differ diff --git a/images/cloud/guides/production/instance-details.png b/images/cloud/guides/production/instance-details.png deleted file mode 100644 index feb347d..0000000 Binary files a/images/cloud/guides/production/instance-details.png and /dev/null differ diff --git a/images/cloud/guides/production/instances.png b/images/cloud/guides/production/instances.png deleted file mode 100644 index e19d8c5..0000000 Binary files a/images/cloud/guides/production/instances.png and /dev/null differ diff --git a/images/cloud/guides/production/wizard-1.png b/images/cloud/guides/production/wizard-1.png index 997225b..e896243 100644 Binary files a/images/cloud/guides/production/wizard-1.png and b/images/cloud/guides/production/wizard-1.png differ diff --git a/images/cloud/guides/production/wizard-2.png b/images/cloud/guides/production/wizard-2.png index ef1535e..4cba0be 100644 Binary files a/images/cloud/guides/production/wizard-2.png and b/images/cloud/guides/production/wizard-2.png differ