Skip to content

Commit

Permalink
feat(docs): generate docs and support for overlays (#111)
Browse files Browse the repository at this point in the history
* feat(gen_helm_docs.sh): add support for generating documentation for charts in overlays directory to enhance documentation coverage

* feat(charts): update celestia-app version to 0.0.8 and update appVersion to v3.3.1
feat(charts): update celestia-node version to 0.11.5
feat(charts): add new overlay for celestia-node-arabica with initial README
feat(charts): add new overlay for celestia-node-mocha with initial README
  • Loading branch information
aWN4Y25pa2EK authored Feb 7, 2025
1 parent cad1891 commit 1013cf5
Show file tree
Hide file tree
Showing 5 changed files with 900 additions and 6 deletions.
10 changes: 5 additions & 5 deletions charts/celestia-app/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# celestia-app

![Version: 0.0.6](https://img.shields.io/badge/Version-0.0.6-informational?style=flat-square) ![AppVersion: v3.3.0](https://img.shields.io/badge/AppVersion-v3.3.0-informational?style=flat-square)
![Version: 0.0.8](https://img.shields.io/badge/Version-0.0.8-informational?style=flat-square) ![AppVersion: v3.3.1](https://img.shields.io/badge/AppVersion-v3.3.1-informational?style=flat-square)

Celestia App

Expand All @@ -20,7 +20,7 @@ Celestia App

| Repository | Name | Version |
|------------|------|---------|
| https://celestiaorg.github.io/helm-charts | common-celestia-app | 0.1.1 |
| https://celestiaorg.github.io/helm-charts | common-celestia-app | 0.1.2 |
| oci://registry-1.docker.io/bitnamicharts | common | 2.x.x |

## Values
Expand All @@ -37,9 +37,9 @@ Celestia App
| app.args[6] | string | `"--grpc.enable"` | |
| app.automountServiceAccountToken | bool | `false` | mount service account token in app pods |
| app.command | list | `["celestia-appd"]` | command for the celestia-app |
| app.config.apptoml | object | `{"api":{"address":"tcp://0.0.0.0:1317","enable":false,"enabled_unsafe_cors":false,"max_open_connections":1000,"rpc_max_body_bytes":1000000,"rpc_read_timeout":10,"rpc_write_timeout":0,"swagger":false},"app_db_backend":"","grpc":{"address":"0.0.0.0:9090","enable":false,"max_recv_msg_size":"10485760","max_send_msg_size":"2147483647"},"grpc_web":{"address":"0.0.0.0:9091","enable":false,"enable_unsafe_cors":false},"halt_height":0,"halt_time":0,"iavl_cache_size":781250,"iavl_disable_fastnode":false,"iavl_lazy_loading":false,"index_events":[],"inter_block_cache":true,"min_retain_blocks":0,"minimum_gas_prices":"0.1utia","pruning":"default","pruning_interval":"0","pruning_keep_recent":"0","rosetta":{"address":":8080","blockchain":"app","denom_to_suggest":"uatom","enable":false,"enable_fee_suggestion":false,"gas_to_suggest":"210000","network":"network","offline":false,"retries":"3"},"state_sync":{"enable":false,"snapshot_interval":"1500","snapshot_keep_recent":"2"},"store":{"streamers":[]},"streamers":{"file":{"fsync":"false","keys":["*"],"output_metadata":"true","prefix":"","stop_node_on_error":"true","write_dir":""}},"telemetry":{"enable_hostname":false,"enable_hostname_label":false,"enable_service_label":false,"enabled":false,"global_labels":[],"prometheus_retention_time":0,"service_name":""}}` | configuration for the celestia-app app.toml |
| app.config.clienttoml | object | `{"broadcast_mode":"sync","chain_id":"arabica-11","keyring_backend":"test","node":"tcp://localhost:26657","output":"text"}` | configuration for the celestia-app client.toml |
| app.config.configtoml | object | `{"config":"socket","consensus":{"create_empty_blocks":true,"create_empty_blocks_interval":"0s","double_sign_check_height":0,"only_internal_wal":"true","peer_gossip_sleep_duration":"100ms","peer_query_maj23_sleep_duration":"2s","skip_timeout_commit":false,"timeout_commit":"11s","timeout_precommit":"1s","timeout_precommit_delta":"500ms","timeout_prevote":"1s","timeout_prevote_delta":"500ms","timeout_propose":"10s","timeout_propose_delta":"500ms","wal_file":"data/cs.wal/wal"},"db_backend":"goleveldb","db_dir":"data","fast_sync":true,"fastsync":{"version":"v0"},"filter_peers":false,"genesis_file":"config/genesis.json","instrumentation":{"max_open_connections":3,"namespace":"cometbft","prometheus":false,"prometheus_listen_addr":":26660","pyroscope_profile_types":["cpu","alloc_objects","inuse_objects","goroutines","mutex_count","mutex_duration","block_count","block_duration"],"pyroscope_trace":false,"pyroscope_url":"","trace_pull_address":"","trace_push_batch_size":1000,"trace_push_config":"","trace_type":"noop","tracing_tables":"mempool_tx,mempool_peer_state,consensus_round_state,consensus_block_parts,consensus_block,consensus_vote"},"log_format":"plain","log_level":"info","mempool":{"broadcast":true,"cache_size":10000,"experimental_max_gossip_connections_to_non_persistent_peers":0,"experimental_max_gossip_connections_to_persistent_peers":0,"keep_invalid_txs_in_cache":false,"max_batch_bytes":0,"max_gossip_delay":"0s","max_tx_bytes":7897088,"max_txs_bytes":39485440,"recheck":true,"size":5000,"ttl_duration":"1m15s","ttl_num_blocks":5,"version":"v1","wal_dir":""},"moniker":"hc-cons-test-celestia-app-0","node_key_file":"keys/node_key.json","p2p":{"addr_book_file":"data/addrbook.json","addr_book_strict":true,"allow_duplicate_ip":false,"dial_timeout":"3s","external_address":"","flush_throttle_timeout":"100ms","handshake_timeout":"20s","laddr":"tcp://0.0.0.0:26656","max_num_inbound_peers":40,"max_num_outbound_peers":10,"max_packet_msg_payload_size":1024,"persistent_peers":"[email protected]:26656","persistent_peers_max_dial_period":"0s","pex":true,"private_peer_ids":"","recv_rate":5120000,"seed_mode":false,"seeds":"","send_rate":5120000,"unconditional_peer_ids":"","upnp":false},"priv_validator_key_file":"keys/priv_validator_key.json","priv_validator_laddr":"","priv_validator_state_file":"data/priv_validator_state.json","proxy_app":"tcp://127.0.0.1:26658","rpc":{"cors_allowed_headers":["Origin","Accept","Content-Type","X-Requested-With","X-Server-Time"],"cors_allowed_methods":["HEAD","GET","POST"],"cors_allowed_origins":[],"experimental_close_on_slow_client":false,"experimental_subscription_buffer_size":200,"experimental_websocket_write_buffer_size":200,"grpc_laddr":"","grpc_max_open_connections":900,"laddr":"tcp://127.0.0.1:26657","max_body_bytes":8388608,"max_header_bytes":1048576,"max_open_connections":900,"max_subscription_clients":100,"max_subscriptions_per_client":5,"pprof_laddr":"","timeout_broadcast_tx_commit":"50s","tls_cert_file":"","tls_key_file":"","unsafe":false},"statesync":{"chunk_fetchers":"4","chunk_request_timeout":"10s","discovery_time":"15s","enable":false,"rpc_servers":"","temp_dir":"","trust_hash":"","trust_height":0,"trust_period":"168h0m0s"},"storage":{"discard_abci_responses":true},"tx_index":{"indexer":"null","psql_conn":""}}` | configuration for the celestia-app config.toml |
| app.config.app | object | `{"api":{"address":"tcp://0.0.0.0:1317","enable":false,"enabled_unsafe_cors":false,"max_open_connections":1000,"rpc_max_body_bytes":1000000,"rpc_read_timeout":10,"rpc_write_timeout":0,"swagger":false},"app_db_backend":"","grpc":{"address":"0.0.0.0:9090","enable":false,"max_recv_msg_size":"20971520","max_send_msg_size":"2147483647"},"grpc_web":{"address":"0.0.0.0:9091","enable":false,"enable_unsafe_cors":false},"halt_height":0,"halt_time":0,"iavl_cache_size":781250,"iavl_disable_fastnode":false,"iavl_lazy_loading":false,"index_events":[],"inter_block_cache":true,"min_retain_blocks":0,"minimum_gas_prices":"0.1utia","pruning":"default","pruning_interval":"0","pruning_keep_recent":"0","rosetta":{"address":":8080","blockchain":"app","denom_to_suggest":"uatom","enable":false,"enable_fee_suggestion":false,"gas_to_suggest":210000,"network":"network","offline":false,"retries":3},"state_sync":{"enable":false,"snapshot_interval":1500,"snapshot_keep_recent":2},"store":{"streamers":[]},"streamers":{"file":{"fsync":"false","keys":["*"],"output_metadata":"true","prefix":"","stop_node_on_error":"true","write_dir":""}},"telemetry":{"enable_hostname":false,"enable_hostname_label":false,"enable_service_label":false,"enabled":false,"global_labels":[],"prometheus_retention_time":0,"service_name":""}}` | configuration for the celestia-app app.toml |
| app.config.client | object | `{"broadcast_mode":"sync","chain_id":"arabica-11","keyring_backend":"test","node":"tcp://localhost:26657","output":"text"}` | configuration for the celestia-app client.toml |
| app.config.config | object | `{"config":"socket","consensus":{"create_empty_blocks":true,"create_empty_blocks_interval":"0s","double_sign_check_height":0,"only_internal_wal":"true","peer_gossip_sleep_duration":"100ms","peer_query_maj23_sleep_duration":"2s","skip_timeout_commit":false,"timeout_commit":"11s","timeout_precommit":"1s","timeout_precommit_delta":"500ms","timeout_prevote":"1s","timeout_prevote_delta":"500ms","timeout_propose":"10s","timeout_propose_delta":"500ms","wal_file":"data/cs.wal/wal"},"db_backend":"goleveldb","db_dir":"data","fast_sync":true,"fastsync":{"version":"v0"},"filter_peers":false,"genesis_file":"config/genesis.json","instrumentation":{"max_open_connections":3,"namespace":"cometbft","prometheus":false,"prometheus_listen_addr":":26660","pyroscope_profile_types":["cpu","alloc_objects","inuse_objects","goroutines","mutex_count","mutex_duration","block_count","block_duration"],"pyroscope_trace":false,"pyroscope_url":"","trace_pull_address":"","trace_push_batch_size":1000,"trace_push_config":"","trace_type":"noop","tracing_tables":"mempool_tx,mempool_peer_state,consensus_round_state,consensus_block_parts,consensus_block,consensus_vote"},"log_format":"plain","log_level":"info","mempool":{"broadcast":true,"cache_size":10000,"experimental_max_gossip_connections_to_non_persistent_peers":0,"experimental_max_gossip_connections_to_persistent_peers":0,"keep_invalid_txs_in_cache":false,"max_batch_bytes":0,"max_gossip_delay":"0s","max_tx_bytes":7897088,"max_txs_bytes":39485440,"recheck":true,"size":5000,"ttl_duration":"1m15s","ttl_num_blocks":5,"version":"v1","wal_dir":""},"moniker":"hc-cons-test-celestia-app-0","node_key_file":"keys/node_key.json","p2p":{"addr_book_file":"data/addrbook.json","addr_book_strict":true,"allow_duplicate_ip":false,"dial_timeout":"3s","external_address":"","flush_throttle_timeout":"100ms","handshake_timeout":"20s","laddr":"tcp://0.0.0.0:26656","max_num_inbound_peers":40,"max_num_outbound_peers":10,"max_packet_msg_payload_size":1024,"persistent_peers":"[email protected]:26656","persistent_peers_max_dial_period":"0s","pex":true,"private_peer_ids":"","recv_rate":5120000,"seed_mode":false,"seeds":"","send_rate":5120000,"unconditional_peer_ids":"","upnp":false},"priv_validator_key_file":"keys/priv_validator_key.json","priv_validator_laddr":"","priv_validator_state_file":"data/priv_validator_state.json","proxy_app":"tcp://127.0.0.1:26658","rpc":{"cors_allowed_headers":["Origin","Accept","Content-Type","X-Requested-With","X-Server-Time"],"cors_allowed_methods":["HEAD","GET","POST"],"cors_allowed_origins":[],"experimental_close_on_slow_client":false,"experimental_subscription_buffer_size":200,"experimental_websocket_write_buffer_size":200,"grpc_laddr":"","grpc_max_open_connections":900,"laddr":"tcp://127.0.0.1:26657","max_body_bytes":8388608,"max_header_bytes":1048576,"max_open_connections":900,"max_subscription_clients":100,"max_subscriptions_per_client":5,"pprof_laddr":"","timeout_broadcast_tx_commit":"50s","tls_cert_file":"","tls_key_file":"","unsafe":false},"statesync":{"chunk_fetchers":"4","chunk_request_timeout":"10s","discovery_time":"15s","enable":false,"rpc_servers":"","temp_dir":"","trust_hash":"","trust_height":0,"trust_period":"168h0m0s"},"storage":{"discard_abci_responses":true},"tx_index":{"indexer":"null","psql_conn":""}}` | configuration for the celestia-app config.toml |
| app.configFiles.app.enabled | bool | `true` | |
| app.configFiles.app.mountPath | string | `"/home/celestia/config/app.toml"` | |
| app.configFiles.client.enabled | bool | `true` | |
Expand Down
2 changes: 1 addition & 1 deletion charts/celestia-node/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# celestia-node

![Version: 0.11.4](https://img.shields.io/badge/Version-0.11.4-informational?style=flat-square) ![AppVersion: v0.21.3](https://img.shields.io/badge/AppVersion-v0.21.3-informational?style=flat-square)
![Version: 0.11.5](https://img.shields.io/badge/Version-0.11.5-informational?style=flat-square) ![AppVersion: v0.21.3](https://img.shields.io/badge/AppVersion-v0.21.3-informational?style=flat-square)

Celestia Node

Expand Down
Loading

0 comments on commit 1013cf5

Please sign in to comment.