Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: refactor hybrid cloud docs with renamed gateway #221

Merged
merged 3 commits into from
May 30, 2024
Merged

chore: refactor hybrid cloud docs with renamed gateway #221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
43d13e2
chore: refactor hybrid cloud docs with renamed gateway
markphelps May 30, 2024
3c71e3e
chore: words
markphelps May 30, 2024
e72a25a
Update cloud/guides/getting-started.mdx
markphelps May 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions cloud/guides/getting-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@

</Step>
<Step title="Connect Your Local Instance">
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
Expand All @@ -55,26 +55,28 @@

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.

</Step>
<Step title="Login to Hybrid Cloud">
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.

![Cloud Login](/images/cloud/guides/getting-started/login.png)

</Step>
<Step title="View Your Instance">
<Step title="View Your Gateway">

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.

Check warning on line 69 in cloud/guides/getting-started.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.FutureTense] Possible future tense.

Raw Output:
{"message": "[Openly.FutureTense] Possible future tense.", "location": {"path": "cloud/guides/getting-started.mdx", "range": {"start": {"line": 69, "column": 29}}}, "severity": "WARNING"}

Check warning on line 69 in cloud/guides/getting-started.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.A11Y] Consider using ''select'' instead of 'Click'

Raw Output:
{"message": "[Openly.A11Y] Consider using ''select'' instead of 'Click'", "location": {"path": "cloud/guides/getting-started.mdx", "range": {"start": {"line": 69, "column": 72}}}, "severity": "WARNING"}

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.

Check warning on line 71 in cloud/guides/getting-started.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.A11Y] Consider using ''select'' instead of 'Click'

Raw Output:
{"message": "[Openly.A11Y] Consider using ''select'' instead of 'Click'", "location": {"path": "cloud/guides/getting-started.mdx", "range": {"start": {"line": 71, "column": 54}}}, "severity": "WARNING"}

![Cloud Dashboard](/images/cloud/guides/getting-started/dashboard.png)

</Step>
<Step title="Route to Your Instance">
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`.

Check warning on line 77 in cloud/guides/getting-started.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.A11Y] Consider using ''select'' instead of 'Click'

Raw Output:
{"message": "[Openly.A11Y] Consider using ''select'' instead of 'Click'", "location": {"path": "cloud/guides/getting-started.mdx", "range": {"start": {"line": 77, "column": 3}}}, "severity": "WARNING"}

This will open your local Flipt instance in your browser.
This will route to your local Flipt instance via your browser.

Check warning on line 79 in cloud/guides/getting-started.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.FutureTense] Possible future tense.

Raw Output:
{"message": "[Openly.FutureTense] Possible future tense.", "location": {"path": "cloud/guides/getting-started.mdx", "range": {"start": {"line": 79, "column": 6}}}, "severity": "WARNING"}

![Flipt](/images/cloud/guides/getting-started/flipt.png)

Expand All @@ -83,7 +85,7 @@

## 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! 🎉

Check warning on line 88 in cloud/guides/getting-started.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.We] Try to avoid using first-person plural like 'our'.

Raw Output:
{"message": "[Microsoft.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "cloud/guides/getting-started.mdx", "range": {"start": {"line": 88, "column": 85}}}, "severity": "WARNING"}

<Check>
Note that you didn't have to mess with DNS or firewall settings to enable the
Expand All @@ -110,4 +112,6 @@

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).

Check warning on line 115 in cloud/guides/getting-started.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.SentenceLength] Write short sentences (less than 25 words).

Raw Output:
{"message": "[Openly.SentenceLength] Write short sentences (less than 25 words).", "location": {"path": "cloud/guides/getting-started.mdx", "range": {"start": {"line": 115, "column": 1}}}, "severity": "WARNING"}

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).
58 changes: 29 additions & 29 deletions cloud/guides/production.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,61 +29,61 @@
installed on your local machine.
</Note>

## Create a New Instance
## Create a New Gateway

Check warning on line 32 in cloud/guides/production.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.Titles] 'Create a New Gateway' should be in sentence case

Raw Output:
{"message": "[Openly.Titles] 'Create a New Gateway' should be in sentence case", "location": {"path": "cloud/guides/production.mdx", "range": {"start": {"line": 32, "column": 4}}}, "severity": "WARNING"}

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.

Check warning on line 34 in cloud/guides/production.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.FutureTense] Possible future tense.

Raw Output:
{"message": "[Openly.FutureTense] Possible future tense.", "location": {"path": "cloud/guides/production.mdx", "range": {"start": {"line": 34, "column": 119}}}, "severity": "WARNING"}

<Steps>
<Step title="Login to Hybrid Cloud">
First, log in to the Flipt Hybrid Cloud web interface. You can access the login page at [https://flipt.cloud](https://flipt.cloud).

</Step>
<Step title="Create a New Instance">
<Step title="Create a New Gateway">

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.

Check warning on line 43 in cloud/guides/production.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.FutureTense] Possible future tense.

Raw Output:
{"message": "[Openly.FutureTense] Possible future tense.", "location": {"path": "cloud/guides/production.mdx", "range": {"start": {"line": 43, "column": 29}}}, "severity": "WARNING"}

![Cloud Dashboard](/images/cloud/guides/production/dashboard.png)

</Step>
<Step title="Start the Wizard">

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)

</Step>
<Step title="Name Your Instance">
<Step title="Name Your Gateway">

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)

</Step>
<Step title="View Instance">
<Step title="View Gateway">

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)

</Step>
<Step title="Create an Instance API Key">
<Step title="Create a Gateway API Key">

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.

<Warning>
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.

Expand All @@ -94,7 +94,7 @@

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)

Expand Down Expand Up @@ -133,28 +133,28 @@

</Step>

<Step title="Refresh Instance Details">
<Step title="Refresh Gateway Details">

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)

</Step>

<Step title="Route to Your Instance">

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.

<Info>
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.
<Info>
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.
</Info>
</Step>
</Steps>
Expand Down
Binary file modified images/cloud/guides/getting-started/dashboard.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/cloud/guides/production/dashboard.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/cloud/guides/production/gateway-api-key.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/cloud/guides/production/gateway-connected.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/cloud/guides/production/gateway-details.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/cloud/guides/production/gateways.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/cloud/guides/production/instance-api-key.png
View file
Open in desktop
Binary file not shown.
Binary file removed images/cloud/guides/production/instance-details-connected.png
View file
Open in desktop
Binary file not shown.
Binary file removed images/cloud/guides/production/instance-details.png
View file
Open in desktop
Binary file not shown.
Binary file removed images/cloud/guides/production/instances.png
View file
Open in desktop
Binary file not shown.
Binary file modified images/cloud/guides/production/wizard-1.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/cloud/guides/production/wizard-2.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading