Skip to content

Commit

Permalink
fix: Hide test related CLI flags
Browse files Browse the repository at this point in the history
* Fix install script link in docs

Signed-off-by: Mahendra Paipuri <[email protected]>
  • Loading branch information
mahendrapaipuri committed Oct 2, 2024
1 parent 5964d3d commit 3e788e5
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion pkg/api/cli/cli.go
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ func (b *CEEMSServer) Main() error {
dropPrivs = b.App.Flag(
"security.drop-privileges",
"Drop privileges and run as nobody when exporter is started as root.",
).Default("true").Bool()
).Default("true").Hidden().Bool()
)

// Socket activation only available on Linux
Expand Down
2 changes: 1 addition & 1 deletion pkg/collector/cli.go
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ func (b *CEEMSExporter) Main() error {
dropPrivs = b.App.Flag(
"security.drop-privileges",
"Drop privileges and run as nobody when exporter is started as root.",
).Default("true").Bool()
).Default("true").Hidden().Bool()
)

// Socket activation only available on Linux
Expand Down
2 changes: 1 addition & 1 deletion pkg/lb/cli/cli.go
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ func (lb *CEEMSLoadBalancer) Main() error {
dropPrivs = lb.App.Flag(
"security.drop-privileges",
"Drop privileges and run as nobody when exporter is started as root.",
).Default("true").Bool()
).Default("true").Hidden().Bool()
)

// Socket activation only available on Linux
Expand Down
26 changes: 13 additions & 13 deletions website/docs/installation/pre-compiled-binaries.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,48 +4,48 @@ sidebar_position: 2

# Installing from Pre-compiled binaries

Pre-compiled binaries for various architectures are distributed in the
Pre-compiled binaries for various architectures are distributed in the
[GitHub releases page](https://github.com/mahendrapaipuri/ceems/releases).

## Bash script

A bash script is provided to install the CEEMS components using a single command

```
curl -sfL https://github.com/mahendrapaipuri/ceems/blob/main/scripts/install.sh | PREFIX=/usr/local bash -s
```bash
curl -sfL https://raw.githubusercontent.com/mahendrapaipuri/ceems/refs/heads/main/scripts/install.sh | PREFIX=/usr/local bash -s
```

The above command will install the latest version of all CEEMS components in
`/usr/local/bin` and config files in `/usr/local/etc`.
The above command will install the latest version of all CEEMS components in
`/usr/local/bin` and config files in `/usr/local/etc`.

- If specific version is desired, use environment variable `VERSION` to specify the version.
- If only certain components are desired, use environment variable `APPS` to specify the
components delimited by space. For instance, if `ceems_api_server` and `ceems_lb` are
- If only certain components are desired, use environment variable `APPS` to specify the
components delimited by space. For instance, if `ceems_api_server` and `ceems_lb` are
needed, set `APPS="ceems_api_server ceems_lb"` to the installation command.

## Go install

The binaries can be installed using `go install` command provided that `go >= 1.21.x`
is available on ths host. For instance, the latest version of `ceems_exporter` can
The binaries can be installed using `go install` command provided that `go >= 1.21.x`
is available on ths host. For instance, the latest version of `ceems_exporter` can
be installed as follows:

```
```bash
go install github.com/mahendrapaipuri/ceems/cmd/ceems_exporter@latest
```

Similarly, to install `ceems_api_server` or `ceems_lb`, the command will be

```
```bash
go install github.com/mahendrapaipuri/ceems/cmd/{ceems_api_server,ceems_lb}@latest
```

## Manual install

The binaries can be manually downloaded and installed to desired location.

```
```bash
wget https://github.com/mahendrapaipuri/ceems/releases/download/v0.1.0/ceems-0.1.0.linux-amd64.tar.gz
```

The above command will download the `0.1.0` version of CEEMS components and they
The above command will download the `0.1.0` version of CEEMS components and they
can be extracted and installed to desired location.

0 comments on commit 3e788e5

Please sign in to comment.