update.go 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330
  1. package datastore
  2. import (
  3. "context"
  4. "errors"
  5. "net/http"
  6. "strings"
  7. "connectrpc.com/connect"
  8. porterv1 "github.com/porter-dev/api-contracts/generated/go/porter/v1"
  9. "github.com/porter-dev/porter/api/server/authz"
  10. "github.com/porter-dev/porter/api/server/handlers"
  11. "github.com/porter-dev/porter/api/server/handlers/release"
  12. "github.com/porter-dev/porter/api/server/shared"
  13. "github.com/porter-dev/porter/api/server/shared/apierrors"
  14. "github.com/porter-dev/porter/api/server/shared/config"
  15. "github.com/porter-dev/porter/api/types"
  16. "github.com/porter-dev/porter/internal/datastore"
  17. "github.com/porter-dev/porter/internal/helm"
  18. "github.com/porter-dev/porter/internal/kubernetes"
  19. "github.com/porter-dev/porter/internal/models"
  20. "github.com/porter-dev/porter/internal/telemetry"
  21. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  22. )
  23. // UpdateDatastoreHandler is a struct for updating datastores.
  24. // Currently, this is expected to used once (on create) and then not again, however the 'update' terminology was proactively used
  25. // so we can reuse this handler when we support updates in the future.
  26. type UpdateDatastoreHandler struct {
  27. handlers.PorterHandlerReadWriter
  28. authz.KubernetesAgentGetter
  29. }
  30. // NewUpdateDatastoreHandler constructs a datastore UpdateDatastoreHandler
  31. func NewUpdateDatastoreHandler(
  32. config *config.Config,
  33. decoderValidator shared.RequestDecoderValidator,
  34. writer shared.ResultWriter,
  35. ) *UpdateDatastoreHandler {
  36. return &UpdateDatastoreHandler{
  37. PorterHandlerReadWriter: handlers.NewDefaultPorterHandler(config, decoderValidator, writer),
  38. KubernetesAgentGetter: authz.NewOutOfClusterAgentGetter(config),
  39. }
  40. }
  41. // UpdateDatastoreRequest is the expected format of the request body
  42. type UpdateDatastoreRequest struct {
  43. Name string `json:"name"`
  44. Type string `json:"type"`
  45. Engine string `json:"engine"`
  46. Values map[string]interface{} `json:"values"`
  47. }
  48. // ServeHTTP updates a datastore using the decoded values
  49. func (h *UpdateDatastoreHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
  50. ctx, span := telemetry.NewSpan(r.Context(), "serve-update-datastore")
  51. defer span.End()
  52. project, _ := ctx.Value(types.ProjectScope).(*models.Project)
  53. cluster, _ := ctx.Value(types.ClusterScope).(*models.Cluster)
  54. request := &UpdateDatastoreRequest{}
  55. if ok := h.DecodeAndValidate(w, r, request); !ok {
  56. err := telemetry.Error(ctx, span, nil, "error decoding update datastore request")
  57. h.HandleAPIError(w, r, apierrors.NewErrPassThroughToClient(err, http.StatusBadRequest))
  58. return
  59. }
  60. telemetry.WithAttributes(span,
  61. telemetry.AttributeKV{Key: "name", Value: request.Name},
  62. telemetry.AttributeKV{Key: "type", Value: request.Type},
  63. telemetry.AttributeKV{Key: "engine", Value: request.Engine},
  64. )
  65. record, err := datastore.CreateOrGetDatastoreRecord(ctx, datastore.CreateOrGetDatastoreRecordInput{
  66. ProjectID: project.ID,
  67. ClusterID: cluster.ID,
  68. Name: request.Name,
  69. Type: request.Type,
  70. Engine: request.Engine,
  71. DatastoreRepository: h.Repo().Datastore(),
  72. ClusterRepository: h.Repo().Cluster(),
  73. })
  74. if err != nil {
  75. err := telemetry.Error(ctx, span, err, "error retrieving datastore record")
  76. h.HandleAPIError(w, r, apierrors.NewErrPassThroughToClient(err, http.StatusInternalServerError))
  77. return
  78. }
  79. // TODO: replace this with ccp call
  80. err = h.InstallDatastore(ctx, InstallDatastoreInput{
  81. Name: record.Name,
  82. Type: record.Type,
  83. Engine: record.Engine,
  84. Values: request.Values,
  85. Request: r,
  86. })
  87. if err != nil {
  88. err := telemetry.Error(ctx, span, err, "error installing datastore")
  89. h.HandleAPIError(w, r, apierrors.NewErrPassThroughToClient(err, http.StatusInternalServerError))
  90. return
  91. }
  92. // TODO: create an API-level representation of the db model rather than returning the model directly
  93. h.WriteResult(w, r, record)
  94. }
  95. // InstallDatastoreInput is the input type for InstallDatastore
  96. type InstallDatastoreInput struct {
  97. Name string
  98. Type string
  99. Engine string
  100. Values map[string]interface{}
  101. Request *http.Request
  102. }
  103. // InstallDatastore installs a datastore by helm installing a template with the provided values
  104. func (h *UpdateDatastoreHandler) InstallDatastore(ctx context.Context, inp InstallDatastoreInput) error {
  105. ctx, span := telemetry.NewSpan(ctx, "datastore-install")
  106. defer span.End()
  107. proj, _ := ctx.Value(types.ProjectScope).(*models.Project)
  108. cluster, _ := ctx.Value(types.ClusterScope).(*models.Cluster)
  109. telemetry.WithAttributes(span,
  110. telemetry.AttributeKV{Key: "name", Value: inp.Name},
  111. telemetry.AttributeKV{Key: "type", Value: inp.Type},
  112. telemetry.AttributeKV{Key: "engine", Value: inp.Engine},
  113. )
  114. templateName, err := templateNameFromDatastoreTypeAndEngine(inp.Type, inp.Engine)
  115. if err != nil {
  116. return telemetry.Error(ctx, span, err, "error getting template name from datastore type and engine")
  117. }
  118. telemetry.WithAttributes(span, telemetry.AttributeKV{Key: "template-name", Value: templateName})
  119. helmAgent, err := h.GetHelmAgent(ctx, inp.Request, cluster, release.Namespace_ACKSystem)
  120. if err != nil {
  121. return telemetry.Error(ctx, span, err, "error creating helm agent")
  122. }
  123. chart, err := release.LoadChart(ctx, h.Config(), &release.LoadAddonChartOpts{
  124. ProjectID: proj.ID,
  125. RepoURL: h.Config().Metadata.DefaultAddonHelmRepoURL,
  126. TemplateName: templateName,
  127. })
  128. if err != nil {
  129. return telemetry.Error(ctx, span, nil, "error loading chart")
  130. }
  131. registries, err := h.Repo().Registry().ListRegistriesByProjectID(cluster.ProjectID)
  132. if err != nil {
  133. return telemetry.Error(ctx, span, err, "error retrieving project registry")
  134. }
  135. vpcConfig, err := h.getVPCConfig(ctx, templateName, proj, cluster)
  136. if err != nil {
  137. return telemetry.Error(ctx, span, err, "error retrieving vpc config")
  138. }
  139. if err := h.performAddonPreinstall(ctx, inp.Request, templateName, cluster); err != nil {
  140. return telemetry.Error(ctx, span, err, "error performing addon preinstall")
  141. }
  142. values := inp.Values
  143. values["vpcConfig"] = vpcConfig
  144. conf := &helm.InstallChartConfig{
  145. Chart: chart,
  146. Name: inp.Name,
  147. Namespace: release.Namespace_ACKSystem,
  148. Values: values,
  149. Cluster: cluster,
  150. Repo: h.Repo(),
  151. Registries: registries,
  152. }
  153. _, err = helmAgent.InstallChart(ctx, conf, h.Config().DOConf, h.Config().ServerConf.DisablePullSecretsInjection)
  154. if err != nil {
  155. return telemetry.Error(ctx, span, err, "error installing chart")
  156. }
  157. return nil
  158. }
  159. func (h *UpdateDatastoreHandler) getVPCConfig(ctx context.Context, templateName string, project *models.Project, cluster *models.Cluster) (map[string]any, error) {
  160. ctx, span := telemetry.NewSpan(ctx, "datastore-get-vpc-config")
  161. defer span.End()
  162. telemetry.WithAttributes(span,
  163. telemetry.AttributeKV{Key: "cloud-provider", Value: cluster.CloudProvider},
  164. telemetry.AttributeKV{Key: "template-name", Value: templateName},
  165. )
  166. vpcConfig := map[string]any{}
  167. if cluster.CloudProvider != "AWS" {
  168. return vpcConfig, nil
  169. }
  170. awsTemplates := map[string]string{
  171. "elasticache-redis": "elasticache",
  172. "rds-postgresql": "rds",
  173. "rds-postgresql-aurora": "rds",
  174. }
  175. serviceType, ok := awsTemplates[templateName]
  176. if !ok {
  177. return vpcConfig, nil
  178. }
  179. req := connect.NewRequest(&porterv1.SharedNetworkSettingsRequest{
  180. ProjectId: int64(project.ID),
  181. ClusterId: int64(cluster.ID),
  182. ServiceType: serviceType,
  183. })
  184. resp, err := h.Config().ClusterControlPlaneClient.SharedNetworkSettings(ctx, req)
  185. if err != nil {
  186. return vpcConfig, telemetry.Error(ctx, span, err, "error fetching cluster network settings from ccp")
  187. }
  188. vpcConfig["cidrBlock"] = resp.Msg.CidrRange
  189. vpcConfig["subnetIDs"] = resp.Msg.SubnetIds
  190. switch resp.Msg.CloudProvider {
  191. case *porterv1.EnumCloudProvider_ENUM_CLOUD_PROVIDER_AWS.Enum():
  192. vpcConfig["awsRegion"] = resp.Msg.Region
  193. vpcConfig["vpcID"] = resp.Msg.GetEksCloudProviderNetwork().Id
  194. telemetry.WithAttributes(span,
  195. telemetry.AttributeKV{Key: "aws-region", Value: resp.Msg.Region},
  196. telemetry.AttributeKV{Key: "vpc-id", Value: resp.Msg.GetEksCloudProviderNetwork().Id},
  197. )
  198. }
  199. telemetry.WithAttributes(span,
  200. telemetry.AttributeKV{Key: "cidr-block", Value: resp.Msg.CidrRange},
  201. telemetry.AttributeKV{Key: "subnet-ids", Value: strings.Join(resp.Msg.SubnetIds, ",")},
  202. )
  203. return vpcConfig, nil
  204. }
  205. func (h *UpdateDatastoreHandler) scaleAckChartDeployment(ctx context.Context, chart string, agent *kubernetes.Agent) error {
  206. ctx, span := telemetry.NewSpan(ctx, "scale-ack-chart")
  207. defer span.End()
  208. telemetry.WithAttributes(span,
  209. telemetry.AttributeKV{Key: "chart-name", Value: chart},
  210. )
  211. scale, err := agent.Clientset.AppsV1().Deployments(release.Namespace_ACKSystem).GetScale(ctx, chart, metav1.GetOptions{})
  212. if err != nil {
  213. return telemetry.Error(ctx, span, err, "failed getting deployment")
  214. }
  215. if scale.Spec.Replicas > 0 {
  216. return nil
  217. }
  218. scale.Spec.Replicas = 1
  219. if _, err := agent.Clientset.AppsV1().Deployments(release.Namespace_ACKSystem).UpdateScale(ctx, chart, scale, metav1.UpdateOptions{}); err != nil {
  220. return telemetry.Error(ctx, span, err, "failed scaling deployment up")
  221. }
  222. return nil
  223. }
  224. func (h *UpdateDatastoreHandler) performAddonPreinstall(ctx context.Context, r *http.Request, templateName string, cluster *models.Cluster) error {
  225. ctx, span := telemetry.NewSpan(ctx, "datastore-addon-preinstall")
  226. defer span.End()
  227. awsTemplates := map[string][]string{
  228. "elasticache-redis": {"ack-chart-ec2", "ack-chart-elasticache"},
  229. "rds-postgresql": {"ack-chart-ec2", "ack-chart-rds"},
  230. "rds-postgresql-aurora": {"ack-chart-ec2", "ack-chart-rds"},
  231. }
  232. telemetry.WithAttributes(span,
  233. telemetry.AttributeKV{Key: "template-name", Value: templateName},
  234. telemetry.AttributeKV{Key: "cloud-provider", Value: cluster.CloudProvider},
  235. )
  236. if cluster.CloudProvider != "AWS" {
  237. return nil
  238. }
  239. if _, ok := awsTemplates[templateName]; !ok {
  240. return nil
  241. }
  242. agent, err := h.GetAgent(r, cluster, "")
  243. if err != nil {
  244. return telemetry.Error(ctx, span, err, "failed to get k8s agent")
  245. }
  246. if _, err = agent.GetNamespace(release.Namespace_EnvironmentGroups); err != nil {
  247. if _, err := agent.CreateNamespace(release.Namespace_EnvironmentGroups, map[string]string{}); err != nil {
  248. return telemetry.Error(ctx, span, err, "failed creating porter-env-group namespace")
  249. }
  250. }
  251. for _, chart := range awsTemplates[templateName] {
  252. if err := h.scaleAckChartDeployment(ctx, chart, agent); err != nil {
  253. return telemetry.Error(ctx, span, err, "failed scaling ack chart deployment")
  254. }
  255. }
  256. return nil
  257. }
  258. func templateNameFromDatastoreTypeAndEngine(databaseType string, databaseEngine string) (string, error) {
  259. switch databaseType {
  260. case "RDS":
  261. switch databaseEngine {
  262. case "POSTGRES":
  263. return "rds-postgresql", nil
  264. case "AURORA-POSTGRES":
  265. return "rds-postgresql-aurora", nil
  266. default:
  267. return "", errors.New("invalid database engine")
  268. }
  269. case "ELASTICACHE":
  270. switch databaseEngine {
  271. case "REDIS":
  272. return "elasticache-redis", nil
  273. default:
  274. return "", errors.New("invalid database engine")
  275. }
  276. default:
  277. return "", errors.New("invalid database type")
  278. }
  279. }