rpcapi: Won't be TFC-only forever

This is just a note to future maintainers to clarify the meaning of the
initial end-user-facing error message that says this interface is only
for Terraform Cloud.

Targeting Terraform Cloud as a client first is just a means to get
practical experience with this new style of integration before committing
to support it as a general API. We would still like to make this a
general-purpose integration point with compatibility guarantees in a later
release, once this approach is more proven.
pull/34738/head
Martin Atkins 3 years ago
parent a61507804c
commit c7b02f03cf

@ -72,6 +72,24 @@ func (c cliCommand) Run(args []string) int {
})
if err != nil {
if err == ErrNotPluginClient {
// TODO:
//
// The following message says that this interface is for Terraform
// Cloud only because we're using Terraform Cloud's integration
// with it to try to prove out the API/protocol design. By focusing
// only on Terraform Cloud as a client first, we can accommodate
// any necessary breaking changes by ensuring that Terraform Cloud's
// client is updated before releasing an updated RPC API server
// implementation.
//
// However, in the long run this should ideally become a documented
// public interface with compatibility guarantees, at which point
// we should change this error message only to express that this
// is a machine-oriented integration API rather than something for
// end-users to use directly. For example, the RPC server is likely
// to make a better integration point for tools like the
// Terraform Language Server in future too, assuming it grows to
// include language analysis features.
fmt.Fprintf(
os.Stderr,
`

Loading…
Cancel
Save