Skip to content

Commit

Permalink
docs(proxyd): update README.md broken links, escape | for helm-docs (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
johnkozan authored Feb 21, 2025
1 parent 67cc307 commit 62b012a
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion charts/proxyd/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: proxyd
description: Deploy and scale [proxyd](https://github.com/ethereum-optimism/optimism/tree/develop/proxyd) inside Kubernetes with ease
description: Deploy and scale [proxyd](https://github.com/ethereum-optimism/infra/tree/main/proxyd) inside Kubernetes with ease

# A chart can be either an 'application' or a 'library' chart.
#
Expand Down
6 changes: 3 additions & 3 deletions charts/proxyd/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Proxyd Helm Chart

Deploy and scale [proxyd](https://github.com/ethereum-optimism/optimism/tree/develop/proxyd) inside Kubernetes with ease
Deploy and scale [proxyd](https://github.com/ethereum-optimism/infra/tree/main/proxyd) inside Kubernetes with ease

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) ![Version: 0.6.5](https://img.shields.io/badge/Version-0.6.5-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v4.12.0](https://img.shields.io/badge/AppVersion-v4.12.0-informational?style=flat-square)

## Introduction

[Proxyd](https://github.com/ethereum-optimism/optimism/tree/develop/proxyd) is an EVM-blockchain JSON-RPC router and load balancer developed in Go by [Optimism](https://www.optimism.io/). It is capable of load balancing, automatic failover, intelligent request routing and very basic caching.
[Proxyd](https://github.com/ethereum-optimism/infra/tree/main/proxyd) is an EVM-blockchain JSON-RPC router and load balancer developed in Go by [Optimism](https://www.optimism.io/). It is capable of load balancing, automatic failover, intelligent request routing and very basic caching.

## Chart Features

Expand Down Expand Up @@ -127,7 +127,7 @@ We do not recommend that you upgrade the application by overriding `image.tag`.
| Key | Description | Type | Default |
|-----|-------------|------|---------|
| backendConfigTemplate | TOML configuration for backend | string | `"# How long proxyd should wait for a backend response before timing out.\nresponse_timeout_seconds = 300\n# Maximum response size, in bytes, that proxyd will accept from a backend.\nmax_response_size_bytes = 10737420000 # 10 GiB\n# Maximum number of times proxyd will try a backend before giving up.\nmax_retries = 3\n# Number of seconds to wait before trying an unhealthy backend again.\nout_of_service_seconds = 10\n"` |
| backendGroups.routing_strategy | Set the routing strategy (consensus_aware | multicall | fallback) | string | `"consensus_aware"` |
| backendGroups.routing_strategy | Set the routing strategy (consensus_aware \| multicall \| fallback) | string | `"consensus_aware"` |
| backends.example-backend | Example backend configuration, keep disabled | object | `{"enabled":false,"extraConfig":{},"groups":["main"],"rpcUrl":"http://your-node:8545","wsUrl":"ws://your-node:8545"}` |
| backends.example-backend.enabled | Enable the backend | bool | `false` |
| backends.example-backend.extraConfig | Define additional configuration keys for the backend (see [proxyd config](https://github.com/ethereum-optimism/optimism/blob/5d309e6a6d5e1ef6a88c1ce827b7e6d47f033bbb/proxyd/example.config.toml#L47)) | object | `{}` |
Expand Down
2 changes: 1 addition & 1 deletion charts/proxyd/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## Introduction

[Proxyd](https://github.com/ethereum-optimism/optimism/tree/develop/proxyd) is an EVM-blockchain JSON-RPC router and load balancer developed in Go by [Optimism](https://www.optimism.io/). It is capable of load balancing, automatic failover, intelligent request routing and very basic caching.
[Proxyd](https://github.com/ethereum-optimism/infra/tree/main/proxyd) is an EVM-blockchain JSON-RPC router and load balancer developed in Go by [Optimism](https://www.optimism.io/). It is capable of load balancing, automatic failover, intelligent request routing and very basic caching.

## Chart Features

Expand Down
2 changes: 1 addition & 1 deletion charts/proxyd/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ backends:

# -- Options for backend groups
backendGroups:
# -- Set the routing strategy (consensus_aware | multicall | fallback)
# -- Set the routing strategy (consensus_aware \| multicall \| fallback)
routing_strategy: consensus_aware

# -- Mapping JSON-RPC method name to a particular group of backends (method_name -> group_name)
Expand Down

0 comments on commit 62b012a

Please sign in to comment.