Merge pull request #311 from rkruze/admin-api-docs-move

config: Move api docs from /etc/redpanda to /usr/share/redpanda
redpanda-data · Dec 21, 2020 · c2c8599 · c2c8599
2 parents be35da8 + 5944c25
commit c2c8599
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 13 deletions.
diff --git a/conf/pandaproxy.yaml b/conf/pandaproxy.yaml
@@ -23,8 +23,8 @@ pandaproxy:
  address: "0.0.0.0"
  port: 9645
 
- admin_api_doc_dir: /etc/pandaproxy/admin-api-doc
- api_doc_dir: /etc/pandaproxy/api-doc
+ admin_api_doc_dir: /usr/share/pandaproxy/admin-api-doc
+ api_doc_dir: /usr/share/pandaproxy/api-doc
 
 pandaproxy_client:
  # kafka-api compatible brokers

diff --git a/docs/www/advanced-configuration.md b/docs/www/advanced-configuration.md
@@ -211,8 +211,8 @@ redpanda:
  enable_admin_api: true
 
  # Admin API doc directory.
- # Default: /etc/redpanda/admin-api-doc
- admin_api_doc_dir: "/etc/redpanda/admin-api-doc"
+ # Default: /usr/share/redpanda/admin-api-doc
+ admin_api_doc_dir: "/usr/share/redpanda/admin-api-doc"
 
  # Default number of quota tracking windows.
  # Default: 10

diff --git a/src/go/rpk/pkg/config/config_test.go b/src/go/rpk/pkg/config/config_test.go
@@ -500,7 +500,7 @@ redpanda:
  admin:
  address: 0.0.0.0
  port: 9644
- admin_api_doc_dir: /etc/redpanda/doc
+ admin_api_doc_dir: /usr/share/redpanda/admin-api-doc
  data_directory: /var/lib/redpanda/data
  default_window_sec: 100
  kafka_api:
@@ -530,7 +530,7 @@ redpanda:
  admin:
  address: 0.0.0.0
  port: 9644
- admin_api_doc_dir: /etc/redpanda/doc
+ admin_api_doc_dir: /usr/share/redpanda/admin-api-doc
  data_directory: /var/lib/redpanda/data
  default_window_sec: 100
  developer_mode: false
@@ -580,7 +580,7 @@ redpanda:
  admin:
  address: 0.0.0.0
  port: 9644
- admin_api_doc_dir: /etc/redpanda/doc
+ admin_api_doc_dir: /usr/share/redpanda/admin-api-doc
  auto_create_topics_enabled: true
  data_directory: /var/lib/redpanda/data
  default_window_sec: 100
@@ -605,7 +605,7 @@ redpanda:
  admin:
  address: 0.0.0.0
  port: 9644
- admin_api_doc_dir: /etc/redpanda/doc
+ admin_api_doc_dir: /usr/share/redpanda/admin-api-doc
  auto_create_topics_enabled: true
  data_directory: /different/path
  default_window_sec: 100

diff --git a/src/v/config/configuration.cc b/src/v/config/configuration.cc
@@ -135,7 +135,7 @@ configuration::configuration()
  "admin_api_doc_dir",
  "Admin API doc directory",
  required::no,
- "/etc/redpanda/admin-api-doc")
+ "/usr/share/redpanda/admin-api-doc")
  , default_num_windows(
  *this,
  "default_num_windows",

diff --git a/src/v/pandaproxy/configuration.cc b/src/v/pandaproxy/configuration.cc
@@ -45,13 +45,13 @@ configuration::configuration()
  "admin_api_doc_dir",
  "Admin API doc directory",
  config::required::no,
- "/etc/pandaproxy/admin-api-doc")
+ "/usr/share/pandaproxy/admin-api-doc")
  , api_doc_dir(
  *this,
  "api_doc_dir",
  "API doc directory",
  config::required::no,
- "/etc/pandaproxy/api-doc")
+ "/usr/share/pandaproxy/api-doc")
  , disable_metrics(
  *this,
  "disable_metrics",

diff --git a/tests/rptest/services/templates/pandaproxy.yaml b/tests/rptest/services/templates/pandaproxy.yaml
@@ -25,8 +25,8 @@ pandaproxy:
  address: "0.0.0.0"
  port: 9645
 
- admin_api_doc_dir: {{root}}/etc/pandaproxy/admin-api-doc
- api_doc_dir: {{root}}/etc/pandaproxy/api-doc
+ admin_api_doc_dir: {{root}}/usr/share/pandaproxy/admin-api-doc
+ api_doc_dir: {{root}}/usr/share/pandaproxy/api-doc
  retries: 10
  retry_base_backoff_ms: 10