Skip to content

Commit

Permalink
Add index for FKS + make other index pages consistent (superfly#1709)
Browse files Browse the repository at this point in the history
* make index pages consistent

* clean up
  • Loading branch information
andie787 authored Jul 22, 2024
1 parent 88e0e49 commit 2e12f15
Show file tree
Hide file tree
Showing 20 changed files with 151 additions and 131 deletions.
26 changes: 17 additions & 9 deletions about/index.html.markerb
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,20 @@ nav: firecracker

More details about using and working with the Fly.io platform.

* [_Pricing_](/docs/about/pricing/) : Pricing for compute, storage, and all the FLy.io platform services.
* [_Billing_](/docs/about/pricing/) : How billing works on Fly.io.
* [_Healthcare_](/docs/about/healthcare/) : Controls relevant to running healthcare apps on Fly.io.
* [_Support_](/docs/about/support) : Who to contact and where to go when you need Fly.io support.
* [_Extensions program_](/docs/about/extensions/) and [_Extensions API_](/docs/reference/extensions_api/): Learn about becoming an extensions partner.
* [_Open Source_](/docs/about/open-source/) : How we help those OSS projects that help us.
* [_Using Our Brand_](/docs/about/brand/) : Assets and guidelines to help represent our brand.
* [_Privacy Policy_](/legal/privacy-policy/) : Our policy on privacy, detailed here.
* [_Terms of Service_](/legal/terms-of-service) : The legal terms of service for Fly.io users.
* **[Pricing](/docs/about/pricing/):** Pricing for compute, storage, and all the FLy.io platform services.

* **[Billing](/docs/about/pricing/):** How billing works on Fly.io.

* **[Healthcare](/docs/about/healthcare/):** Controls relevant to running healthcare apps on Fly.io.

* **[Support](/docs/about/support):** Who to contact and where to go when you need Fly.io support.

* **[Extensions program](/docs/about/extensions/) and [Extensions API](/docs/reference/extensions_api/):** Learn about becoming an extensions partner.

* **[Open Source](/docs/about/open-source/):** How we help those OSS projects that help us.

* **[Using Our Brand](/docs/about/brand/):** Assets and guidelines to help represent our brand.

* **[Privacy Policy](/legal/privacy-policy/):** Our policy on privacy, detailed here.

* **[Terms of Service](/legal/terms-of-service):** The legal terms of service for Fly.io users.
5 changes: 3 additions & 2 deletions apps/index.html.markerb
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ An app on Fly.io can be anything from a simple frontend web app to a complex arr

_If you're looking to deploy an app on Fly.io, you probably want Fly Launch. Use Fly Launch to create your app and then manage the whole lifecycle, from starting to scaling to changing and redeploying._

- [Get started](/docs/getting-started/) with Fly Launch
- [Use Fly Launch](/docs/launch/) to create, configure, deploy, and scale your app
- **[Get started](/docs/getting-started/):** Launch your own app or try a demo app.

- **[Use Fly Launch](/docs/launch/):** Learn how to create, configure, deploy, and scale your app.

---

Expand Down
8 changes: 3 additions & 5 deletions getting-started/get-started-by-framework.html.markerb
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,12 @@ nav: firecracker
toc: false
---

Fly Launch can deploy almost any app from a [Dockerfile](/docs/languages-and-frameworks/dockerfile/).

Fly Launch scanners also detect and deploy the following kinds of apps automatically:
Fly Launch scanners detect and deploy the following kinds of apps automatically:

<%= partial "/docs/languages-and-frameworks/partials/scanner_guides" %>

Learn more about what [Fly Launch](/docs/launch/) does.
Don't see your framework or language in the list? Fly Launch can deploy almost any app from a [Dockerfile](/docs/languages-and-frameworks/dockerfile/). Learn more about what [Fly Launch](/docs/launch/) does.

<figure class="text-center">
<img src="/static/images/speedrun-guidebooks.webp" srcset="/static/images/[email protected] 2x" alt="Illustration by Annie Ruygt of Frankie the Fly.io hot air balloon character with one hand on their hip and the other hand out, palm up, with images floating above the hand representing the Elixir, Ruby, Laravel, and Django programming languages">
</figure>
</figure>
6 changes: 3 additions & 3 deletions index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,13 +69,13 @@ _Services from Fly.io and our extension partners to help you run your entire sta

[LiteFS - Distributed SQLite](/docs/litefs/)

[Fly Kubernetes (private beta)](/docs/kubernetes/fks-quickstart/)
[Fly Kubernetes (private beta)](/docs/kubernetes/)

---

## Networking

_Private networking, public services, custom domains, routing, and load balancing._
_Private networking, public networking, custom domains and certificates, UDP apps, and routing._

[Networking](/docs/networking/) on Fly.io

Expand All @@ -97,7 +97,7 @@ _Explore built-in and custom Prometheus metrics and Grafana dashboards. Live tai

_Built-in security and partner extensions._

[Security](/docs/security/#fly-io-platform-security) on the Fly.io platform
[Security](/docs/security/) on the Fly.io platform

[Application security by Arcjet](/docs/reference/arcjet/) for JavaScript apps

Expand Down
2 changes: 0 additions & 2 deletions kubernetes/clusters.html.markerb
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,5 @@ kube-system Active 22d

## Related topics

- [FKS Quickstart](/docs/kubernetes/fks-quickstart/)
- [Connect to an FKS cluster](/docs/kubernetes/connect-clusters/)
- [Configure FKS Services](/docs/kubernetes/services)
- [Use volumes with FKS](/docs/kubernetes/using-volumes/)
2 changes: 0 additions & 2 deletions kubernetes/connect-clusters.html.markerb
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,5 @@ kube-system Active 22d

## Related topics

- [FKS Quickstart](/docs/kubernetes/fks-quickstart/)
- [Create an FKS cluster](/docs/kubernetes/clusters/)
- [Configure FKS Services](/docs/kubernetes/services)
- [Use volumes with FKS](/docs/kubernetes/using-volumes/)
53 changes: 53 additions & 0 deletions kubernetes/fks-features.html.markerb
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: Fly Kubernetes features
layout: docs
nav: firecracker
---

Fly Kubernetes benefits from the features of the Fly.io platform.

## Fly.io infrastructure

FKS is built on top of Fly.io infrastructure:

* Compute is backed by [Fly Machines](/docs/machines/), our fast-launching VMs built with Firecracker.
* Volumes are handled with [Fly Volumes](/docs/volumes/); local, fast NVMe drives.
* Networking is built on our [internal WireGuard mesh](/docs/networking/private-networking/#private-network-vpn) with routing performed by Fly Proxy.

## Cluster scalability

Pods are scheduled across our fleet of bare-metal servers, not limited to a specific node. Workloads are automatically distributed across the fleet, enabling a cluster to scale with ease.

## Security

With Fly Kubernetes, you get all the security benefits of our platform.

* Private network traffic flows over our internal WireGuard mesh, ensuring it is encrypted.
* FKS clusters are secured within a private VPN.
* Compute is built on Firecracker microVMs — lightweight and secure virtual machines. This provides improved isolation guarantees ensuring your application code is safe.
* Volumes are encrypted at rest for additional protection of the data on the volume.
* Secrets are automatically stored in an encrypted vault.

## Simple and secure client authentication

Connect to your cluster using kubectl. Clients are authenticated with our API tokens. They expire after an hour and are rotated automatically after expiration.

## Not supported

There are a few features we don't support yet but are part of the roadmap:

* Sidecars and init processes
* EmptyDir volumes
* Horizontal pod autoscaling
* Network policies
* CronJob

Features we don't support:

* Node affinity
* Inter-pod (anti) affinity
* DaemonSets

## Pricing

See the [pricing page](/docs/about/pricing/#fly-kubernetes) for information on FKS pricing.
1 change: 0 additions & 1 deletion kubernetes/fks-quickstart.html.markerb
Original file line number Diff line number Diff line change
Expand Up @@ -156,4 +156,3 @@ Right now we don't get logs from a single pod. If you try to get logs from a sin
- [Create an FKS cluster](/docs/kubernetes/clusters/)
- [Connect to an FKS cluster](/docs/kubernetes/connect-clusters/)
- [Configure FKS Services](/docs/kubernetes/services)
- [Use volumes with FKS](/docs/kubernetes/using-volumes/)
65 changes: 8 additions & 57 deletions kubernetes/index.html.markerb
Original file line number Diff line number Diff line change
Expand Up @@ -3,73 +3,24 @@ title: Fly Kubernetes
layout: docs
toc: false
nav: firecracker
redirect_from: /docs/kubernetes/volumes/
---

<div class= "important icon">
Fly Kubernetes is in beta and not recommended for critical production usage. To report issues or provide feedback, email us at [email protected].
</div>

Fly Kubernetes (FKS) is a fully managed Kubernetes service built on the Fly.io platform. It enables you to easily deploy Kubernetes clusters without the hassle of managing and operating the control plane. Learn more about [why and how we made FKS](https://fly.io/blog/fks/).
Fly Kubernetes (FKS) is a fully managed Kubernetes service built on the Fly.io platform. Deploy Kubernetes clusters without the hassle of managing and operating the control plane. Learn more about [why and how we made FKS](https://fly.io/blog/fks/) in our blog.

## Getting started
- **[Fly Kubernetes quickstart](/docs/kubernetes/fks-quickstart/):** Get up and running right away with our quickstart guide.

To get up and running immediately, try the [Fly Kubernetes quickstart](https://fly.io/docs/kubernetes/fks-quickstart/) guide
- **[Fly Kubernetes features](/docs/kubernetes/fks-features/):** An overview of FKS benefits and supported features.

## Features
- **[Create an FKS cluster](/docs/kubernetes/clusters/):** Create an FKS cluster with flyctl.

Fly Kubernetes benefits from the features of the Fly.io platform.
- **[Connect to an FKS cluster](/docs/kubernetes/connect-clusters/):** Connect to an FKS cluster on your private network.

### Fly.io infrastructure
- **[Configure FKS Services](/docs/kubernetes/services):** Configure ClusterIP and LoadBalancer services.

FKS is built on top of Fly.io infrastructure:
- **[Use GPUs with FKS](/docs/kubernetes/using-gpus/):** Use Fly GPU Machines in your FKS cluster.

* Compute is backed by [Fly Machines](/docs/machines/), our fast-launching VMs built with Firecracker.
* Volumes are handled with [Fly Volumes](/docs/volumes/); local, fast NVMe drives.
* Networking is built on our [internal WireGuard mesh](/docs/networking/private-networking/#private-network-vpn) with routing performed by Fly Proxy.

### Cluster scalability

Pods are scheduled across our fleet of bare-metal servers, not limited to a specific node. Workloads are automatically distributed across the fleet, enabling a cluster to scale with ease.

### Security

With Fly Kubernetes, you get all the security benefits of our platform.

* Private network traffic flows over our internal WireGuard mesh, ensuring it is encrypted.
* FKS clusters are secured within a private VPN.
* Compute is built on Firecracker microVMs — lightweight and secure virtual machines. This provides improved isolation guarantees ensuring your application code is safe.
* Volumes are encrypted at rest for additional protection of the data on the volume.
* Secrets are automatically stored in an encrypted vault.

### Simple and secure client authentication

Connect to your cluster using kubectl. Clients are authenticated with our API tokens. They expire after an hour and are rotated automatically after expiration.

### Not supported

There are a few features we don't support yet but are part of the roadmap:

* Sidecars and init processes
* EmptyDir volumes
* Horizontal pod autoscaling
* Network policies
* CronJob

Features we don't support:

* Node affinity
* Inter-pod (anti) affinity
* DaemonSets

### Pricing

See the [pricing page](/docs/about/pricing/#fly-kubernetes) for information on FKS pricing.

## Related topics

- [FKS Quickstart](/docs/kubernetes/fks-quickstart/)
- [Create an FKS cluster](/docs/kubernetes/clusters/)
- [Connect to an FKS cluster](/docs/kubernetes/connect-clusters/)
- [Configure FKS Services](/docs/kubernetes/services)
- [Use volumes with FKS](/docs/kubernetes/using-volumes/)
- **[Use volumes with FKS](/docs/kubernetes/using-volumes/):** Use Fly Volumes for PersistentVolumes in FKS.
2 changes: 0 additions & 2 deletions kubernetes/services.html.markerb
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,5 @@ We currently do not support:

## Related topics

- [FKS Quickstart](/docs/kubernetes/fks-quickstart/)
- [Create an FKS cluster](/docs/kubernetes/clusters/)
- [Connect to an FKS cluster](/docs/kubernetes/connect-clusters/)
- [Use volumes with FKS](/docs/kubernetes/using-volumes/)
7 changes: 0 additions & 7 deletions kubernetes/using-gpus.html.markerb
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,3 @@ spec:
```

This will deploy a GPU Machine with the size `a100-80gb` with 1 GPU core in the region `ams`.

## Related topics

- [FKS Quickstart](/docs/kubernetes/fks-quickstart/)
- [Create an FKS cluster](/docs/kubernetes/clusters/)
- [Configure FKS Services](/docs/kubernetes/services)
- [Use volumes with FKS](/docs/kubernetes/using-volumes/)
7 changes: 0 additions & 7 deletions kubernetes/using-volumes.html.markerb
Original file line number Diff line number Diff line change
Expand Up @@ -165,10 +165,3 @@ spec:
```

For generic ephemeral volumes to work as expected, `storageClassName` must be set to `flyio-volume`.

## Related topics

- [FKS Quickstart](/docs/kubernetes/fks-quickstart/)
- [Create an FKS cluster](/docs/kubernetes/clusters/)
- [Connect to an FKS cluster](/docs/kubernetes/connect-clusters/)
- [Configure FKS Services](/docs/kubernetes/services)
9 changes: 9 additions & 0 deletions languages-and-frameworks/partials/_scanner_guides.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@
<li>
<a href="/docs/elixir/getting-started">Elixir</a>
</li>
<li>
<a href="/docs/python/frameworks/fastapi/">FastAPI</a>
</li>
<li>
<a href="/docs/python/frameworks/flask/">Flask</a>
</li>
<li>
<a href="/docs/languages-and-frameworks/golang/">Go</a>
</li>
Expand Down Expand Up @@ -53,6 +59,9 @@
<li>
<a href="/docs/languages-and-frameworks/static/">Static Website</a>
</li>
<li>
<a href="/docs/python/frameworks/streamlit/">Streamlit</a>
</li>
<li>
<a href="/docs/js/frameworks/svelte/">SvelteKit</a>
</li>
Expand Down
2 changes: 2 additions & 0 deletions machines/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ nav: machines
Fly Machines are fast-launching VMs; they can be started and stopped at subsecond speeds. We give you control of your Machine count and each Machine's lifecycle, resources, and region placement with a simple REST API or flyctl commands.

- [**Introduction to Fly Machines**:](/docs/machines/overview/) Learn whether you need low-level Machine control. Find out more about the lifecycle of Fly Machines and about scaling and placement.

- [**Machines API:**](/docs/machines/api/) A simple and fast REST API for full control over our fast-launching Machines.

- **[Run a New Machine](/docs/machines/flyctl/fly-machine-run/) or [Update a Machine](/docs/machines/flyctl/fly-machine-update/) with flyctl:** Configure, build, and start new Machines with a single command or update some or all of a Machine's configuration.

On the other hand, try [Fly Launch](/docs/reference/fly-launch/) if you prefer easy app-wide configuration and containerized deployment for your app.
Expand Down
11 changes: 7 additions & 4 deletions networking/index.html.markerb
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,16 @@ Networking on Fly.io.

- **[Custom domains](/docs/networking/custom-domain/):** Add a custom domain for your app and troubleshoot certificate creation.

- **[Automate the certificate process for custom domains with the GraphQL API](/docs/networking/custom-domain-api):** If you need to issue multiple certificates automatically for custom domains, you can do that with the GraphQL API.
- **[Automate the certificate process with the GraphQL API](/docs/networking/custom-domain-api):** If you need to issue multiple certificates automatically for custom domains, you can do that with the GraphQL API.

- **[Run UDP services](/docs/networking/udp-and-tcp/):** Understand the gotchas of running Fly Apps on UDP.
- **[HTTP request headers](/docs/networking/request-headers/):** Fly.io-specific and standard HTTP headers added by the HTTP connection handler.

- **[Run UDP services](/docs/networking/udp-and-tcp/):** How to set up apps that use UDP.

- **[TLS support](/docs/networking/tls/):** Supported TLS cipher suites.

## Related topics

- How Fly.io does [load balancing](/docs/reference/load-balancing/)
- Fly [Regions](/docs/reference/regions/)
- [Fly Proxy](/docs/reference/fly-proxy)
- [How Fly Proxy does load balancing](/docs/reference/load-balancing/)
- [Fly Regions](/docs/reference/regions/)
13 changes: 7 additions & 6 deletions partials/_firecracker_nav.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -108,12 +108,13 @@
path: "/docs/kubernetes/",
open: false,
links: [
{ text: "Kubernetes Quickstart", path: "/docs/kubernetes/fks-quickstart/" },
{ text: "Create an FKS cluster", path: "/docs/kubernetes/clusters/" },
{ text: "Connect to an FKS cluster", path: "/docs/kubernetes/connect-clusters/" },
{ text: "Fly Kubernetes Quickstart", path: "/docs/kubernetes/fks-quickstart/" },
{ text: "Fly Kubernetes Features", path: "/docs/kubernetes/fks-features/" },
{ text: "Create an FKS Cluster", path: "/docs/kubernetes/clusters/" },
{ text: "Connect to an FKS Cluster", path: "/docs/kubernetes/connect-clusters/" },
{ text: "Configure FKS Services", path: "/docs/kubernetes/services/" },
{ text: "Use volumes with FKS", path: "/docs/kubernetes/using-volumes/" },
{ text: "Use GPUs with FKS", path: "/docs/kubernetes/using-gpus/" },
{ text: "Use Volumes with FKS", path: "/docs/kubernetes/using-volumes/" }
]
},
{
Expand Down Expand Up @@ -153,7 +154,8 @@
links: [
{ text: "SSO for organizations", path: "/docs/security/sso/" },
{ text: "TLS termination", path: "/docs/security/tls-termination/" },
{ text: "Deploy Tokens", path: "/docs/security/deploy-tokens/" },
{ text: "Deploy Tokens", path: "/docs/security/deploy-tokens/" },
{ text: "OpenID Connect", path: "/docs/reference/openid-connect/" },
{ text: "Security practices and compliance", path: "/docs/security/security-at-fly-io/" },
{ text: "App Security by Arcjet", path: "/docs/reference/arcjet/" }
]
Expand All @@ -172,7 +174,6 @@
{ text: "Load Balancing", path: "/docs/reference/load-balancing/" },
{ text: "Machine migration", path: "/docs/reference/machine-migration/" },
{ text: "Multiple Processes in Apps", path: "/docs/app-guides/multiple-processes/" },
{ text: "OpenID Connect", path: "/docs/reference/openid-connect/" },
{ text: "Fly Proxy", path: "/docs/reference/fly-proxy/" },
{ text: "Regions", path: "/docs/reference/regions/" }
]
Expand Down
Loading

0 comments on commit 2e12f15

Please sign in to comment.