-
Notifications
You must be signed in to change notification settings - Fork 217
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: rearrange and clean up README
Signed-off-by: Evan Baker <[email protected]>
- Loading branch information
Showing
1 changed file
with
49 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -22,65 +22,75 @@ Retina **collects customizable telemetry**, which can be exported to **multiple | |
|
||
Retina lets you **investigate network issues on-demand** and **continuously monitor your clusters**. For scenarios where Retina shines, see the intro docs [here](https://retina.sh/docs/intro) | ||
|
||
## CLI Setup | ||
## Documentation | ||
|
||
Currently, Retina CLI only supports Linux. | ||
See [retina.sh](http://retina.sh) for documentation and examples. | ||
|
||
For CLI usage, see [Capture with Retina CLI](../captures/cli.md). | ||
## Capabilities | ||
|
||
## Option 1: Download from Release | ||
Retina has two major features: | ||
|
||
Download `kubectl-retina` from the latest [Retina release](https://github.com/microsoft/retina/releases). | ||
Feel free to move the binary to `/usr/local/bin/`, or add it to your `PATH` otherwise. | ||
- [Metrics](https://retina.sh/docs/metrics/modes) | ||
- [Captures](https://retina.sh/docs/captures) | ||
|
||
## Option 2: Build from source | ||
### Metrics Quick Install Guide | ||
|
||
Clone the Retina repo and execute: | ||
Prerequisites: Go, Helm | ||
|
||
```shell | ||
make install-kubectl-retina | ||
``` | ||
1. Clone the repo, then install Retina on your Kubernetes cluster | ||
|
||
Requirements: | ||
```bash | ||
make helm-install | ||
``` | ||
|
||
- go 1.21 or newer | ||
- GNU make | ||
2. Follow steps in [Using Prometheus and Grafana](https://retina.sh/docs/installation/prometheus-unmanaged) to set up metrics collection and visualization. | ||
|
||
## Documentation | ||
### Captures Quick Start Guide | ||
|
||
See [retina.sh](http://retina.sh) for more information and examples. | ||
#### Captures via CLI | ||
|
||
## Capabilities | ||
Currently, Retina CLI only supports Linux. | ||
|
||
Retina is currently supported in AKS. It has two major features: | ||
- Option 1: Download from Release | ||
|
||
### Metrics | ||
Download `kubectl-retina` from the latest [Retina release](https://github.com/microsoft/retina/releases). | ||
Feel free to move the binary to `/usr/local/bin/`, or add it to your `PATH` otherwise. | ||
|
||
[Read more](https://retina.sh/docs/metrics/modes) | ||
- Option 2: Build from source | ||
|
||
### Quick Install Guide | ||
Requirements: | ||
|
||
Prerequisites: Go, Helm | ||
- go 1.21 or newer | ||
- GNU make | ||
|
||
1. Clone the repo, then install Retina on your Kubernetes cluster | ||
Clone the Retina repo and execute: | ||
|
||
```bash | ||
make helm-install | ||
```shell | ||
make install-kubectl-retina | ||
``` | ||
|
||
2. Follow steps in [Using Managed Prometheus and Grafana](https://retina.sh/docs/installation/prometheus-azure-managed) to set up metrics collection and visualization. | ||
Execute retina | ||
|
||
### Captures | ||
```shell | ||
kubectl-retina capture create --help | ||
``` | ||
|
||
[Read more](https://retina.sh/docs/captures) | ||
For further CLI documentation, see [Capture with Retina CLI](../captures/cli.md). | ||
|
||
## Contributing | ||
#### Captures via CRD | ||
|
||
[Read more](https://retina.sh/docs/contributing) | ||
Prerequisites: Go, Helm | ||
|
||
## Office Hours and Community Meetings | ||
1. Clone the repo, then install Retina with Capture operator support on your Kubernetes cluster | ||
|
||
[Read more](https://retina.sh/docs/contributing/#office-hours-and-community-meetings) | ||
```bash | ||
make helm-install-with-operator | ||
``` | ||
|
||
2. Follow steps in [Capture CRD](https://retina.sh/docs/captures/#option-2-capture-crd-custom-resource-definition) for documentation of the CRD and examples for setting up Captures. | ||
|
||
|
||
## Contributing | ||
|
||
This project welcomes contributions and suggestions. Most contributions require you to agree to a | ||
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us | ||
|
@@ -94,6 +104,12 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope | |
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or | ||
contact [[email protected]](mailto:[email protected]) with any additional questions or comments. | ||
|
||
[Read more about how to begin contributing here.](https://retina.sh/docs/contributing) | ||
|
||
### Office Hours and Community Meetings | ||
|
||
We host a periodic open community meeting. [Read more here.](https://retina.sh/docs/contributing/#office-hours-and-community-meetings) | ||
|
||
## Trademarks | ||
|
||
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft | ||
|
@@ -103,7 +119,7 @@ Any use of third-party trademarks or logos are subject to those third-party's po | |
|
||
## License | ||
|
||
See [LICENSE](LICENSE). | ||
See the [LICENSE](LICENSE). | ||
|
||
## Code of Conduct | ||
|
||
|