From faac032220602ba033e5eea348e22dd369ea5c84 Mon Sep 17 00:00:00 2001 From: Rajakavitha Kodhandapani Date: Thu, 18 Jul 2024 19:44:15 +0530 Subject: [PATCH] [Docs] Dgraph CLI Reference (#630) Remove references to raft migrate in the CLI. Fixes: https://github.com/dgraph-io/dgraph-docs/issues/600 Description: Please include the following in your PR description: 1. A brief, clear description of the change. 2. Link to any related PRs or discuss.dgraph.io posts. 3. If this PR corresponds to a JIRA issue, include "Fixes DOC-###" in the PR description. 3. If this is a breaking change, please put "[Breaking]" in the title. In the description, please put a note with exactly who these changes are breaking for. 4. If you are creating a PR in `main` and you know it needs to be cherry-picked to a release branch, please mention that in your PR description (for example: "cherry-pick to v20.07"). Cherry-pick PRs should reference the original PR. Note: Create and edit docs in the `main` branch when you can, so that we only cherry-pick out of `main`, not into `main`. --> --- content/deploy/cli-command-reference.md | 35 +++---------------------- 1 file changed, 4 insertions(+), 31 deletions(-) diff --git a/content/deploy/cli-command-reference.md b/content/deploy/cli-command-reference.md index 4d8c7045..7895198a 100644 --- a/content/deploy/cli-command-reference.md +++ b/content/deploy/cli-command-reference.md @@ -40,8 +40,8 @@ The general syntax for superflags is as follows: `-- option-a=v {{% notice "note" %}} You should encapsulate the options for a superflag in double-quotes (`"`) if any -of those option values include spaces. You can also encapsulate options in -double-quotes to improve readability. So, you can also use the following +of those option values include spaces. You can encapsulate options in +double-quotes to improve readability. You can also use the following syntax for superflags: `-- "option-a=value; option-b=value"`. {{% /notice %}} @@ -228,7 +228,7 @@ The commands in these groups are shown in the following table: | Dgraph debug | [`debuginfo`](#dgraph-debuginfo) | Generates information about the current node for use in debugging issues with Dgraph clusters | | Dgraph tools | [`completion`](#dgraph-completion) | Generates shell completion scripts for `bash` and `zsh` | | Dgraph tools | [`conv`](#dgraph-conv) | Converts geographic files into RDF so that they can be consumed by Dgraph | -| Dgraph tools | [`decrypt`](#dgraph-decrypt) | Decrypts an export file created by an encrypted Dgraph cluster | +| Dgraph tools | [`decrypt`](#dgraph-decrypt) | Decrypts an export file created by an encrypted Dgraph Cluster | | Dgraph tools | [`export_backup`](#dgraph-export_backup) | Converts a binary backup created using Dgraph Enterprise Edition into an exported folder. | | Dgraph tools | [`increment`](#dgraph-increment) | Increments a counter transactionally to confirm that a Dgraph Alpha node can handle query and mutation requests | | Dgraph tools | [`lsbackup`](#dgraph-lsbackup) | Lists information on backups in a given location | @@ -928,7 +928,7 @@ Use "dgraph conv [command] --help" for more information about a command. #### `dgraph decrypt` This command lets you decrypt an export file created by an encrypted Dgraph -cluster. The following replicates the help listing shown when you run +Cluster. The following replicates the help listing shown when you run `dgraph decrypt --help`: ```shell @@ -1079,33 +1079,6 @@ Flags: Use "dgraph migrate [command] --help" for more information about a command. ``` -#### `dgraph raftmigrate` - -This command runs the Dgraph Raft migration tool. -The following replicates the help listing shown when you run `dgraph raftmigrate --help`: - -```shell -Run the Raft migration tool -Usage: - dgraph raftmigrate [flags] - -Flags: - --encryption_key_file string The file that stores the symmetric key of length 16, 24, or 32 bytes. The key size determines the chosen AES cipher (AES-128, AES-192, and AES-256 respectively). Enterprise feature. - -h, --help help for raftmigrate - --new-dir string Path to the new (z)w directory. - --old-dir string Path to the old (z)w directory. - --vault string Vault options - addr=http://localhost:8200; Vault server address in the form of http://ip:port - field=enc_key; Vault kv store field whose value is the base64 encoded encryption key. - format=base64; Vault field format: raw or base64. - path=secret/data/dgraph; Vault kv store path. e.g. secret/data/dgraph for kv-v2, kv/dgraph for kv-v1. - role-id-file=; File containing Vault role-id used for approle auth. - secret-id-file=; File containing Vault secret-id used for approle auth. - (default "addr=http://localhost:8200; path=secret/data/dgraph; field=enc_key; format=base64; role-id-file=; secret-id-file=;") - -Use "dgraph raftmigrate [command] --help" for more information about a command. -``` - #### `dgraph upgrade` This command helps you to upgrade from an earlier Dgraph release to a newer release.