This repository has been archived by the owner on Sep 30, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Docs: update docs for src validate
command to add new kube
subcommand
#46794
Merged
Merged
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# `src validate` | ||
|
||
## Subcommands | ||
|
||
|
||
* [`install`](install.md) | ||
* [`kube`](kube.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# `src validate install` | ||
|
||
|
||
## Flags | ||
|
||
| Name | Description | Default Value | | ||
|------|-------------|---------------| | ||
| `-dump-requests` | Log GraphQL requests and responses to stdout | `false` | | ||
| `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | `false` | | ||
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` | | ||
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` | | ||
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` | | ||
|
||
## Usage | ||
|
||
``` | ||
Usage of 'src validate install': | ||
-dump-requests | ||
Log GraphQL requests and responses to stdout | ||
-get-curl | ||
Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | ||
-insecure-skip-verify | ||
Skip validation of TLS certificates against trusted chains | ||
-trace | ||
Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | ||
-user-agent-telemetry | ||
Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default true) | ||
'src validate install' is a tool that validates a Sourcegraph installation. | ||
|
||
Examples: | ||
|
||
Run default checks: | ||
|
||
$ src validate install | ||
|
||
Provide a YAML configuration file: | ||
|
||
$ src validate install config.yml | ||
|
||
Provide a JSON configuration file: | ||
|
||
$ src validate install config.json | ||
|
||
Environmental variables | ||
|
||
SRC_GITHUB_TOKEN GitHub access token for validation features | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# `src validate kube` | ||
|
||
|
||
## Flags | ||
|
||
| Name | Description | Default Value | | ||
|------|-------------|---------------| | ||
| `-kubeconfig` | Absolute path to the kubeconfig file | `~/.kube/config` | | ||
| `-namespace` | Specify the Kubernetes namespace to use | `default` | | ||
| `-quiet` | Suppress output and return exit status only | `false` | | ||
|
||
|
||
## Usage | ||
|
||
``` | ||
Usage of 'src validate kube': | ||
-kubeconfig string | ||
(optional) absolute path to the kubeconfig file (default "~/.kube/config") | ||
-namespace string | ||
(optional) specify the kubernetes namespace to use | ||
-quiet | ||
(optional) suppress output and return exit status only | ||
'src validate kube' is a tool that validates a Kubernetes based Sourcegraph deployment | ||
|
||
Examples: | ||
|
||
Run default deployment validation: | ||
$ src validate kube | ||
|
||
Specify Kubernetes namespace: | ||
$ src validate kube --namespace sourcegraph | ||
|
||
Specify the kubeconfig file location: | ||
$ src validate kube --kubeconfig ~/.kube/config | ||
|
||
Suppress output (useful for CI/CD pipelines) | ||
$ src validate kube --quiet | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.