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

Update README.md #662

Merged
merged 4 commits into from
Jun 28, 2023
Merged

Conversation

kunisen
Copy link
Collaborator

@kunisen kunisen commented Jun 2, 2023

Description

Per an internal discussion earlier.

Related Issues

Motivation and Context

How Has This Been Tested?

Types of Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactoring (improves code quality but has no user-facing effect)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation

Readiness Checklist

  • My code follows the code style of this project
  • My change requires a change to the documentation
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed

@kunisen kunisen requested a review from a team as a code owner June 2, 2023 08:08
@kunisen kunisen requested a review from Kushmaro June 2, 2023 08:08
@kunisen kunisen added the documentation Improvements or additions to documentation label Jun 2, 2023
README.md Outdated
@@ -21,6 +21,11 @@ Things which are out of scope for provider:

We now have Terraform provider for Elastic Stack https://github.com/elastic/terraform-provider-elasticstack which should be used for any operations on Elastic Stack products.

## Support

Support tickets related to the terraform provider can be opened with Elastic, however, since terraform is a 3rd party tool (by Hashicorp) which Elastic has no full control over, we will not be able to treat support requests as severity-1(immediate time frame). Also, since urgent production-related terraform issues can be resolved via regular API or UI interaction, we ask customers to resort to such methods in case of urgent deployment downtime or issue.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So we don't publicly announce such a policy on other client repositories. I'm curious about why we need to do so here?

however, since terraform is a 3rd party tool (by Hashicorp) which Elastic has no full control over

I don't think it's helpful to base the policy on this. The same argument could be made for Elasticsearch, the operating system is a 3rd party tool we have no control over. There's a clearly defined API between Terraform and the provider, we test against that API, in theory we should stand behind that testing. This argument just sounds like we're terrible software engineers.

Also, since urgent production-related terraform issues can be resolved via regular API or UI interaction, we ask customers to resort to such methods in case of urgent deployment downtime or issue.

If we're to have this caveat on the repo, we should base it on this. The initial aim for sev1's is to restore normality by any means available, since we can restore normality by bypassing Terraform, a provider bug can't be classed as a sev1.

Related to that, let's assume there was a provider bug which resulted in deployments being terminated. A customer should quite rightly be able to open a sev1 about such a bug. There is no public facing API to restore a terminated deployment, and we would absolutely work on fixing the provider bug immediately.

It's not clear why we need this caveat in the provider repos, but not in other clients? I think it's potentially misleading i.e there's situations where a sev1 is likely the right thing to do.

Finally, the logic presented in this PR is IMO damaging to the reputation of our engineering team. If we need to include this warning, we should do so based on the availability of alternate management methods, not because we don't trust our product to adhere to an API.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Kushmaro
Sorry to trouble you directly.

Similar to the terraform provider - elastic stack one (elastic/terraform-provider-elasticstack#346), Toby and I had an internal discussion and he suggested asking for your follow up on how we want to organize the public statement.
The comment for reference - https://github.com/elastic/terraform-provider-ec/pull/662/files#r1217586538

Please let us know if anything is not clear or if you prefer to discuss this internally and thanks!

Also thanks @tobio for the detailed comment and internal discussion! 🙏

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tobio
Sorry for the delay.
I updated the statement based on our internal discussion.
When you have time, may I ask for your help to give a 2nd review please? 🙏
Thanks!

@tobio tobio merged commit f9d3fb1 into elastic:master Jun 28, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants