Backport of NET-4952 Add docs for export command into release/1.16.x (#18449)
* backport of commit d6d0450665659f172360d4daebc3103777e6c8a9 * backport of commit 39feb999f1dd5327ff2d3c9f425a58f4d6ec51bb * backport of commit 8b1398a9b1b80bc2491f55f4fcc4ed028c2f6590 * backport of commit 47b9c12a044f37649c906a9b6acf85d6e3055f56 * backport of commit db8d974cf156e4374307ac4a990373ec2bfd0d8d * backport of commit f64e808d5bac95257e1162475ee2bcf9c855060c * backport of commit 6b6dbb4f74fc49171b830c84138d2efd14656d52 * backport of commit 2e34721547ddc39162456e182fac7b611197a4f5 * backport of commit 2d52b0ca24bcfbbf747b8f1b6693660b03cbd3a9 --------- Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com>
This commit is contained in:
parent
9f315da84b
commit
247fdc1f3d
|
@ -0,0 +1,64 @@
|
||||||
|
---
|
||||||
|
layout: commands
|
||||||
|
page_title: 'Commands: Services Export'
|
||||||
|
description: |
|
||||||
|
The `consul services export` command exports a service from one peer or admin partition to another.
|
||||||
|
---
|
||||||
|
|
||||||
|
# Consul Services Export
|
||||||
|
|
||||||
|
Command: `consul services export`
|
||||||
|
|
||||||
|
The `services export` command exports a service from one admin partition
|
||||||
|
or cluster peer to another. This command can be used in lieu of creating or updating the corresponding
|
||||||
|
`exported-services` configuration entry. Running the command multiple times with the same
|
||||||
|
arguments results in a no-op.
|
||||||
|
|
||||||
|
```text
|
||||||
|
Usage: consul services export [options] -name <service name> -consumer-peers <other cluster name>
|
||||||
|
|
||||||
|
Export a service to a peered cluster.
|
||||||
|
|
||||||
|
$ consul services export -name=web -consumer-peers=other-cluster
|
||||||
|
|
||||||
|
Use the -consumer-partitions flag instead of -consumer-peers to export to a different partition in the same cluster.
|
||||||
|
|
||||||
|
$ consul services export -name=web -consumer-partitions=other-partition
|
||||||
|
|
||||||
|
Additional flags and more advanced use cases are detailed below.
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Command options
|
||||||
|
|
||||||
|
- `-name=<string>` - (Required) The name of the service to export.
|
||||||
|
|
||||||
|
- `-consumer-peers=<string>` - (Required) A comma-separated list of cluster peers to export the service to.
|
||||||
|
In Consul Enterprise, this flag is optional when `-consumer-partitions` is specified.
|
||||||
|
|
||||||
|
#### Enterprise options
|
||||||
|
|
||||||
|
- `-consumer-partitions=<string>` - A comma-separated list of admin partitions within the
|
||||||
|
same datacenter to export the service to. This flag is optional when `-consumer-peers` is specified.
|
||||||
|
|
||||||
|
@include 'http_api_partition_options.mdx'
|
||||||
|
|
||||||
|
@include 'http_api_namespace_options.mdx'
|
||||||
|
|
||||||
|
#### API options
|
||||||
|
|
||||||
|
@include 'http_api_options_client.mdx'
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
In the following example, the `consul services export` command makes the `web` service available to services running in a cluster named `dc2` that has a previously-established cluster peering connection.
|
||||||
|
|
||||||
|
```shell-session hideClipboard
|
||||||
|
$ consul services export -name=web -consumer-peers=dc2
|
||||||
|
```
|
||||||
|
|
||||||
|
In the following example, the `consul services export` command makes the `web` service located in the
|
||||||
|
namespace `ns1` and the admin partition `alpha` to other admin partitions named `beta` and `delta`.
|
||||||
|
|
||||||
|
```shell-session hideClipboard
|
||||||
|
$ consul services export -name=web -namespace=ns1 -partition=alpha -consumer-partitions=beta,delta
|
||||||
|
```
|
|
@ -31,6 +31,7 @@ Usage: consul services <subcommand> [options] [args]
|
||||||
Subcommands:
|
Subcommands:
|
||||||
deregister Deregister services with the local agent
|
deregister Deregister services with the local agent
|
||||||
register Register services with the local agent
|
register Register services with the local agent
|
||||||
|
export Export services from one cluster peer or admin partition to another
|
||||||
```
|
```
|
||||||
|
|
||||||
For more information, examples, and usage about a subcommand, click on the name
|
For more information, examples, and usage about a subcommand, click on the name
|
||||||
|
|
|
@ -487,6 +487,10 @@
|
||||||
{
|
{
|
||||||
"title": "deregister",
|
"title": "deregister",
|
||||||
"path": "services/deregister"
|
"path": "services/deregister"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "export",
|
||||||
|
"path": "services/export"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
|
Loading…
Reference in New Issue