Merge pull request #9352 from hashicorp/je.mdx-remote

Implement mdx-remote
This commit is contained in:
Jeff Escalante 2020-12-16 21:57:23 -05:00 committed by GitHub
commit cfa1394259
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
382 changed files with 4081 additions and 8421 deletions

View File

@ -1,8 +0,0 @@
{
"ignore": {
"marked": {
"versions": "0.8.2",
"reason": "IE breaks"
}
}
}

View File

@ -1,11 +1,4 @@
module.exports = {
...require('@hashicorp/nextjs-scripts/.stylelintrc.js'),
rules: {
'selector-pseudo-class-no-unknown': [
true,
{
ignorePseudoClasses: ['first', 'last'],
},
],
},
/* Specify overrides here */
}

View File

@ -1,4 +0,0 @@
module.exports = {
presets: ['next/babel'],
plugins: ['import-glob-array'],
}

View File

@ -1,28 +0,0 @@
import Search from '@hashicorp/react-search'
export default function SearchBar() {
return (
<Search
renderHitContent={({ hit, Highlight }) => (
<>
<span className="name">
<Highlight attribute="page_title" hit={hit} tagName="span" />
</span>
<span className="description">
<Highlight attribute="description" hit={hit} tagName="span" />
</span>
</>
)}
resolveHitLink={(hit) => ({
href: {
pathname: `/${transformIdtoUrl(hit.objectID)}`,
},
})}
placeholder="Search Consul documentation"
/>
)
}
function transformIdtoUrl(id) {
return id.replace(/\/index$/, '')
}

View File

@ -1,4 +0,0 @@
.g-search {
width: calc(100% - 2rem);
max-width: 600px;
}

View File

@ -1,6 +1,6 @@
import BasicHero from '../../components/basic-hero'
import PrefooterCTA from '../../components/prefooter-cta'
import ConsulEnterpriseComparison from '../../components/enterprise-comparison/consul'
import BasicHero from 'components/basic-hero'
import PrefooterCTA from 'components/prefooter-cta'
import ConsulEnterpriseComparison from 'components/enterprise-comparison/consul'
import Head from 'next/head'
import HashiHead from '@hashicorp/react-head'

View File

@ -19,8 +19,8 @@ to optimize performance of Connect without having to make requests to the server
## Authorize
-> **Note:** This endpoint will always treat intentions with `Permissions`
defined as *deny* intentions during evaluation, as this endpoint is only suited
for networking layer 4 (e.g. TCP) integration.
defined as _deny_ intentions during evaluation, as this endpoint is only suited
for networking layer 4 (e.g. TCP) integration.
For performance and reliability reasons it is desirable to implement intention
enforcement by listing [intentions that match the
destination](/api/connect/intentions#list-matching-intentions) and representing

View File

@ -146,7 +146,11 @@ The table below shows this endpoint's support for
| ----------------- | ----------------- | ------------- | -------------- |
| `YES`<sup>1</sup> | `none` | `none` | `service:read` |
<sup>1</sup> Supports <a href="/api/features/blocking#hash-based-blocking-queries">hash-based blocking</a> only.
<sup>
1
</sup> Supports <a href="/api/features/blocking#hash-based-blocking-queries">
hash-based blocking
</a> only.
### Parameters

View File

@ -248,7 +248,7 @@ The table below shows this endpoint's support for
<sup>1</sup> The ACL required depends on the config entry kind being deleted:
| Config Entry Kind | Required ACL |
| ------------------- | ---------------- |
| ------------------- | ------------------ |
| ingress-gateway | `operator:write` |
| proxy-defaults | `operator:write` |
| service-defaults | `service:write` |
@ -256,7 +256,7 @@ The table below shows this endpoint's support for
| service-resolver | `service:write` |
| service-router | `service:write` |
| service-splitter | `service:write` |
| terminating-gateway | `operator:write ` |
| terminating-gateway | `operator:write ` |
### Parameters

View File

@ -119,11 +119,12 @@ The table below shows this endpoint's support for
[agent caching](/api/features/caching), and
[required ACLs](/api#authentication).
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
| ---------------- | ----------------- | ------------- | --------------- |
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
| ---------------- | ----------------- | ------------- | ----------------------------- |
| `YES` | `all` | `none` | `operator:write` <sup>1</sup> |
<sup>1</sup> ACL required was <code>operator:read</code> prior to versions 1.8.6, 1.7.10, and 1.6.10.
<sup>1</sup> ACL required was <code>operator:read</code> prior to versions 1.8.6,
1.7.10, and 1.6.10.
### Sample Request

View File

@ -47,8 +47,8 @@ The table below shows this endpoint's support for
| `NO` | `none` | `none` | `intentions:write`<sup>1</sup> |
<p>
<sup>1</sup> Intention ACL rules are specified as part of a <code>service</code> rule.
See{' '}
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
<code>service</code> rule. See{' '}
<a href="/docs/connect/intentions#intention-management-permissions">
Intention Management Permissions
</a>{' '}
@ -156,8 +156,8 @@ The table below shows this endpoint's support for
| `NO` | `none` | `none` | `intentions:write`<sup>1</sup> |
<p>
<sup>1</sup> Intention ACL rules are specified as part of a <code>service</code> rule.
See{' '}
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
<code>service</code> rule. See{' '}
<a href="/docs/connect/intentions#intention-management-permissions">
Intention Management Permissions
</a>{' '}
@ -254,8 +254,8 @@ The table below shows this endpoint's support for
| `NO` | `none` | `none` | `intentions:write`<sup>1</sup> |
<p>
<sup>1</sup> Intention ACL rules are specified as part of a <code>service</code> rule.
See{' '}
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
<code>service</code> rule. See{' '}
<a href="/docs/connect/intentions#intention-management-permissions">
Intention Management Permissions
</a>{' '}
@ -308,8 +308,8 @@ The table below shows this endpoint's support for
| `YES` | `all` | `none` | `intentions:read`<sup>1</sup> |
<p>
<sup>1</sup> Intention ACL rules are specified as part of a <code>service</code> rule.
See{' '}
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
<code>service</code> rule. See{' '}
<a href="/docs/connect/intentions#intention-management-permissions">
Intention Management Permissions
</a>{' '}
@ -361,8 +361,8 @@ $ curl \
## Read Specific Intention by ID
-> **Deprecated** - This endpoint is deprecated in Consul 1.9.0 in favor of
[reading by name](#read-specific-intention-by-name) or by viewing the
-> **Deprecated** - This endpoint is deprecated in Consul 1.9.0 in favor of
[reading by name](#read-specific-intention-by-name) or by viewing the
[`service-intentions`](/docs/agent/config-entries/service-intentions)
config entry for the destination.
@ -383,8 +383,8 @@ The table below shows this endpoint's support for
| `YES` | `all` | `none` | `intentions:read`<sup>1</sup> |
<p>
<sup>1</sup> Intention ACL rules are specified as part of a <code>service</code> rule.
See{' '}
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
<code>service</code> rule. See{' '}
<a href="/docs/connect/intentions#intention-management-permissions">
Intention Management Permissions
</a>{' '}
@ -443,8 +443,8 @@ The table below shows this endpoint's support for
| `YES` | `all` | `none` | `intentions:read`<sup>1</sup> |
<p>
<sup>1</sup> Intention ACL rules are specified as part of a <code>service</code> rule.
See{' '}
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
<code>service</code> rule. See{' '}
<a href="/docs/connect/intentions#intention-management-permissions">
Intention Management Permissions
</a>{' '}
@ -527,13 +527,13 @@ The table below shows this endpoint's support for
[agent caching](/api/features/caching), and
[required ACLs](/api#authentication).
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
| ---------------- | ----------------- | ------------- | ----------------------------- |
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
| ---------------- | ----------------- | ------------- | ------------------------------ |
| `NO` | `none` | `none` | `intentions:write`<sup>1</sup> |
<p>
<sup>1</sup> Intention ACL rules are specified as part of a <code>service</code> rule.
See{' '}
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
<code>service</code> rule. See{' '}
<a href="/docs/connect/intentions#intention-management-permissions">
Intention Management Permissions
</a>{' '}
@ -590,8 +590,8 @@ The table below shows this endpoint's support for
| `NO` | `none` | `none` | `intentions:write`<sup>1</sup> |
<p>
<sup>1</sup> Intention ACL rules are specified as part of a <code>service</code> rule.
See{' '}
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
<code>service</code> rule. See{' '}
<a href="/docs/connect/intentions#intention-management-permissions">
Intention Management Permissions
</a>{' '}
@ -618,7 +618,7 @@ and returns whether the connection would be authorized or not given the current
Consul configuration and set of intentions.
-> **Note:** This endpoint will always evaulate intentions with `Permissions`
defined as *deny* intentions during. This endpoint is only suited for
defined as _deny_ intentions during. This endpoint is only suited for
networking layer 4 (e.g. TCP) integration.
For performance and reliability reasons it is desirable to implement intention
@ -645,8 +645,8 @@ The table below shows this endpoint's support for
| `NO` | `none` | `none` | `intentions:read`<sup>1</sup> |
<p>
<sup>1</sup> Intention ACL rules are specified as part of a <code>service</code> rule.
See{' '}
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
<code>service</code> rule. See{' '}
<a href="/docs/connect/intentions#intention-management-permissions">
Intention Management Permissions
</a>{' '}
@ -708,8 +708,8 @@ The table below shows this endpoint's support for
| `YES` | `all` | `background refresh` | `intentions:read`<sup>1</sup> |
<p>
<sup>1</sup> Intention ACL rules are specified as part of a <code>service</code> rule.
See{' '}
<sup>1</sup> Intention ACL rules are specified as part of a{' '}
<code>service</code> rule. See{' '}
<a href="/docs/connect/intentions#intention-management-permissions">
Intention Management Permissions
</a>{' '}

View File

@ -197,7 +197,7 @@ The table below shows this endpoint's support for
that does not include the acquire parameter will proceed normally even if another
session has locked the key.**
For an example of how to use the lock feature, check the
For an example of how to use the lock feature, check the
[Leader Election tutorial](https://learn.hashicorp.com/tutorials/consul/application-leader-elections).
- `release` `(string: "")` - Supply a session ID to use in a release operation. This is

View File

@ -252,14 +252,13 @@ $ curl \
The HTTP status code will indicate the health of the cluster. If `Healthy` is true, then a
status of 200 will be returned. If `Healthy` is false, then a status of 429 will be returned.
## Read the Autopilot State
This endpoint queries the health of the autopilot status.
| Method | Path | Produces |
| ------ | ---------------------------- | ------------------ |
| `GET` | `/operator/autopilot/state` | `application/json` |
| Method | Path | Produces |
| ------ | --------------------------- | ------------------ |
| `GET` | `/operator/autopilot/state` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api/features/blocking),
@ -288,32 +287,32 @@ $ curl \
```json
{
"Healthy": true,
"FailureTolerance": 1,
"OptimisticFailureTolerance": 4,
"Servers": {
"5e26a3af-f4fc-4104-a8bb-4da9f19cb278": {},
"10b71f14-4b08-4ae5-840c-f86d39e7d330": {},
"1fd52e5e-2f72-47d3-8cfc-2af760a0c8c2": {},
"63783741-abd7-48a9-895a-33d01bf7cb30": {},
"6cf04fd0-7582-474f-b408-a830b5471285": {}
},
"Leader": "5e26a3af-f4fc-4104-a8bb-4da9f19cb278",
"Voters": [
"5e26a3af-f4fc-4104-a8bb-4da9f19cb278",
"10b71f14-4b08-4ae5-840c-f86d39e7d330",
"1fd52e5e-2f72-47d3-8cfc-2af760a0c8c2"
],
"RedundancyZones": {
"az1": {},
"az2": {},
"az3": {}
},
"ReadReplicas": [
"63783741-abd7-48a9-895a-33d01bf7cb30",
"6cf04fd0-7582-474f-b408-a830b5471285"
],
"Upgrade": {}
"Healthy": true,
"FailureTolerance": 1,
"OptimisticFailureTolerance": 4,
"Servers": {
"5e26a3af-f4fc-4104-a8bb-4da9f19cb278": {},
"10b71f14-4b08-4ae5-840c-f86d39e7d330": {},
"1fd52e5e-2f72-47d3-8cfc-2af760a0c8c2": {},
"63783741-abd7-48a9-895a-33d01bf7cb30": {},
"6cf04fd0-7582-474f-b408-a830b5471285": {}
},
"Leader": "5e26a3af-f4fc-4104-a8bb-4da9f19cb278",
"Voters": [
"5e26a3af-f4fc-4104-a8bb-4da9f19cb278",
"10b71f14-4b08-4ae5-840c-f86d39e7d330",
"1fd52e5e-2f72-47d3-8cfc-2af760a0c8c2"
],
"RedundancyZones": {
"az1": {},
"az2": {},
"az3": {}
},
"ReadReplicas": [
"63783741-abd7-48a9-895a-33d01bf7cb30",
"6cf04fd0-7582-474f-b408-a830b5471285"
],
"Upgrade": {}
}
```
@ -322,13 +321,12 @@ $ curl \
- `FailureTolerance` is the number of redundant healthy servers that could be
fail without causing an outage (this would be 2 in a healthy cluster of 5
servers).
- `OptimisticFailuretolerance` <EnterpriseAlert inline /> is the maximum number
of servers that could fail in the right order over the right period of time
of servers that could fail in the right order over the right period of time
without causing an outage. This value is only useful when using the [Redundancy
Zones feature](/docs/enterprise/redundancy) with autopilot.
- `Servers` is a mapping of server ID to an object holding detailed information about that server.
- `Servers` is a mapping of server ID to an object holding detailed information about that server.
The format of the detailed info is documented in its own section.
- `Leader` is the server ID of current leader. This value can be used as an index into the `Servers` object.
@ -340,7 +338,6 @@ $ curl \
- `ReadReplicas` <EnterpriseAlert inline /> is a list of server IDs that autopilot has identified as read replicas.
These will never be promoted. These values can be used as indexes into the `Servers` map.
- `Upgrade` <EnterpriseAlert inline /> is an object holding all the information about any ongoing automated upgrade.
The format of this object is detailed in its own section.
@ -348,25 +345,25 @@ $ curl \
```json
{
"ID": "1c3e3278-3f88-4a97-9f6a-1058584e8058",
"Name": "node1",
"Address": "198.18.0.1:8300",
"NodeStatus": "alive",
"Version": "1.9.0+ent",
"LastContact": "1.321ms",
"LastTerm": 4,
"LastIndex": 42,
"Healthy": true,
"StableSince": "2020-08-12T12:13:14Z",
"RedundancyZone": "az1",
"UpgradeVersion": "1.2.3",
"ReadReplica": false,
"Status": "voter",
"Meta": {
"build": "1.2.3",
"zone": "az1"
},
"NodeType": "redundancy-zone-voter"
"ID": "1c3e3278-3f88-4a97-9f6a-1058584e8058",
"Name": "node1",
"Address": "198.18.0.1:8300",
"NodeStatus": "alive",
"Version": "1.9.0+ent",
"LastContact": "1.321ms",
"LastTerm": 4,
"LastIndex": 42,
"Healthy": true,
"StableSince": "2020-08-12T12:13:14Z",
"RedundancyZone": "az1",
"UpgradeVersion": "1.2.3",
"ReadReplica": false,
"Status": "voter",
"Meta": {
"build": "1.2.3",
"zone": "az1"
},
"NodeType": "redundancy-zone-voter"
}
```
@ -389,19 +386,13 @@ $ curl \
- `Healthy` is whether the server is healthy according to the current Autopilot configuration.
- `StableSince` is the time this server has been in its current `Healthy` state.
- `RedundancyZone` <EnterpriseAlert inline /> is the name of the redundancy zone this server is within.
- `UpgradeVersion` <EnterpriseAlert inline /> is the version that will be used for automated upgrade calculations.
- `ReadReplica` <EnterpriseAlert inline /> indicates whether this server is a read replica or not.
- `Status` indicates the current Raft status of this server. Possible values are:
`leader`, `voter`, `non-voter`, or `staging`.
- `Status` indicates the current Raft status of this server. Possible values are:
`leader`, `voter`, `non-voter`, or `staging`.
- `Meta` is the node metadata of this server. Values within this map are used for determining a server's
redundancy zone and upgrade version.
- `NodeType` is the desired type autopilot thinks this server should have. In Consul OSS the only possible
value is `voter` as all present servers should having voting rights. In Consul Enterprise the possible values also
include `read-replica`, `zone-voter`, `zone-standby` and `zone-extra-voter`. `zone-voter` indicates that autopilot
@ -416,13 +407,11 @@ $ curl \
```json
{
"Servers": [
"10b71f14-4b08-4ae5-840c-f86d39e7d330",
"b007061c-6d15-4c90-b3d6-2fef276a0650"
"10b71f14-4b08-4ae5-840c-f86d39e7d330",
"b007061c-6d15-4c90-b3d6-2fef276a0650"
],
"Voters": [
"b007061c-6d15-4c90-b3d6-2fef276a0650"
],
"FailureTolerance": 1,
"Voters": ["b007061c-6d15-4c90-b3d6-2fef276a0650"],
"FailureTolerance": 1
}
```
@ -430,43 +419,36 @@ Each zone in the responses `RedundancyZones` mapping will have this structure.
- `Servers` is a list of server IDs of all the servers in this zone. These values can be used as indexes
into the top level response's `Servers` mapping.
- `Voters` is a list of server IDs of all servers in this zone that have voting rights. Typically this will
be a list with 1 value but in some failure scenarios or upgrade scenarios the size could increase. These
values can be used as indexes into the top level response's `Servers` mapping.
- `FailureTolerance` is the number of servers in this zone that could fail without causing a total zone failure
and subsequent promotion of a server from another zone as a fallback.
### Upgrade Information Response Format <Enterprise Alert inline />
```json
{
"Status": "awaiting-new-servers",
"TargetVersion": "1.9.1+ent",
"TargetVersionVoters": [
"f0344689-3e1f-4125-b55d-e888d3abf514"
],
"TargetVersionNonVoters": [
"619a4ba6-1a0b-476e-8a1a-28aeee7735a2",
"fd683fe6-541f-4ebf-bc5a-6eae51571ddb"
],
"TargetVersionReadReplicas": [
"9f1e27ae-1129-45ef-97dd-6d8c3ec47e6a"
],
"OtherVersionVoters": [
"0cbdd493-235f-48f2-98d9-1bf2443b9d72",
"21812bd7-2f21-4565-9892-2fdd3d4e1a99",
"c654ba5c-cc76-4056-a5ca-6e78d95f27ad"
],
"OtherVersionNonVoters": [
"6d973f11-6bdb-4f7d-8a90-c1300066da4c",
"6241ab45-371e-4b2a-a0f1-d847c3b7b1b0"
],
"OtherVersionReadReplicas": [
"42d10fc3-581b-4403-832d-945b3a0d8841"
],
}
"Status": "awaiting-new-servers",
"TargetVersion": "1.9.1+ent",
"TargetVersionVoters": ["f0344689-3e1f-4125-b55d-e888d3abf514"],
"TargetVersionNonVoters": [
"619a4ba6-1a0b-476e-8a1a-28aeee7735a2",
"fd683fe6-541f-4ebf-bc5a-6eae51571ddb"
],
"TargetVersionReadReplicas": ["9f1e27ae-1129-45ef-97dd-6d8c3ec47e6a"],
"OtherVersionVoters": [
"0cbdd493-235f-48f2-98d9-1bf2443b9d72",
"21812bd7-2f21-4565-9892-2fdd3d4e1a99",
"c654ba5c-cc76-4056-a5ca-6e78d95f27ad"
],
"OtherVersionNonVoters": [
"6d973f11-6bdb-4f7d-8a90-c1300066da4c",
"6241ab45-371e-4b2a-a0f1-d847c3b7b1b0"
],
"OtherVersionReadReplicas": ["42d10fc3-581b-4403-832d-945b3a0d8841"]
}
```
- `Status` is the automated upgrade status. Possible values are:
@ -477,23 +459,18 @@ Each zone in the responses `RedundancyZones` mapping will have this structure.
- `await-new-voters` indicates that a newer versioned server has been added but that autopilot is waiting for more servers
of that version to be added before proceeding with the upgrade.
- `promoting` indicates that enough servers of the target version have been added and autopilot will now promote them
to voters.
- `demoting` indicates that autopilot is currently demoting the servers not running the target version.
- `leader-transfer` indicates that autopilot is in the process of transferring leadership to a server running
the target version.
- `await-new-servers` indicates that the majority of the upgrade is complete but that more servers running the target
version need to be added to completely replace all of the previous servers.
- `await-server-removal` indicates that the upgrade is complete and it is now safe to remove the previous servers.
- `TargetVersion` is the version that Autopilot is upgrading to. This will be the maximum version of all servers
- `TargetVersion` is the version that Autopilot is upgrading to. This will be the maximum version of all servers
`UpgradeVersion` field in the top level `Servers` mapping.
- `TargetVersionVoters` is a list of IDs of servers running the target version and that currently have voting rights.
- `TargetVersionNonVoters` is a list of IDs of servers running the target version and that currently do not have voting rights.
@ -504,4 +481,4 @@ Each zone in the responses `RedundancyZones` mapping will have this structure.
- `OtherVersionNonVoters` is a list of IDs of servers not running the target version and that currently do not have voting rights.
- `OtherVersionReadReplicas` is a list of IDs of servers not running the target version and are read replicas.
- `OtherVersionReadReplicas` is a list of IDs of servers not running the target version and are read replicas.

View File

@ -67,7 +67,7 @@ $ curl \
"WbL6oaTPom+7RG7Q/INbJWKy09OLar/Hf2SuOAdoQE4=": 1
},
"PrimaryKeys": {
"pUqJrVyVRj5jsiYEkM/tFQYfWyJIv4s3XkvDwy7Cu5s=": 1,
"pUqJrVyVRj5jsiYEkM/tFQYfWyJIv4s3XkvDwy7Cu5s=": 1
},
"NumNodes": 3
},
@ -81,7 +81,7 @@ $ curl \
"WbL6oaTPom+7RG7Q/INbJWKy09OLar/Hf2SuOAdoQE4=": 1
},
"PrimaryKeys": {
"pUqJrVyVRj5jsiYEkM/tFQYfWyJIv4s3XkvDwy7Cu5s=": 1,
"pUqJrVyVRj5jsiYEkM/tFQYfWyJIv4s3XkvDwy7Cu5s=": 1
},
"NumNodes": 3
}

View File

@ -2,8 +2,7 @@
layout: commands
page_title: 'Commands: Connect Proxy'
sidebar_title: envoy
description:
The connect proxy subcommand is used to run the Envoy proxy for Connect.
description: The connect proxy subcommand is used to run the Envoy proxy for Connect.
---
# Consul Connect Envoy
@ -78,10 +77,10 @@ proxy configuration needed.
`1.16.0`. This is required so that the correct configuration can be generated.
- `-no-central-config` - By default the proxy's bootstrap configuration can be
customized centrally. This requires that the command run on the same agent
as the proxy will and that the agent is reachable when the command is run.
In cases where either assumption is violated this flag will prevent the
command attempting to resolve config from the local agent.
customized centrally. This requires that the command run on the same agent
as the proxy will and that the agent is reachable when the command is run.
In cases where either assumption is violated this flag will prevent the
command attempting to resolve config from the local agent.
- `-- [pass-through options]` - Any options given after a double dash are passed
directly through to the `envoy` invocation. See [Envoy's

Some files were not shown because too many files have changed in this diff Show More