c1bf14be30
website: use 127.0.0.1 instead of consul.rocks ( #4523 )
...
By default, the Consul agent listens on the local interface
at port 8500 for API requests. This change makes the API examples
using `curl` copy-pasteable for this default configuration.
2018-08-28 09:07:15 -07:00
4d658f34cf
Intention ACL API clarification ( #4547 )
2018-08-20 20:33:15 +01:00
657b8d27ac
Update intentions documentation to clarify ACL behavior ( #4546 )
...
* Update intentions documentation to clarify ACL behavior
* Incorprate @banks suggestions into docs
* Fix my own typos!
2018-08-20 20:03:53 +01:00
3c23979afd
Fixes #4483 : Add support for Authorization: Bearer token Header ( #4502 )
...
Added Authorization Bearer token support as per RFC6750
* appended Authorization header token parsing after X-Consul-Token
* added test cases
* updated website documentation to mention Authorization header
* improve tests, improve Bearer parsing
2018-08-17 16:18:42 -04:00
0f12370cfb
a couple more corrections
2018-07-27 19:39:44 -04:00
30d27d8356
fix a couple html errors ( #4456 )
2018-07-26 16:30:24 -07:00
ed87949385
Merge pull request #4400 from hashicorp/leaf-cert-ttl
...
Add configurable leaf cert TTL to Connect CA
2018-07-25 17:53:25 -07:00
94168ac4a2
Remove deprecated Ruby consul-client library ( #4419 )
...
The GitHub repo for this library says that it is no longer maintained
and should not be used. The Ruby Diplomat library provides similar
functionality instead (and is already listed here).
2018-07-25 11:47:54 -07:00
f8d61976cd
Merge pull request #4427 from hashicorp/connect-api-docs
...
Add /health/connect to docs and make consistent with /catalog/connect
2018-07-20 21:24:57 +01:00
56ab8c9000
Add /health/connect to docs and make consistent with /catalog/connect
2018-07-20 16:50:28 +01:00
6465b13b7d
website: update docs for leaf cert TTL option
2018-07-16 13:33:42 -07:00
1027a01a10
website: document alias check
2018-07-12 21:14:36 -07:00
d508a6ba7c
oatpp-consul integration added to Libraries & SDKs page
2018-07-09 17:28:03 +03:00
cd4d5a82da
website: correct paramater for service meta on catalog register
...
I believe this may have been missed as part of #3994 . Note that the
API _returns_ `ServiceMeta`, but accepts `Meta`.
$ curl -X PUT -d \
'{
"Datacenter": "dc1",
"Node": "example",
"Address": "www.example.com",
"Service": {
"Service": "example-service",
"Port": 80,
"Meta": {"foo": "bar"}
}
}' \
http://localhost:8500/v1/catalog/register
$ curl localhost:8500/v1/catalog/service/example-service
[
{
"ID": "",
"Node": "example",
"Address": "www.example.com",
"Datacenter": "dc1",
"TaggedAddresses": null,
"NodeMeta": null,
"ServiceKind": "",
"ServiceID": "example-service",
"ServiceName": "example-service",
"ServiceTags": [],
"ServiceAddress": "",
"ServiceMeta": {
"foo": "bar"
},
"ServicePort": 80,
"ServiceEnableTagOverride": false,
"ServiceProxyDestination": "",
"ServiceConnect": {
"Native": false,
"Proxy": null
},
"CreateIndex": 11,
"ModifyIndex": 37
}
]
2018-06-26 12:15:23 -07:00
6813a99081
Merge remote-tracking branch 'connect/f-connect'
2018-06-25 19:42:51 +00:00
adaaa37e4f
website: fix an assortment of broken links
2018-06-25 12:26:24 -07:00
c20bbf8760
connect/ca: hide the RotationPeriod config field since it isn't used yet
2018-06-25 12:26:18 -07:00
f6685177f0
website: document the precedence table
2018-06-25 12:24:16 -07:00
21f27c1842
website: clarify where constraints go
2018-06-25 12:24:12 -07:00
b55f0641e6
api: support ExecuteConnect
2018-06-25 12:24:12 -07:00
1830c6b308
agent: switch ConnectNative to an embedded struct
2018-06-25 12:24:10 -07:00
1df5d91b39
website: add docs for connect native services API
2018-06-25 12:24:10 -07:00
097856c515
Starting Docs ( #46 )
...
* website: first stab at Connect docs
* website: lots more various stuff (bad commit messages)
* website: getting started page for Connect
* website: intentions
* website: intention APIs
* website: agent API docs
* website: document agent/catalog proxy kind service values
* website: /v1/catalog/connect/:service
* website: intention CLI docs
* website: custom proxy docs
* website: remove dedicated getting started guide
* website: add docs for CA API endpoints
* website: add docs for connect ca commands
* website: add proxy CLI docs
* website: clean up proxy command, add dev docs
* website: todo pages
* website: connect security
2018-06-25 12:24:05 -07:00
1a64f9aac3
website: remove backwards compat warning
...
In practice, we strive for compatibility given the usage of the API in the wild, and don't need to make this warning as we once felt we should.
2018-06-21 12:02:16 -07:00
7c2afd2951
Add licensing documentation.
2018-05-24 10:10:00 -04:00
218c05d295
prepared_queryes: put "Near" into "Service"
2018-05-23 10:32:09 +00:00
4de68fcb4b
Merge pull request #4016 from pierresouchay/support_for_prometheus
...
Support for prometheus for metrics endpoint
2018-04-24 16:14:43 +01:00
d926679278
Merge pull request #4023 from hashicorp/f-near-ip
...
Add near=_ip support for prepared queries
2018-04-12 12:10:48 -04:00
0619efc254
GH-3798: More PR Updates
...
Update docs a little
Update/add tests. Make sure all the various ways of determining the source IP work
Update X-Forwarded-For header parsing. This can be a comma separated list with the first element being the original IP so we now handle csv data there.
Got rid of error return from sourceAddrFromRequest
2018-04-12 10:40:46 -04:00
cec8d5145b
GH-3798: A few more PR updates
2018-04-11 20:32:35 -04:00
d065d3a6db
GH-3798: Updates for PR
...
Allow DNS peer IP as the source IP.
Break early when the right node was found for executing the preapred query.
Update docs
2018-04-11 17:02:04 -04:00
8830b1a9fa
GH-3798: Update prepared query documentation to mention the near=_ip param
2018-04-11 10:34:13 -04:00
0d8993e338
Allow ignoring checks by ID when defining a PreparedQuery. Fixes #3727 .
2018-04-10 14:04:16 +01:00
39bd2b78e6
Added documentation for telemetry{ prometheus_retention_time = duration }
2018-04-06 14:50:03 +02:00
cfe17bf7e3
website: Add description what the "recent events" means
...
According to this answer on SO https://stackoverflow.com/a/49495985/1875339
that has references to code lines:
94835a2715/agent/agent.go (L221)94835a2715/agent/user_event.go (L229)94835a2715/agent/user_event.go (L235)
2018-04-02 14:57:04 +04:00
c7581d68c6
Renames agent API layer for service metadata to "meta" for consistency
2018-03-28 09:04:50 -05:00
daa61c5803
Merge pull request #3881 from pierresouchay/service_metadata
...
Feature Request: Support key-value attributes for services
2018-03-27 16:33:57 -05:00
94835a2715
Spelling ( #3958 )
...
* spelling: another
* spelling: autopilot
* spelling: beginning
* spelling: circonus
* spelling: default
* spelling: definition
* spelling: distance
* spelling: encountered
* spelling: enterprise
* spelling: expands
* spelling: exits
* spelling: formatting
* spelling: health
* spelling: hierarchy
* spelling: imposed
* spelling: independence
* spelling: inspect
* spelling: last
* spelling: latest
* spelling: client
* spelling: message
* spelling: minimum
* spelling: notify
* spelling: nonexistent
* spelling: operator
* spelling: payload
* spelling: preceded
* spelling: prepared
* spelling: programmatically
* spelling: required
* spelling: reconcile
* spelling: responses
* spelling: request
* spelling: response
* spelling: results
* spelling: retrieve
* spelling: service
* spelling: significantly
* spelling: specifies
* spelling: supported
* spelling: synchronization
* spelling: synchronous
* spelling: themselves
* spelling: unexpected
* spelling: validations
* spelling: value
2018-03-19 16:56:00 +00:00
5956e778db
Add a link to the leader election guide in the lock API docs
2018-02-22 15:57:46 -08:00
6022c7a209
Added ServiceMeta documentation in website source
2018-02-11 14:12:41 +01:00
c3e94970a0
Add gRPC fields to client api and agent check endpoint docs
2018-02-09 16:02:27 -08:00
6d969d372b
Clarification around locking ( #3853 )
2018-02-01 14:08:06 -06:00
8d01a61cb5
Adjust link to Java HTTP API
...
OrbitzWorldwide/consul-client has moved to rickfast/consul-client.
2018-01-26 17:31:18 +01:00
53af1f528f
Update kv.html.md
2018-01-24 11:55:17 +01:00
9509aa6c4b
Adds the NodeID field back to the /v1/agent/self Config block.
...
Fixes #3778
2018-01-10 15:17:54 -08:00
0715ae968d
Corrected word order sequence
...
Also removed a couple of extraneous spaces.
2018-01-08 12:02:10 -05:00
88a73bd3e7
add missing Port description in register service doc
2017-12-31 22:10:35 +05:30
16cc432c7a
Adjust documentation for service tags of checks
...
Add some missing ServiceTags.
Replace null ServiceTags by empty list (ServiceTags cannot be null).
2017-12-12 13:39:37 +01:00
0f53ae9a82
Update documentation for `tag` filter
2017-11-17 14:20:30 +11:00
d3dd2b1402
Move check definition to a sub-struct
2017-11-01 14:54:46 -07:00
dbab3cd5f6
Merge branch 'master' into esm-changes
2017-11-01 11:37:48 -07:00
b0536a96cc
Fill out the tests around coordinate/node functionality
2017-10-31 15:36:44 -07:00
a8c808aee5
Add docs for the coordinate update endpoint
2017-10-26 20:17:46 -07:00
ca9aac746f
agent: add /v1/coordianate/node/:node endpoint
...
This patch adds a /v1/coordinate/node/:node endpoint to get the network
coordinates for a single node in the network.
Since Consul Enterprise supports network segments it is still possible
to receive mutiple entries for a single node - one per segment.
2017-10-26 14:24:42 +02:00
53f67c3993
Fixes API client for ScriptArgs and updates documentation. ( #3589 )
...
* Updates the API client to support the current `ScriptArgs` parameter
for checks.
* Updates docs for checks to explain the `ScriptArgs` parameter issue.
* Adds mappings for "args" and "script-args" to give th API parity
with config.
* Adds checks on return codes.
* Removes debug logging that shows empty when args are used.
2017-10-18 11:28:39 -07:00
3b280ead55
Update check.html.md
2017-10-18 13:43:32 +02:00
282b88466b
Adds a pointer to the /v1/txn API from the KV read docs.
...
Closes #3558
2017-10-17 17:07:45 -07:00
d3cebace7c
Updates documentation to s/script/args/ in API docs.
2017-10-10 16:37:08 -07:00
5f5e7529df
Update raft.html.md
2017-10-06 14:38:21 -07:00
ce887a0c45
Provide stable config for agent/self ( #3532 )
...
* config: provide stable config for /v1/agent/self (#3530 )
This patch adds a stable subset of the previous Config struct to the
agent/self response. The actual runtime configuration is moved into
DebugConfig and will be documented to change.
Fixes #3530
* config: fix tests
* doc: update api documentation for /v1/agent/self
2017-10-04 10:43:17 -07:00
1e461110e6
agent: consolidate handling of 405 Method Not Allowed ( #3405 )
...
* agent: consolidate http method not allowed checks
This patch uses the error handling of the http handlers to handle HTTP
method not allowed errors across all available endpoints. It also adds a
test for testing whether the endpoints respond with the correct status
code.
* agent: do not panic on metrics tests
* agent: drop other tests for MethodNotAllowed
* agent: align /agent/join with reality
/agent/join uses PUT instead of GET as documented.
* agent: align /agent/check/{fail,warn,pass} with reality
/agent/check/{fail,warn,pass} uses PUT instead of GET as documented.
* fix some tests
* Drop more tests for method not allowed
* Align TestAgent_RegisterService_InvalidAddress with reality
* Changes API client join to use PUT instead of GET.
* Fixes agent endpoint verbs and removes obsolete tests.
* Updates the change log.
2017-09-25 23:11:19 -07:00
0ebae85bb9
Merge pull request #3490 from ruslansennov/javadoc-fix
...
minor doc fix
2017-09-21 19:38:59 -05:00
18d2556e3c
minor doc fix
2017-09-21 22:28:49 +03:00
f264bd9294
Fix health endpoint docs ( #3483 )
...
Fixes #3483
2017-09-20 09:05:23 +02:00
552681b2a5
Update example
2017-09-11 13:01:56 +02:00
2282f412d7
Fix wrong field name: Meta -> NodeMeta
2017-09-11 19:14:47 +09:00
00605c0214
Shows the segment name in the keyring API and command output.
2017-09-07 12:17:39 -07:00
1a117ba0a8
Makes the all segments query explict, and the default for `consul members`.
2017-09-05 12:22:20 -07:00
c8f35bf6be
Update check.html.md
2017-09-01 17:11:41 -07:00
5d861b3a91
Update segment api docs
2017-09-01 12:42:54 -07:00
20296d4a89
Change segment list endpoint in docs/client api
2017-09-01 12:40:07 -07:00
40f7508016
Update segment docs
2017-08-31 17:39:57 -07:00
00d03f1141
Add doc sections for network segments
2017-08-31 11:19:08 -07:00
d129767657
Add agent.segment interpolation to prepared queries
2017-08-30 11:58:29 -07:00
b1a15e0c3d
Adds open source side of network segments (feature is Enterprise-only).
2017-08-30 11:58:29 -07:00
fe915938c7
API DOCS: Update snapshot curl example ( #3423 )
2017-08-29 09:05:00 -07:00
0516deff0c
doc: fix operator keyring delete method
2017-08-23 17:20:10 +02:00
ee2cc7aaca
doc: update check example for agent api call
2017-08-16 18:24:28 +02:00
e0924704d5
doc: add method and header to agent API docs for HTTP checks ( #3400 )
2017-08-16 18:18:46 +02:00
d3c8855c86
Adds a note about the 429 response code.
2017-08-09 20:10:44 -07:00
0428e9fe9e
Update docs for metrics endpoint
2017-08-08 12:33:30 -07:00
d5634fe2a8
Add support for labels/filters from go-metrics
2017-08-08 01:45:10 -07:00
4bee2e49f5
Adds secure introduction for the ACL replication token. ( #3357 )
...
Adds secure introduction for the ACL replication token, as well as a separate enable config for ACL replication.
2017-08-03 15:39:31 -07:00
c0a5ad7903
Adds a new /v1/acl/bootstrap API ( #3349 )
2017-08-02 17:05:18 -07:00
1565f58508
Register Entity Meta -> NodeMeta
...
Corrects a typo in the description of parameters for the Register Entity API endpoint.
2017-07-31 17:06:07 -07:00
9810c18591
Update area.html.md
2017-07-28 09:28:11 -07:00
b589d8c4a1
Update area.html.md
2017-07-28 09:27:43 -07:00
6250cd70f5
Adds option to prepared queries to remove empty tags. ( #3330 )
2017-07-26 22:46:43 -07:00
59b9164142
Adds a geo failover guide using prepared queries. ( #3328 )
2017-07-26 15:40:01 -07:00
496b0bcf07
Adds support for agent-side ACL token management via API instead of config files. ( #3324 )
...
* Adds token store and removes all runtime use of config for ACL tokens.
* Adds a new API for changing agent tokens on the fly.
2017-07-26 11:03:43 -07:00
338b49fe66
Update catalog.html.md
2017-07-24 22:14:51 -07:00
c736669af8
Update acl.html.md
2017-07-20 09:34:39 -07:00
6708871054
Update index.html.md
2017-07-20 09:34:13 -07:00
610a67defa
Updates consul exec docs to mention ACLs. ( #3308 )
...
* Update documentation for consul exec to mention all permissions it needs.
* Removed node write perm, not needed for consul exec
* Converts ACL note into a table like the API docs, adds ACL guide x-ref.
2017-07-20 09:30:08 -07:00
689c8bc934
Add UpgradeVersionTag information to docs
2017-07-18 14:01:21 -07:00
090414db15
Add network area TLS setting to docs
2017-07-14 17:06:33 -07:00
f7907db85f
Fix mistake in curl example for join agent API call
2017-07-03 00:11:18 +02:00
1dc57ce5e4
Fix invalid JSON in agent-api /v1/self example output. ( #3183 )
2017-06-24 16:16:27 -07:00
e961ee4694
Adds ConsulSwift Client to docs ( #3166 )
2017-06-20 17:16:34 -07:00
7696a9f8be
Fix bad copy/paste ( #3139 )
...
Description was probably originally copied from the "delete" request.
2017-06-10 14:46:25 -07:00
Jack Pearkes
Paul Banks
jjshanks
Miroslav Bagljas
Jeff Escalante
Jeff Escalante
Kyle Havlovitz
Geoffrey Grosenbach
Mitchell Hashimoto
Leonid Stryzhevskyi
mkeeler
Mitchell Hashimoto
phaer
Matt Keeler
Pierre Souchay
Vyacheslav Karbovnichy
Preetha Appan
Josh Soref
Yoann Fouquet
Przemysław Dąbek
James Phillips
Scott Pynn
RS Krishna
Amit Saha
Frank Schroeder
Vladislav Mitov
Ruslan Sennov
Mitsunori Komatsu
Brian Shumate
Elijah Caine
Stu Small
Jason Martin
Christoph Pageler
Scott Woods