Skip to content

Commit

Permalink
docs: Add supported k8s platforms to README (#256)
Browse files Browse the repository at this point in the history
## Which problem is this PR solving?
The agent should indicate what Kubernetes platforms it supports.

- Closes #3

## Short description of the changes
- Adds a section to the repositories README that indicates what
Kubernetes platforms are supported.

## How to verify that this has the expected result
The list of supported Kubernetes platforms is visible in the README.
  • Loading branch information
MikeGoldsmith committed Sep 29, 2023
1 parent 9fe3663 commit 5b9cd06
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ See notes on local development in [`DEVELOPING.md`](./DEVELOPING.md)

### Requirements

- A running Kubernetes cluster (see [Supported Versions](#supported-versions))
- A running Kubernetes cluster (see [Supported Platforms](#supported-platforms))
- A Honeycomb API Key

### Setup
Expand Down Expand Up @@ -55,7 +55,16 @@ Events should show up in Honeycomb in the `hny-network-agent` dataset.

Alternative options for configuration and running can be found in [Deploying the agent to a Kubernetes cluster](./DEVELOPING.md#deploying-the-agent-to-a-kubernetes-cluster):

## Supported Versions
## Supported Platforms

| Platform | Supported |
| ---------------------------------------------------------------------| ------------------------------------- |
| [AKS](https://azure.microsoft.com/en-gb/products/kubernetes-service) | Supported ✅ |
| [EKS](https://aws.amazon.com/eks/) | Self-managed hosts ✅ <br> Fargate ❌ |
| [GKE](https://cloud.google.com/kubernetes-engine) | Standard cluster ✅ <br> AutoPilot ❌ |
| Self-hosted | Ubuntu ✅ |

### Requirements

- Kubernetes version 1.24+
- Linux Kernel 5.10+ with NET_RAW capabilities
Expand Down

0 comments on commit 5b9cd06

Please sign in to comment.