Skip to content

Commit 1495214

Browse files
committed
updates to udpateable specs design
1 parent e75a3a0 commit 1495214

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

design/proposal-updateable-specs.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,13 @@ It is also difficult to justify the tight coupling of Troubleshoot configuration
1818

1919
## High-Level Design
2020

21-
Add a new field to the Troubleshoot spec definition, which includes a URI used to locate the current spec online.
21+
Add a new field to the Troubleshoot spec definition, which includes a URI used to locate additional specs.
2222

23-
If the field is populated, Troubleshoot is to attempt to download the additional spec(s) from the source online, and add to the spec already provided.
23+
If the field is populated, Troubleshoot is to attempt to collect the additional spec(s) from the location provided, and add to the spec already provided.
2424

25-
Add a CLI flag to prevent any attmept to download, for use in airgap environments and/or when we simply do not want to download.
25+
If the additional spec is not found at the location (or, if there is no network access to that location), Troubleshoot is to continue processing the remainder of the spec provided, with a log message describing the failure.
26+
27+
Add a CLI flag to disable the URI specified locations from being accessed. This would be useful in airgap environments and/or when we simply do not want to have additional specs used, without having to update the yaml, secret or remote source.
2628

2729
Update the [default spec included with kots](https://github.com/replicatedhq/kots/blob/main/pkg/supportbundle/defaultspec/spec.yaml) to include a URI pointing at [the troubleshoot-specs repo](https://raw.githubusercontent.com/replicatedhq/troubleshoot-specs/main/in-cluster/default.yaml).
2830

@@ -66,7 +68,7 @@ spec:
6668

6769
## Impact on kURL and kots
6870

69-
For kURL, each component/addon installed could include adding a URI pointing at a specific spec that
71+
For kURL, each component/addon installed could include adding a URI pointing at a specific spec for that component, which could be updated independently of other components.
7072

7173
## Limitations
7274

0 commit comments

Comments
 (0)