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: redo hc docs for environments; add concepts page #223

Merged
merged 3 commits into from
Jun 5, 2024
Merged

chore: redo hc docs for environments; add concepts page #223

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
4baf9f8
chore: redo hc docs for environments; add concepts page
markphelps Jun 4, 2024
391d01e
chore: minor api docs word changes
markphelps Jun 4, 2024
f8dd823
Update concepts.mdx
markphelps Jun 5, 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
37 changes: 37 additions & 0 deletions cloud/concepts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---

Check warning on line 1 in cloud/concepts.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.Readability] Grade level (11.72) too high!

Raw Output:
{"message": "[Openly.Readability] Grade level (11.72) too high!", "location": {"path": "cloud/concepts.mdx", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}
title: Concepts
description: This document describes the basic concepts of Flipt Hybrid Cloud.
---

Flipt Hybrid Cloud is our managed service offering that allows you to run Flipt on your infrastructure with the added benefits of a managed service. This document describes the basic concepts of Flipt Hybrid Cloud.

Check warning on line 6 in cloud/concepts.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/concepts.mdx", "range": {"start": {"line": 6, "column": 23}}}, "severity": "WARNING"}

## Hybrid Cloud

Check warning on line 8 in cloud/concepts.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.Titles] 'Hybrid Cloud' should be in sentence case

Raw Output:
{"message": "[Openly.Titles] 'Hybrid Cloud' should be in sentence case", "location": {"path": "cloud/concepts.mdx", "range": {"start": {"line": 8, "column": 4}}}, "severity": "WARNING"}

Why do we call it Hybrid Cloud? Because it's a blend of the best of both worlds: With Flipt Hybrid Cloud, you deploy open-source Flipt on your infrastructure or cloud provider of choice as you always have, and we provide you with effortless ingress, enterprise-grade authentication and authorization. Experience a seamless transition with enhanced features that fit perfectly into your existing setup.

Check warning on line 10 in cloud/concepts.mdx

View workflow job for this annotation

GitHub Actions / Vale 

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

Raw Output:
{"message": "[Microsoft.We] Try to avoid using first-person plural like 'we'.", "location": {"path": "cloud/concepts.mdx", "range": {"start": {"line": 10, "column": 8}}}, "severity": "WARNING"}

Check warning on line 10 in cloud/concepts.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/concepts.mdx", "range": {"start": {"line": 10, "column": 33}}}, "severity": "WARNING"}

Check warning on line 10 in cloud/concepts.mdx

View workflow job for this annotation

GitHub Actions / Vale 

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

Raw Output:
{"message": "[Microsoft.We] Try to avoid using first-person plural like 'we'.", "location": {"path": "cloud/concepts.mdx", "range": {"start": {"line": 10, "column": 211}}}, "severity": "WARNING"}

Check warning on line 10 in cloud/concepts.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.Adverbs] Remove 'perfectly' if it's not important to the meaning of the statement.

Raw Output:
{"message": "[Microsoft.Adverbs] Remove 'perfectly' if it's not important to the meaning of the statement.", "location": {"path": "cloud/concepts.mdx", "range": {"start": {"line": 10, "column": 367}}}, "severity": "WARNING"}

## Gateways

A gateway is a secure tunnel that allows Flipt Hybrid Cloud to connect to your local Flipt instance. When you run `flipt cloud serve`, Flipt Hybrid Cloud creates a secure tunnel to your local instance via a gateway, allowing you to access it from anywhere in the world.

Check warning on line 14 in cloud/concepts.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/concepts.mdx", "range": {"start": {"line": 14, "column": 102}}}, "severity": "WARNING"}

<Tip>
Our [Getting Started](/cloud/guides/getting-started) guide covers how to connect your local instance to Flipt Hybrid Cloud for testing purposes.

Check warning on line 17 in cloud/concepts.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/concepts.mdx", "range": {"start": {"line": 17, "column": 1}}}, "severity": "WARNING"}

Check warning on line 17 in cloud/concepts.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/concepts.mdx", "range": {"start": {"line": 17, "column": 1}}}, "severity": "WARNING"}

See our [Production Guide](/cloud/guides/production) for more information on how to connect your long-lived instances to Flipt Hybrid Cloud.
</Tip>

Check failure on line 20 in cloud/concepts.mdx

View workflow job for this annotation

GitHub Actions / lint 

Insert `⏎`

When connecting your long-lived instances to Flipt Hybrid Cloud, the same gateway technology is used to securely connect your instances to the Flipt Hybrid Cloud service. The only difference is that these gateway connections do not expire like those created by `flipt cloud serve`.

## Environments

An environment is a logical grouping of your Flipt instances. When you connect your Flipt instance to Flipt Hybrid Cloud, you are connecting it to a named environment. You can think of environments as a way to group your instances by purpose, such as development, staging, or production.

Multiple instances can be connected to the same environment if you wish. However, traffic will be routed round-robin style to each instance in the environment.

Environments and gateways can be thought of as logically the same. When you connect your Flipt instance to an environment, you are creating a secure tunnel to your instance via a gateway.

## Instances

An instance is a single running instance of Flipt. When you connect your Flipt instance to Flipt Hybrid Cloud, you are connecting a single instance to an environment.

Instances run in your infrastructure or cloud provider of choice. Flipt Hybrid Cloud provides a secure tunnel to your instance via a gateway, allowing you to access it from anywhere in the world securely and easily.

Check failure on line 37 in cloud/concepts.mdx

View workflow job for this annotation

GitHub Actions / lint 

Delete `⏎`
10 changes: 5 additions & 5 deletions cloud/guides/getting-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Learn how to get started with Flipt Hybrid Cloud
---

<Info>
Flipt Hybrid Cloud is in Active Beta. We're currently onboarding organizations
Flipt Hybrid Cloud is in active beta. We're currently onboarding organizations
one by one. If you are interested in joining the beta, please [sign up
here](https://tally.so/r/mV0zWM).
</Info>
Expand Down Expand Up @@ -64,17 +64,17 @@ To quickly get started with Flipt Hybrid Cloud, follow these steps:
![Cloud Login](/images/cloud/guides/getting-started/login.png)

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

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.
Once you are logged in, you will see the Flipt Hybrid Cloud dashboard. Click on the "Dashboard" tab in the sidebar to view your environments.

You should see your new gateway address listed here. Click on the gateway name to view more details and manage it's settings.
You should see your new temporary address listed here under `Development Environments`. Click on the entry name to view more details and manage it's settings.

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

</Step>
<Step title="Route to Your Instance">
Click on the gateway address to route to your local instance. The address will look something like `https://{gateway}-{organization}.flipt.cloud`.
Click on the URL to route to your local instance. The address will look something like `https://{environment}-{organization}.flipt.cloud`.

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

Expand Down
53 changes: 23 additions & 30 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,54 @@ experimental:
installed on your local machine.
</Note>

## Create a New Gateway
## Create a New 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.
To move your local Flipt instance to production, you need to create a new environment in Flipt Hybrid Cloud. This environment will be used to manage your feature flags and configurations in a production.

<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 Gateway">
<Step title="Create a New Environment">

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.
Once you are logged in, you will see the Flipt Hybrid Cloud dashboard. Click on the `Create Environment` to create a new environment.

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

</Step>
<Step title="Start the Wizard">
<Step title="Name Your Environment">

You will be taken to the gateway creation wizard. Follow the prompts to create a new gateway.
Give your environment a name and description to help you identify it later. Click `Next` to continue.

![Gateway Wizard](/images/cloud/guides/production/wizard-1.png)
![Name Environment](/images/cloud/guides/production/environment-form.png)

</Step>
<Step title="Name Your Gateway">
<Step title="View Environment">

Give your gateway a name and description to help you identify it later. Click `Next` to continue.
After you've created your environment, go back to the dashboard and you should it in the list.

![Gateway Wizard](/images/cloud/guides/production/wizard-2.png)
![Environment Dashboard](/images/cloud/guides/production/environments.png)

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

After you've created your gateway, go back to the Dashboard and you should it in the list.

![Gateway Dashboard](/images/cloud/guides/production/gateways.png)

Next, click on the gateway name to view more details.
Next, click on the environment name to view more details.

Here you can view it's settings and manage your gateway.
Here you can view it's settings and manage your environment.

![Gateway Details](/images/cloud/guides/production/gateway-details.png)
![Environment Details](/images/cloud/guides/production/environment-details.png)

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

In order authenticate your running Flipt instance with your new gateway in Flipt Hybrid Cloud, you'll need to create a gateway API token.
In order authenticate your running Flipt instance with your new environment in Flipt Hybrid Cloud, you'll need to create an API token.

Click on the `Configuration` tab in the gateway details page and then click on the `Gateway API Key` button.
Click on the `Configuration` tab in the environment details page and then click on the `Environment API Key` button.

![Gateway API Key](/images/cloud/guides/production/gateway-api-key.png)
![Environment API Key](/images/cloud/guides/production/environment-api-key.png)

Copy the API key and save it for later.

<Warning>
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.
The API key is a secret token that allows your Flipt instances to authenticate with your environment 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 +87,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 your gateway in Flipt Hybrid Cloud.
This configuration file contains the required settings for your instance to connect to your environment in Flipt Hybrid Cloud.

Move the configuration file to your local [Flipt instance directory](/configuration/overview#configuration-file)

Expand Down Expand Up @@ -133,19 +126,19 @@ flipt -f /path/to/your/configuration.yaml

</Step>

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

After you've started your Flipt instance, go back to the Flipt Hybrid Cloud dashboard and refresh the page.

You should see that your gateway is now connected and showing one active connection.
You should see that your environment is now connected and showing one active connection.

![Gateway Details](/images/cloud/guides/production/gateway-connected.png)
![Environment Details](/images/cloud/guides/production/environment-connected.png)

</Step>

<Step title="Route to Your Instance">

Click on the your gateway address to route to your instance. The address will look something like `https://{gateway}-{organization}.flipt.cloud`.
Click on the URL to route to your instance. The address will look something like `https://{environment}-{organization}.flipt.cloud`.

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

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/environment-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/environment-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/environment-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/environment-form.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/environments.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/gateway-api-key.png
View file
Open in desktop
Binary file not shown.
Binary file removed images/cloud/guides/production/gateway-connected.png
View file
Open in desktop
Binary file not shown.
Binary file removed images/cloud/guides/production/gateway-details.png
View file
Open in desktop
Binary file not shown.
Binary file removed images/cloud/guides/production/gateways.png
View file
Open in desktop
Binary file not shown.
Binary file removed images/cloud/guides/production/wizard-1.png
View file
Open in desktop
Binary file not shown.
Binary file removed images/cloud/guides/production/wizard-2.png
View file
Open in desktop
Binary file not shown.
1 change: 1 addition & 0 deletions mint.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,7 @@
"pages": [
"cloud/overview",
"cloud/benefits",
"cloud/concepts",
{
"group": "Features",
"pages": [
Expand Down
2 changes: 1 addition & 1 deletion reference/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Head to the [Configuration: Authentication](/configuration#authentication) secti

</Info>

As of [v1.35.0](https://github.com/flipt-io/flipt/releases/tag/v1.35.0) Flipt now supports two types of authentication for the API:
Flipt supports two types of authentication for the API:

- **Client Token Authentication** - This method uses tokens stored by Flipt to authenticate the request. See the [Using Client Tokens](/authentication/using-tokens) section for more information.
- **JSON Web Token (JWT) Authentication** - This method uses a JWT token, created and signed externally from Flipt to authenticate the request. See the [Using JWT Tokens](/authentication/using-jwt) section for more information.
Expand Down
Loading