INTMDB-364: [Terraform] Add support for serverless private endpoints #314
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mongodbatlas/private_endpoints.go
Outdated
|
|
||
| // List retrieve details for all private Serverless endpoint services in one Atlas project. | ||
| // | ||
| // See more: https://www.mongodb.com/docs/atlas/reference/api/serverless-private-endpoints-get-all/ |
There was a problem hiding this comment.
[q] Could we stop using this doc page that will be deprecated soon and start using https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Serverless-Private-Endpoints (autogenerated with open API annotations)?
gssbzn
reviewed
Oct 10, 2022
gssbzn
requested changes
Oct 11, 2022
There was a problem hiding this comment.
Please refer to the up to date docs https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Serverless-Private-Endpoints, please notice the correct term is serverless private endpoint and not private serverless endpoint which seems used all over the place also this seems to only cover the AWS private endpoint and not the azure one
| // PrivateEndpointsService is an interface for interfacing with the Private Endpoints | ||
| // of the MongoDB Atlas API. | ||
| // | ||
| // See more: https://docs.atlas.mongodb.com/reference/api/private-endpoints/ |
There was a problem hiding this comment.
Suggested change
| // See more: https://docs.atlas.mongodb.com/reference/api/private-endpoints/ | |
| // See more: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Serverless-Private-Endpoints |
There was a problem hiding this comment.
@gssbzn Was using docs at the time that stated ... Creates one private endpoint for one Atlas serverless instance. Serverless instances support private endpoints on AWS only. Will have to add support for Azure
There was a problem hiding this comment.
@martinstibbe Azure support is ok to do as a follow up
| // of the MongoDB Atlas API. | ||
| // | ||
| // See more: https://docs.atlas.mongodb.com/reference/api/private-endpoints/ | ||
| type PrivateServerlessEndpointsService interface { |
There was a problem hiding this comment.
Suggested change
| type PrivateServerlessEndpointsService interface { | |
| type ServerlessPrivateEndpointsService interface { |
| serverlessPrivateEndpointsPath = "api/atlas/v1.0/groups/%s/privateEndpoint/serverless/instance/%s/endpoint" | ||
| ) | ||
|
|
||
| // PrivateEndpointsService is an interface for interfacing with the Private Endpoints |
There was a problem hiding this comment.
Suggested change
| // PrivateEndpointsService is an interface for interfacing with the Private Endpoints | |
| // ServerlessPrivateEndpointsService is an interface for interfacing with the Private Endpoints |
Comment on lines
57
to
60
| // List retrieve details for all private Serverless endpoint services in one Atlas project. | ||
| // | ||
| // See more: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#operation/returnAllPrivateEndpointsForOneServerlessInstance | ||
| func (s *PrivateServerlessEndpointsServiceOp) ListPrivateServerlessEndpoint(ctx context.Context, groupID, instanceID string, listOptions *ListOptions) ([]PrivateServerlessEndpointConnection, *Response, error) { |
There was a problem hiding this comment.
Suggested change
| // List retrieve details for all private Serverless endpoint services in one Atlas project. | |
| // | |
| // See more: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#operation/returnAllPrivateEndpointsForOneServerlessInstance | |
| func (s *PrivateServerlessEndpointsServiceOp) ListPrivateServerlessEndpoint(ctx context.Context, groupID, instanceID string, listOptions *ListOptions) ([]PrivateServerlessEndpointConnection, *Response, error) { | |
| // List retrieve details for all private Serverless endpoint services in one Atlas project. | |
| // | |
| // See more: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#operation/returnAllPrivateEndpointsForOneServerlessInstance | |
| func (s *PrivateServerlessEndpointsServiceOp) List(ctx context.Context, groupID, instanceName string, listOptions *ListOptions) ([]PrivateServerlessEndpointConnection, *Response, error) { |
| var _ PrivateServerlessEndpointsService = &PrivateServerlessEndpointsServiceOp{} | ||
|
|
||
| // PrivateEndpointServerlessConnection represents MongoDB Private Endpoint Connection. | ||
| type PrivateServerlessEndpointConnection struct { |
There was a problem hiding this comment.
Suggested change
| type PrivateServerlessEndpointConnection struct { | |
| type ServerlessPrivateEndpointConnection struct { |
Comment on lines
33
to
37
| ListPrivateServerlessEndpoint(context.Context, string, string, *ListOptions) ([]PrivateServerlessEndpointConnection, *Response, error) | ||
| AddOnePrivateServerlessEndpoint(context.Context, string, string, *PrivateServerlessEndpointConnection) (*PrivateServerlessEndpointConnection, *Response, error) | ||
| GetOnePrivateServerlessEndpoint(context.Context, string, string, string) (*PrivateServerlessEndpointConnection, *Response, error) | ||
| DeleteOnePrivateServerlessEndpoint(context.Context, string, string, string) (*Response, error) | ||
| UpdateOnePrivateServerlessEndpoint(context.Context, string, string, string, *PrivateServerlessEndpointConnection) (*PrivateServerlessEndpointConnection, *Response, error) |
There was a problem hiding this comment.
Suggested change
| ListPrivateServerlessEndpoint(context.Context, string, string, *ListOptions) ([]PrivateServerlessEndpointConnection, *Response, error) | |
| AddOnePrivateServerlessEndpoint(context.Context, string, string, *PrivateServerlessEndpointConnection) (*PrivateServerlessEndpointConnection, *Response, error) | |
| GetOnePrivateServerlessEndpoint(context.Context, string, string, string) (*PrivateServerlessEndpointConnection, *Response, error) | |
| DeleteOnePrivateServerlessEndpoint(context.Context, string, string, string) (*Response, error) | |
| UpdateOnePrivateServerlessEndpoint(context.Context, string, string, string, *PrivateServerlessEndpointConnection) (*PrivateServerlessEndpointConnection, *Response, error) | |
| List(context.Context, string, string, *ListOptions) ([]PrivateServerlessEndpointConnection, *Response, error) | |
| Create(context.Context, string, string, *PrivateServerlessEndpointConnection) (*PrivateServerlessEndpointConnection, *Response, error) | |
| Get(context.Context, string, string, string) (*PrivateServerlessEndpointConnection, *Response, error) | |
| Delete(context.Context, string, string, string) (*Response, error) | |
| Update(context.Context, string, string, string, *PrivateServerlessEndpointConnection) (*PrivateServerlessEndpointConnection, *Response, error) |
|
|
||
| // PrivateServerlessEndpointsServiceOp handles communication with the PrivateServerlessEndpoints related methods | ||
| // of the MongoDB Atlas API. | ||
| type PrivateServerlessEndpointsServiceOp service |
There was a problem hiding this comment.
Suggested change
| type PrivateServerlessEndpointsServiceOp service | |
| type ServerlessPrivateEndpointsServiceOp service |
Comment on lines
48
to
54
| ID string `json:"_id,omitempty"` // Unique identifier of the Serverless PrivateLink Service. | ||
| CloudProviderEndpointID string `json:"cloudProviderEndpointId,omitempty"` | ||
| Comment string `json:"comment,omitempty"` | ||
| EndpointServiceName string `json:"endpointServiceName,omitempty"` // Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created. | ||
| ErrorMessage string `json:"errorMessage,omitempty"` // Error message pertaining to the AWS Service Connect. Returns null if there are no errors. | ||
| Status string `json:"status,omitempty"` // Status of the AWS Serverless PrivateLink connection: INITIATING, WAITING_FOR_USER, FAILED, DELETING, AVAILABLE. | ||
| ProviderName string `json:"providerName,omitempty"` // Human-readable label that identifies the cloud provider. Values include AWS or AZURE. Atlas currently supports only AWS. |
There was a problem hiding this comment.
these fields only cover AWS for Azure you are missing privateEndpointIpAddress, privateLinkServiceResourceId,
There was a problem hiding this comment.
Added additional fields
gssbzn
approved these changes
Oct 12, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
INTMDB-364: [Terraform] Add support for serverless private endpoints
Link to any related issue(s):
Type of change:
Required Checklist:
make fmtand formatted my codeFurther comments