Skip to content

Commit b3e662c

Browse files
authored
minor lint update for README.md (#727)
1 parent a0fb06f commit b3e662c

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Replicated Troubleshoot
22

3-
[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B5995%2Fgithub.com%2Freplicatedhq%2Ftroubleshoot.svg?type=small)](https://app.fossa.com/projects/custom%2B5995%2Fgithub.com%2Freplicatedhq%2Ftroubleshoot?ref=badge_small)
4-
53
Replicated Troubleshoot is a framework for collecting, redacting, and analyzing highly customizable diagnostic information about a Kubernetes cluster. Troubleshoot specs are created by 3rd-party application developers/maintainers and run by cluster operators in the initial and ongoing operation of those applications.
64

75
Troubleshoot provides two CLI tools as kubectl plugins (using [Krew](https://krew.dev)): `kubectl preflight` and `kubectl support-bundle`. Preflight provides pre-installation cluster conformance testing and validation (preflight checks) and support-bundle provides post-installation troubleshooting and diagnostics (support bundles).
@@ -11,12 +9,12 @@ Preflight checks are an easy-to-run set of conformance tests that can be written
119

1210
To run a sample preflight check from a sample application, install the preflight kubectl plugin:
1311

14-
```shell
12+
```
1513
curl https://krew.sh/preflight | bash
1614
```
1715
and run:
1816

19-
```shell
17+
```
2018
kubectl preflight https://preflight.replicated.com
2119
```
2220

@@ -28,12 +26,12 @@ A support bundle is an archive that's created in-cluster, by collecting logs and
2826

2927
To collect a sample support bundle, install the troubleshoot kubectl plugin:
3028

31-
```shell
29+
```
3230
curl https://krew.sh/support-bundle | bash
3331
```
3432
and run:
3533

36-
```shell
34+
```
3735
kubectl support-bundle https://support-bundle.replicated.com
3836
```
3937
For more details on creating the custom resource files that drive support-bundle collection, visit [creating collectors](https://troubleshoot.sh/docs/collect/) and [creating analyzers](https://troubleshoot.sh/docs/analyze/).
@@ -50,7 +48,7 @@ A signed SBOM that includes Troubleshoot dependencies is included in each relea
5048

5149
The following example illustrates using [cosign](https://github.com/sigstore/cosign) to verify that **troubleshoot-sbom.tgz** has
5250
not been tampered with.
53-
```shell
51+
```
5452
$ cosign verify-blob -key key.pub -signature troubleshoot-sbom.tgz.sig troubleshoot-sbom.tgz
5553
Verified OK
5654
```

0 commit comments

Comments
 (0)