modernisation-platform icon indicating copy to clipboard operation
modernisation-platform copied to clipboard

Add user guidance and tests for creating VPC endpoints

Open davidkelliott opened this issue 11 months ago • 3 comments

User Story

As an engineer I expect users to add VPC endpoints in a platform-consistent way So that VPC endpoints are all applied consistently

Value / Purpose

There is currently no user guidance on how to add VPC endpoints, this issue will add that guidance, also it would be good to point users to this guidance when they try to create a VPC endpoint in the environments repo.

How would we add testing? Would we do this with an OPA policy test? Would we do this in the modernisation-platform-environments repository to warn customers that they shouldn't create endpoints in their customer code?

Useful Contacts

No response

Additional Information

No response

Proposal / Unknowns

Could we post to the PR a link to the guidance whenever someone tries to create an endpoint.

Do we know what an appropriate way to test for this is?

Definition of Done

  • [ ] User guide created
  • [ ] New test created
  • [ ] Another team member has reviewed
  • [ ] Tests are green

davidkelliott avatar Mar 25 '24 11:03 davidkelliott

What do we mean by test?

SimonPPledger avatar Apr 11 '24 09:04 SimonPPledger

We could use a similar solution to what we have now to post in the PR when someone creates an endpoint resource, a link to the new documentation explaining how to create endpoints.

davidkelliott avatar May 07 '24 14:05 davidkelliott

This issue is stale because it has been open 90 days with no activity.

github-actions[bot] avatar Aug 22 '24 01:08 github-actions[bot]