Skip to content

Commit

Permalink
Update docs to reflect changes from the vale v3 migration
Browse files Browse the repository at this point in the history
  • Loading branch information
@mostafa
mostafa committed Oct 9, 2024
1 parent 57ef1ba commit 5e64dbb
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 14 deletions.
20 changes: 10 additions & 10 deletions getting-started/installation.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
last_modified_date: 2024-05-31 20:16:38
last_modified_date: 2024-10-09 09:38:22
layout: default
title: Installation
description: How to install GatewayD and its plugins on different platforms and how to build it from source.
Expand Down Expand Up @@ -142,22 +142,22 @@ docker-compose down

Plugins are available as standalone binaries for different platforms. These binaries are available in their GitHub repositories and are distributed as archives that contain the binary and the default configuration file for the plugin. The README file and the LICENSE file might also be included in the archive.

There are currently four ways to install plugins using the `gatewayd plugin install` subcommand:
You can install plugins using the `gatewayd plugin install` subcommand in four ways:

1. Providing the plugins configuration file with the plugins' URLs and versions.
2. Using the GitHub URL of the plugin plus the version.
3. Using the already downloaded archive of the plugin.
4. Manually downloading, extracting and placing the plugins' binaries in your desired location and updating the plugins configuration file.
1. Automatic: Providing the plugins configuration file with the plugins' URLs and versions and running the subcommand with no flags.
2. GitHub URL: Passing the GitHub URL of the plugin plus the version to the subcommand.
3. Local archive: Passing the already downloaded archive of the plugin to the subcommand.
4. Manual: Manually downloading, extracting and placing the plugins' binaries in your desired location and updating the plugins configuration file.

### 1. Using the plugins configuration file
### 1. Automatic installation

In the `gatewayd_plugins.yaml` configuration file, you can specify the URLs and versions of the plugins that you want to install. The `gatewayd plugin install` subcommand will download the archives of the plugins from the specified URLs and extract them to the `plugins` directory in the current working directory and will also update the `gatewayd_plugins.yaml` configuration file.

```bash
gatewayd plugin install
```

### 2. Using the GitHub URL of the plugin plus the version
### 2. GitHub URL installation

You can also install plugins using the GitHub URL of the plugin plus the version. The `gatewayd plugin install` subcommand will download the archive of the plugin from the specified URL and extract it to the `plugins` directory in the current working directory.

Expand All @@ -177,15 +177,15 @@ You can also specify that you want to pull only and you don't want to extract th
gatewayd plugin install --pull-only github.com/gatewayd-io/gatewayd-plugin-cache@latest
```

### 3. Using the already downloaded archive of the plugin
### 3. Local archive installation

You can also install plugins using the already downloaded archive of the plugin or using the `--pull-only` flag explained above. The `gatewayd plugin install` subcommand will extract the archive of the plugin to the `plugins` directory in the current working directory. The `--name` flag is mandatory when using this method and it must be the same as the name of the plugin.

```bash
gatewayd plugin install --name <plugin-name> <path-to-archive>
```

### 4. Manually downloading, extracting and placing the plugins' binaries in your desired location
### 4. Manual installation

You can manually download, extract and place the plugins' binaries in your desired location that is accessible to GatewayD via the plugins configuration file, aka. `gatewayd_plugins.yaml`. Then you must update the plugins configuration file with the desired plugin's configuration that is available in the plugin's repository as `gatewayd_plugin.yaml` (or inside the archive file of the plugin). Checksum files are also available in the plugin's repository as release assets and also inside the archive file of the plugin.

Expand Down
4 changes: 2 additions & 2 deletions using-gatewayd/API.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
last_modified_date: 2024-05-31 20:16:38
last_modified_date: 2024-10-09 09:33:30
layout: default
title: API
description: GatewayD exposes a gRPC API with an HTTP gateway for querying and managing the `gatewayd` process and its plugins.
Expand Down Expand Up @@ -38,7 +38,7 @@ The API exposes the following endpoints on the gRPC server and HTTP gateway:

## Liveness and Readiness

The gRPC server and the HTTP gateway exposes the health endpoints for liveness and readiness probes in containerized environments and kubernetes. All the probes return whether all the servers are running or not. The health check works both on the gRPC server and the HTTP server and can be tested using the following commands:
The gRPC server and the HTTP gateway exposes the health endpoints for liveness and readiness probes in containerized environments and Kubernetes. All the probes return whether all the servers are running or not. The health check works both on the gRPC server and the HTTP server and can be tested using the following commands:

```bash
# gRPC server
Expand Down
4 changes: 2 additions & 2 deletions using-gatewayd/CLI.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
last_modified_date: 2024-05-31 20:16:38
last_modified_date: 2024-10-09 09:34:09
layout: default
title: CLI
description: GatewayD is a CLI application that runs on Windows, Linux-based distributions and macOS.
Expand All @@ -23,7 +23,7 @@ GatewayD is a CLI application that runs on Windows, Linux-based distributions an
| `plugin install` | installs one or more plugins from:<br/>- CLI arguments (GitHub URL or a locally downloaded archive file)<br/>- the plugins configuration file | - `-p`, `--plugin-config`: plugins config file (default "gatewayd_plugins.yaml")<br/>- `-o`, `--output-dir`: output directory of the plugin, where the plugin is extracted (default "./plugins")<br/>- `-n`, `--name`: Name of the plugin (only for installing from archive files)<br/>- `--pull-only`: only pull the plugin, don't install it<br/>- `--cleanup`: Clean up the downloaded and extracted files after installing the plugin (except the plugin binary) (default `true`)<br/> - `--update`: Update the plugin if it already exists (default `false`)<br/>- `--backup`: Backup the plugins configuration file before installing the plugin (default `false`)<br/>- `--overwrite-config`: Overwrite the existing plugins configuration file (overrides `--update`, only used for installing from the plugins configuration file)<br/>- `--no-prompt`: Do not prompt for user input (default `true`)<br/>- `--skip-path-slip-verification`: Skip the path slip verification (default `false`). Use it only if you're using an absolute path for `--output-dir` in an isolated environment like Docker and you trust the source of the plugin<br/>- `--sentry`: Enable Sentry for error reporting (default `true`) |
| `plugin lint` | validates plugins configuration file | - `-p`, `--plugin-config`: plugins config file (default "gatewayd_plugins.yaml")<br/>- `--sentry`: Enable Sentry for error reporting (default `true`) |
| `plugin list` | lists all installed plugins | - `-p`, `--plugin-config`: plugins config file (default "gatewayd_plugins.yaml")<br/>- `-e`, `--only-enabled`: Only list enabled plugins<br/>- `--sentry`: Enable Sentry for error reporting (default `true`) |
| `plugin scaffold` | generates a plugin scaffold for plugin development and stores the files into a directory | - `-i`, `--input-file`: plugin scaffold input file (default "input.yaml")<br/>- `-o`, `--output-dir`: utput directory for the scaffold (default "./plugins") |
| `plugin scaffold` | generates a plugin scaffold for plugin development and stores the files into a directory | - `-i`, `--input-file`: plugin scaffold input file (default "input.yaml")<br/>- `-o`, `--output-dir`: output directory for the scaffold (default "./plugins") |
| `run` | runs an instance of `gatewayd` with the specified configuration files | - `-c`, `--config`: global config file (default `"gatewayd.yaml"`)<br/>- `-p`, `--plugin-config`: plugin config file (default `"gatewayd_plugins.yaml"`)<br/>- `--tracing`: Enable tracing with OpenTelemetry via gRPC<br/>- `--collector-url string`: Collector URL of OpenTelemetry gRPC endpoint (default `"localhost:4317"`)<br/>- `--sentry`: Enable Sentry for error reporting (default `true`)<br/>- `--lint`: Enable linting of configuration files (default `true`)<br/>- `--dev`: Enable development mode for plugin development<br/>- `--usage-report`: Enable usage report (default `true`) |
| `version` | shows version information | `GatewayD v0.6.0 (2023-03-12T22:22:55+0000/ae469dc, go1.20.1, linux/amd64)` |

Expand Down

0 comments on commit 5e64dbb

Please sign in to comment.