Skip to content

Commit

Permalink
chore: minor updates to cloud docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@markphelps
markphelps committed May 10, 2024
1 parent 0b7647c commit d7100a4
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 14 deletions.
2 changes: 2 additions & 0 deletions .vale/styles/Flipt/spelling-exceptions.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ oauth
oidc
okta
otlp
onboarding
passwordless
performant
PGBouncer
pluggable
Expand Down
22 changes: 13 additions & 9 deletions cloud/architecture/overview.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,15 @@ Flipt comes baked with lots of critical features for scale and security, includi

- Ability to scale horizontally
- HTTPS/TLS support
- Configurable authentication mechanisms (Static Token, OIDC, GitHub, JWT and Kubernetes)
- Configurable [authentication mechanisms](/configuration/authentication) (Static Token, OIDC, GitHub, JWT and Kubernetes, etc.)
- API and UI with session management and termination

These capabilities are super important for deploying Flipt into your infrastructure and making it secure for your users.
However, enabling and integrating these features isn't free of complexities, infrastructure, and time investment.
In order to take advantage of these, you're likely going to have to perform one or many of the following:

- Enable networking and routing to your Flipt instance
In order to take advantage of these, you're likely going to have to perform one or more of the following actions:

Check warning on line 18 in cloud/architecture/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.Hedging] Consider removing 'likely'

Raw Output:
{"message": "[Openly.Hedging] Consider removing 'likely'", "location": {"path": "cloud/architecture/overview.mdx", "range": {"start": {"line": 18, "column": 45}}}, "severity": "WARNING"}

- Enable networking and routing to your Flipt instance (e.g. open ports, configure firewalls, VPN, etc.)

Check warning on line 20 in cloud/architecture/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.Punctuation] Use 'eg' instead of 'e.g.'

Raw Output:
{"message": "[Openly.Punctuation] Use 'eg' instead of 'e.g.'", "location": {"path": "cloud/architecture/overview.mdx", "range": {"start": {"line": 20, "column": 57}}}, "severity": "WARNING"}

Check warning on line 20 in cloud/architecture/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.Foreign] Use 'for example' instead of 'e.g.'.

Raw Output:
{"message": "[Microsoft.Foreign] Use 'for example' instead of 'e.g.'.", "location": {"path": "cloud/architecture/overview.mdx", "range": {"start": {"line": 20, "column": 57}}}, "severity": "WARNING"}
- Issue and assign an (internal or external) DNS name for your Flipt
- Add a load-balancer to distribute load across your instances of Flipt
- Issue TLS certificates and manage their rotation over time
Expand All @@ -38,7 +39,7 @@ Flipt Cloud replaces all these steps with a few clicks and some API credentials.

Flipt Cloud reverses the ingress problem so that your deployments of Flipt dial out to us instead.
This approach is commonly referred to as _reverse tunneling_.
Tunneling in this way has some advantages for applications, as they can be deployed in environments without a stable IP address (e.g. behind restrictive NATs).
Tunneling in this way has several advantages for applications, as they can be deployed in environments without a stable IP address (e.g. behind restrictive NATs).

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

Check warning on line 42 in cloud/architecture/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.Foreign] Use 'for example' instead of 'e.g.'.

Raw Output:
{"message": "[Microsoft.Foreign] Use 'for example' instead of 'e.g.'.", "location": {"path": "cloud/architecture/overview.mdx", "range": {"start": {"line": 42, "column": 133}}}, "severity": "WARNING"}

Check warning on line 42 in cloud/architecture/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.Punctuation] Use 'eg' instead of 'e.g.'

Raw Output:
{"message": "[Openly.Punctuation] Use 'eg' instead of 'e.g.'", "location": {"path": "cloud/architecture/overview.mdx", "range": {"start": {"line": 42, "column": 133}}}, "severity": "WARNING"}
For Flipt, this means you can safely expose Flipt from inside a major cloud provider, a modern hyperscaler or simply from your own laptop on your home network.

<img
Expand All @@ -50,10 +51,12 @@ For Flipt, this means you can safely expose Flipt from inside a major cloud prov
src="/images/cloud/architecture/architecture-overview-dark.svg"
/>

When you register your instance in this way with Flipt Cloud, we issue you with a stable subdomain under flipt.cloud (e.g. production-megacorp.flipt.cloud).
When you register your instance in this way with Flipt Cloud, we issue you with a stable subdomain under `flipt.cloud` (e.g. `production-megacorp.flipt.cloud`).

Using this DNS name, requests for your instances will flow though our API gateways, load-balancers and then only reach your instances once fully authenticated.

This entire process is performed over secure TLS connections from your end users back to your instances.
All of which is done without you having to provide TLS certificates, and without having to manage rotation.
All of which is done without you having to provide TLS certificates, and without having to manage certificate rotation.

## Tunnel Registration

Expand All @@ -72,9 +75,10 @@ This credential is used in an initial handshake to identify your Flipt Cloud org
Once registered and associated with Flipt Cloud, your Flipt instance is added to our remote load balancer pool for your logical instance.
Now when you visit your new Flipt Cloud instance subdomain, your requests are routed to the instances deployed on your infrastructure.

The majority of the tunneling functionality we perform is now open-source in our project [Reverst](https://github.com/flipt-io/reverst).
The majority of the tunneling functionality we perform is provided by our open-source project [Reverst](https://github.com/flipt-io/reverst).
Reverst is unique in that it leverages HTTP/3 and the QUIC protocol to establish secure, reliable, and performant connections for tunnels.
Keep your eyes peeled for our upcoming blog on how and why we choose to build our reverse tunnels in this way.

We deploy and scale multiple instances of Reverst on our infrastructure for establishing and managing these tunnels for you.
All while tightly integrating them with the Flipt Cloud user interface, authentication, and instance management system.
We deploy and scale multiple instances of Reverst on our infrastructure for establishing and managing these tunnels for you, all while tightly integrating them with the Flipt Cloud user interface, authentication, and instance management system.

Have more questions about how Flipt Cloud works? Join our [Discord](https://flipt.io/discord) and ask away! We're always happy to help.

Check failure on line 84 in cloud/architecture/overview.mdx

View workflow job for this annotation

GitHub Actions / lint 

Insert `⏎`
5 changes: 5 additions & 0 deletions cloud/features/audit-logs.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ mode: "wide"

Flipt Hybrid Cloud provides centralized audit logs to help you track changes to your feature flags and configurations. With audit logs, you can see who made changes, when they were made, and what changes were made. This makes it easy to track changes, troubleshoot issues, and maintain a history of your feature flag configurations.

<Note>
Currently, audit logs are only available if Flipt is running with one of our [relational database backends](/configuration/storage#relational-database). We'

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

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

Check failure on line 10 in cloud/features/audit-logs.mdx

View workflow job for this annotation

GitHub Actions / lint 

Replace `Currently,·audit·logs·are·only·available·if·Flipt·is·running·with·one·of·our·[relational·database·backends](/configuration/storage#relational-database).·We'⏎` with `··Currently,·audit·logs·are·only·available·if·Flipt·is·running·with·one·of·our⏎··[relational·database·backends](/configuration/storage#relational-database).⏎··We'·`
re working on adding support for other storage backends in the future.
</Note>

![Audit Event](/images/cloud/features/audit-event.png)

Audit logs are available for all changes made in your Flipt instances and can be accessed from the Flipt Hybrid Cloud dashboard.
Expand Down
4 changes: 2 additions & 2 deletions cloud/guides/getting-started.mdx
View file
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 are currently onboarding
Flipt Hybrid Cloud is in Active Beta. We're currently onboarding

Check warning on line 7 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 'We'.

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

Check failure on line 7 in cloud/guides/getting-started.mdx

View workflow job for this annotation

GitHub Actions / lint 

Replace `⏎··organizations·one·by·one.·If·you·are·interested·in·joining·the·beta,·please⏎··[sign·up` with `·organizations⏎··one·by·one.·If·you·are·interested·in·joining·the·beta,·please·[sign·up⏎·`
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 @@ -80,7 +80,7 @@ You have successfully connected your local Flipt instance to Flipt Hybrid Cloud!

### Details

- You now have a fully functional Flipt instance running on your local machine that is protected behind authentication provided by Flipt Hybrid Cloud. 🔒
- You now have a fully functional Flipt instance running on your local machine that's protected behind authentication provided by Flipt Hybrid Cloud. 🔒

- You can now access your local instance through the Flipt Hybrid Cloud web interface from anywhere in the world! 🌍

Expand Down
6 changes: 3 additions & 3 deletions cloud/guides/production.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Learn how go to production with Flipt Hybrid Cloud
---

<Info>
Flipt Hybrid Cloud is in Active Beta. We are currently onboarding
Flipt Hybrid Cloud is in Active Beta. We're currently onboarding

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

Check failure on line 7 in cloud/guides/production.mdx

View workflow job for this annotation

GitHub Actions / lint 

Replace `⏎··organizations·one·by·one.·If·you·are·interested·in·joining·the·beta,·please⏎··[sign·up` with `·organizations⏎··one·by·one.·If·you·are·interested·in·joining·the·beta,·please·[sign·up⏎·`
organizations one by one. If you are interested in joining the beta, please
[sign up here](https://1ld82idjvlr.typeform.com/to/s7YfGviE).
</Info>
Expand Down Expand Up @@ -158,7 +158,7 @@ You have successfully and permanently connected your Flipt instance to Flipt Hyb

### Details

- You now have a fully functional Flipt instance running in your infrastructure that is protected behind authentication provided by Flipt Hybrid Cloud. 🔒
- You now have a fully functional Flipt instance running in your infrastructure that's protected behind authentication provided by Flipt Hybrid Cloud. 🔒

- You can now access this instance through the Flipt Hybrid Cloud web interface from anywhere in the world! 🌍

Expand All @@ -176,4 +176,4 @@ Unlike in the [Getting Started](/cloud/guides/getting-started) guide, the addres

Now that you have successfully connected your permanent instance to Flipt Hybrid Cloud, you can start creating feature flags and managing your feature flag configurations.

You can now learn more about the advanced features and capabilities available to you in the [Flipt Hybrid Cloud documentation](/cloud/overview) and how to enable additional features like [Single Sign-On](/cloud/features/authentication) and [Audit Logs](/cloud/features/audit-logs).
You can now learn more about the advanced features and capabilities available to you such as [Single Sign-On](/cloud/features/authentication) and [Audit Logs](/cloud/features/audit-logs).

0 comments on commit d7100a4

Please sign in to comment.