-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(openoracle): register fix and chane docs
- Loading branch information
Showing
9 changed files
with
462 additions
and
34 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 |
---|---|---|
|
@@ -3,7 +3,8 @@ appVersion: 0.1.0 | |
description: A Helm chart for Kubernetes | ||
name: openoracle | ||
type: application | ||
version: 0.1.0 | ||
version: 0.1.1 | ||
maintainers: | ||
- name: xom4ek | ||
email: [email protected] | ||
icon: https://storage.googleapis.com/stakingrewards-static/images/assets/production/openlayer_logo.png?v=1715247060260 |
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 |
---|---|---|
@@ -0,0 +1,82 @@ | ||
# Openoracle Helm Chart | ||
|
||
## Introduction | ||
This repository contains a Helm chart for Kubernetes, specifically for the AVS named "openoracle". | ||
More information about openoracle you can find here [openoracle-configs](https://github.com/0xJomo/openoracle-configs). | ||
|
||
## Table of Contents | ||
- [Openoracle Helm Chart](#openoracle-helm-chart) | ||
- [Introduction](#introduction) | ||
- [Table of Contents](#table-of-contents) | ||
- [Usage](#usage) | ||
- [Steps to Follow:](#steps-to-follow) | ||
- [Configuration](#configuration) | ||
- [Dependencies](#dependencies) | ||
- [Troubleshooting](#troubleshooting) | ||
- [Contributors](#contributors) | ||
- [License](#license) | ||
|
||
## Usage | ||
To use this chart, you can override default values by providing your own `values.yaml` file: | ||
|
||
```sh | ||
helm install openoracle p2p-avs/openoracle -f values.yaml | ||
``` | ||
|
||
### Steps to Follow: | ||
1. Generate keys via the following URLs: | ||
- [Eigenlayer Operator Installation Guide](https://docs.eigenlayer.xyz/eigenlayer/operator-guides/operator-installation) | ||
- [Openoracle Configs](https://github.com/0xJomo/openoracle-configs) | ||
|
||
2. Create a secret in Kubernetes for any workflow you want. Example you can find in `./examples` | ||
|
||
3. Fill the placeholders in your `values.yaml` file: | ||
- `YOUR_OPERATOR_ADDRESS` | ||
- `YOUR_ECDSA_SIGN_KEY_SECRET` | ||
- `YOUR_BLS_KEY_SECRET` | ||
- `YOUR_ECDSA_KEY_SECRET` | ||
|
||
4. Run the following command to upgrade and install the chart: | ||
```sh | ||
helm upgrade -i openoracle p2p-avs/openoracle -f values.yaml | ||
``` | ||
|
||
## Configuration | ||
The following table lists the configurable parameters of the openoracle chart and their default values. | ||
|
||
| Parameter | Description | Default | | ||
|-----------------------------|---------------------------------------------------------------|------------------------------| | ||
| `replicaCount` | Number of replicas | `1` | | ||
| `service.type` | Type of Kubernetes service | `ClusterIP` | | ||
| `service.ports` | Service ports | `{...}` | | ||
| `ingress.enabled` | Enable ingress | `false` | | ||
| `ingress.host` | Ingress host | `example.com` | | ||
| `node.image.repository` | Node image repository | `openoracleofficial/openoracle-labs-avs-operator` | | ||
| `node.image.tag` | Node image tag | `latest` | | ||
| `node.image.pullPolicy` | Image pull policy | `Always` | | ||
| `node.resources.requests` | CPU/Memory resource requests | `2 CPU / 8Gi Memory` | | ||
| `node.resources.limits` | CPU/Memory resource limits | `4 CPU / 16Gi Memory` | | ||
| `serviceAccount.create` | Specifies whether a service account should be created | `true` | | ||
| `serviceAccount.name` | Name of the service account | `""` | | ||
| `vmPodScrape.enabled` | Enable VM Pod scraping | `true` | | ||
| `register.enabled` | Enable register functionality | `true` | | ||
| `register.image.repository` | Register image repository | `openoracleofficial/openoracle-labs-avs-operator` | | ||
| `register.image.tag` | Register image tag | `latest` | | ||
| `register.image.pullPolicy` | Register image pull policy | `Always` | | ||
| `configs.operator.yaml` | Operator configuration | `empty` | | ||
|
||
## Dependencies | ||
This chart depends on several Kubernetes resources and should be used in a Kubernetes cluster. Ensure that you have Kubernetes and Helm installed and configured in your environment. | ||
|
||
## Troubleshooting | ||
If you encounter any issues during installation or usage, check the following: | ||
|
||
- Ensure that all required Kubernetes resources are available. | ||
- Validate your `values.yaml` file against the provided `values.schema.json`. | ||
- Check the logs of the Helm deployment for any errors. | ||
|
||
## Contributors | ||
- xom4ek (Aleksei Lazarev) - [email protected] | ||
|
||
## License | ||
This project is licensed under the MIT License. See the LICENSE file for details. |
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 |
---|---|---|
@@ -1,3 +1,5 @@ | ||
## Generate keys | ||
|
||
For generate keys read this doc https://docs.eigenlayer.xyz/eigenlayer/operator-guides/operator-installation | ||
For generate keys read this docs | ||
- https://docs.eigenlayer.xyz/eigenlayer/operator-guides/operator-installation | ||
- https://github.com/0xJomo/openoracle-configs |
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
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
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
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
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
Oops, something went wrong.