Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
STARRY-S committed Nov 18, 2024
1 parent e233cfb commit 3767bce
Showing 1 changed file with 8 additions and 24 deletions.
32 changes: 8 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@
</p>
</div>

Rancher Flat-Network Operator (based on [Wrangler V2](https://github.com/rancher/wrangler/)) & CNI plugin for managing
Rancher Flat-Network Operator (based on [Rancher Wrangler](https://github.com/rancher/wrangler/)) & CNI plugin for managing
pods using the flat-networks (Macvlan/IPvlan).

## Current Progress
## Features

### Operator

Expand All @@ -36,30 +36,14 @@ pods using the flat-networks (Macvlan/IPvlan).

## Usage

### Operator

To build and run this flat-network operator manually:

1. Prepare a clean Kubernetes cluster for testing purpose.

1. Apply CRDs.

```console
$ kubectl apply -f ./charts/rancher-flat-network/templates/crd.yaml
```

1. Build and run flat-network operator.

```console
$ go build . && ./rancher-flat-network-operator --webhook-server=false
```
Helm chart of rancher-flat-network V2 is available in `https://github.com/cnrancher/pandaria` repository.

1. Example workloads are available in [docs](./docs/) directory, run following command to create example subnet & workloads for test.
Example workloads are available in [docs](./docs/) directory.

```console
$ kubectl apply -f ./docs/macvlan
$ kubectl apply -f ./docs/ipvlan
```
```console
$ kubectl apply -f ./docs/macvlan
$ kubectl apply -f ./docs/ipvlan
```

Environment variables for operator:

Expand Down

0 comments on commit 3767bce

Please sign in to comment.