Skip to content

Commit 7154025

Browse files
VinozzZVinozzZ
authored
fix: unpublish OpAMP configs (#1707)
## Which problem is this PR solving? All opamp configs should not be published for public use since it's internal use only ## Short description of the changes - marks opamp configs as `unpublished` - re-generate docs
1 parent 4172aa5 commit 7154025

File tree

7 files changed

+8
-136
lines changed

7 files changed

+8
-136
lines changed

‎config.md‎

Lines changed: 1 addition & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# Honeycomb Refinery Configuration Documentation
44

55
This is the documentation for the configuration file for Honeycomb's Refinery.
6-
It was automatically generated on 2025-10-01 at 18:54:38 UTC.
6+
It was automatically generated on 2025-10-02 at 19:03:23 UTC.
77

88
## The Config file
99

@@ -158,41 +158,6 @@ OpAMP support is an experimental feature, subject to breaking changes at any tim
158158
Not intended or supported for customer use.
159159
**FOR INTERNAL USE ONLY**
160160

161-
### `Enabled`
162-
163-
Enabled controls whether to enable OpAMP support.
164-
165-
OpAMP support is an experimental feature, subject to breaking changes at any time.
166-
Not intended or supported for customer use.
167-
**FOR INTERNAL USE ONLY**
168-
169-
- Not eligible for live reload.
170-
- Type: `bool`
171-
172-
### `RecordUsage`
173-
174-
RecordUsage controls whether to record usage metrics.
175-
176-
OpAMP support is an experimental feature, subject to breaking changes at any time.
177-
Not intended or supported for customer use.
178-
**FOR INTERNAL USE ONLY**
179-
180-
- Eligible for live reload.
181-
- Type: `bool`
182-
- Default: `true`
183-
184-
### `Endpoint`
185-
186-
Endpoint is the URL of the OpAMP server for this client.
187-
188-
OpAMP support is an experimental feature, subject to breaking changes at any time.
189-
Not intended or supported for customer use.
190-
**FOR INTERNAL USE ONLY**
191-
192-
- Not eligible for live reload.
193-
- Type: `string`
194-
- Default: `wss://127.0.0.1:4320/v1/opamp`
195-
196161
## Access Key Configuration
197162

198163
`AccessKeys` contains access keys -- API keys that the proxy will treat specially, and other flags that control how the proxy handles API keys.

‎config/metadata/configMeta.yaml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,7 @@ groups:
154154
valuetype: nondefault
155155
default: false
156156
reload: false
157+
unpublished: true
157158
firstversion: v2.9.4
158159
summary: controls whether to enable OpAMP support.
159160
description: >
@@ -163,6 +164,7 @@ groups:
163164
type: defaulttrue
164165
valuetype: nondefault
165166
default: true
167+
unpublished: true
166168
reload: true
167169
firstversion: v2.9.4
168170
summary: controls whether to record usage metrics.
@@ -173,6 +175,7 @@ groups:
173175
type: string
174176
valuetype: assigndefault
175177
default: "wss://127.0.0.1:4320/v1/opamp"
178+
unpublished: true
176179
reload: false
177180
firstversion: v2.9.4
178181
summary: is the URL of the OpAMP server for this client.

‎config_complete.yaml‎

Lines changed: 1 addition & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Honeycomb Refinery Configuration ##
33
######################################
44
#
5-
# created on 2025-10-01 at 18:54:38 UTC from ../../config.yaml using a template generated on 2025-10-01 at 18:54:36 UTC
5+
# created on 2025-10-02 at 19:03:22 UTC from ../../config.yaml using a template generated on 2025-10-02 at 19:03:19 UTC
66

77
# This file contains a configuration for the Honeycomb Refinery. It is in YAML
88
# format, organized into named groups, each of which contains a set of
@@ -136,35 +136,6 @@ OpAMP:
136136
## intended or supported for customer use. **FOR INTERNAL USE ONLY**
137137
##
138138
####
139-
## Enabled controls whether to enable OpAMP support.
140-
##
141-
## OpAMP support is an experimental feature, subject to breaking changes
142-
## at any time. Not intended or supported for customer use. **FOR
143-
## INTERNAL USE ONLY**
144-
##
145-
## Not eligible for live reload.
146-
# Enabled: false
147-
148-
## RecordUsage controls whether to record usage metrics.
149-
##
150-
## OpAMP support is an experimental feature, subject to breaking changes
151-
## at any time. Not intended or supported for customer use. **FOR
152-
## INTERNAL USE ONLY**
153-
##
154-
## default: true
155-
## Eligible for live reload.
156-
# RecordUsage: true
157-
158-
## Endpoint is the URL of the OpAMP server for this client.
159-
##
160-
## OpAMP support is an experimental feature, subject to breaking changes
161-
## at any time. Not intended or supported for customer use. **FOR
162-
## INTERNAL USE ONLY**
163-
##
164-
## default: wss://127.0.0.1:4320/v1/opamp
165-
## Not eligible for live reload.
166-
Endpoint: wss://127.0.0.1:4320/v1/opamp
167-
168139
##############################
169140
## Access Key Configuration ##
170141
##############################

‎refinery_config.md‎

Lines changed: 0 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -135,41 +135,6 @@ OpAMP support is an experimental feature, subject to breaking changes at any tim
135135
Not intended or supported for customer use.
136136
**FOR INTERNAL USE ONLY**
137137

138-
### `Enabled`
139-
140-
`Enabled` controls whether to enable OpAMP support.
141-
142-
OpAMP support is an experimental feature, subject to breaking changes at any time.
143-
Not intended or supported for customer use.
144-
**FOR INTERNAL USE ONLY**
145-
146-
- Not eligible for live reload.
147-
- Type: `bool`
148-
149-
### `RecordUsage`
150-
151-
`RecordUsage` controls whether to record usage metrics.
152-
153-
OpAMP support is an experimental feature, subject to breaking changes at any time.
154-
Not intended or supported for customer use.
155-
**FOR INTERNAL USE ONLY**
156-
157-
- Eligible for live reload.
158-
- Type: `defaulttrue`
159-
- Default: `true`
160-
161-
### `Endpoint`
162-
163-
`Endpoint` is the URL of the OpAMP server for this client.
164-
165-
OpAMP support is an experimental feature, subject to breaking changes at any time.
166-
Not intended or supported for customer use.
167-
**FOR INTERNAL USE ONLY**
168-
169-
- Not eligible for live reload.
170-
- Type: `string`
171-
- Default: `wss://127.0.0.1:4320/v1/opamp`
172-
173138
## Access Key Configuration
174139

175140
`AccessKeys` contains access keys -- API keys that the proxy will treat specially, and other flags that control how the proxy handles API keys.

‎tools/convert/configDataNames.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Names of groups and fields in the new config file format.
2-
# Automatically generated on 2025-10-01 at 18:54:37 UTC.
2+
# Automatically generated on 2025-10-02 at 19:03:20 UTC.
33

44
General:
55
- ConfigurationVersion

‎tools/convert/minimal_config.yaml‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# sample uncommented config file containing all possible fields
2-
# automatically generated on 2025-10-01 at 18:54:37 UTC
2+
# automatically generated on 2025-10-02 at 19:03:20 UTC
33
General:
44
ConfigurationVersion: 2
55
MinRefineryVersion: "v2.0"
@@ -11,9 +11,6 @@ Network:
1111
HTTPIdleTimeout: 0s
1212
HoneycombAPI: "https://api.honeycomb.io"
1313
OpAMP:
14-
Enabled: false
15-
RecordUsage: true
16-
Endpoint: "wss://127.0.0.1:4320/v1/opamp"
1714
AccessKeys:
1815
ReceiveKeys:
1916
- "your-key-goes-here"

‎tools/convert/templates/configV2.tmpl‎

Lines changed: 1 addition & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Honeycomb Refinery Configuration ##
33
######################################
44
#
5-
# created {{ now }} from {{ .Input }} using a template generated on 2025-10-01 at 18:54:36 UTC
5+
# created {{ now }} from {{ .Input }} using a template generated on 2025-10-02 at 19:03:19 UTC
66

77
# This file contains a configuration for the Honeycomb Refinery. It is in YAML
88
# format, organized into named groups, each of which contains a set of
@@ -136,35 +136,6 @@ OpAMP:
136136
## intended or supported for customer use. **FOR INTERNAL USE ONLY**
137137
##
138138
####
139-
## Enabled controls whether to enable OpAMP support.
140-
##
141-
## OpAMP support is an experimental feature, subject to breaking changes
142-
## at any time. Not intended or supported for customer use. **FOR
143-
## INTERNAL USE ONLY**
144-
##
145-
## Not eligible for live reload.
146-
{{ nonDefaultOnly .Data "Enabled" "Enabled" false }}
147-
148-
## RecordUsage controls whether to record usage metrics.
149-
##
150-
## OpAMP support is an experimental feature, subject to breaking changes
151-
## at any time. Not intended or supported for customer use. **FOR
152-
## INTERNAL USE ONLY**
153-
##
154-
## default: true
155-
## Eligible for live reload.
156-
{{ nonDefaultOnly .Data "RecordUsage" "RecordUsage" true }}
157-
158-
## Endpoint is the URL of the OpAMP server for this client.
159-
##
160-
## OpAMP support is an experimental feature, subject to breaking changes
161-
## at any time. Not intended or supported for customer use. **FOR
162-
## INTERNAL USE ONLY**
163-
##
164-
## default: wss://127.0.0.1:4320/v1/opamp
165-
## Not eligible for live reload.
166-
Endpoint: wss://127.0.0.1:4320/v1/opamp
167-
168139
##############################
169140
## Access Key Configuration ##
170141
##############################

0 commit comments

Comments
 (0)