Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stabilize the /v1/agent/self "Config" output #3530

Closed
slackpad opened this issue Oct 4, 2017 · 1 comment
Closed

Stabilize the /v1/agent/self "Config" output #3530

slackpad opened this issue Oct 4, 2017 · 1 comment
Milestone

Comments

@slackpad
Copy link
Contributor

slackpad commented Oct 4, 2017

The Config sub-key has always just been a dump of an internal structure, so it hasn't been stable. We need to look internally and externally (hashicorp/nomad#3324) on places that depend on fields here and make a small, stable set of fields under Config that we document:

  • NodeName string
  • Datacenter string
  • Revision string
  • Server bool
  • Version string

These are sourced from:

This test will be broken and needs an update - https://github.com/hashicorp/consul/blob/master/api/agent_test.go#L640-L647.

We should move the existing Config contents to DebugConfig and document that this is for debugging use only and is subject to change.

Once this is complete, we need to open a PR against https://github.com/terraform-providers/terraform-provider-consul/blob/master/consul/data_source_consul_agent_self.go that removes unsupported fields and notes that this data source will be deprecated in a future release of the provider.

@slackpad slackpad added this to the 1.0 milestone Oct 4, 2017
magiconair added a commit that referenced this issue Oct 4, 2017
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
slackpad pushed a commit that referenced this issue Oct 4, 2017
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants