feat: [CP-548] Adding config files for EKS stage and dev #5009

kathrynlovett · 2023-10-03T22:38:37Z

Ticket: https://kiva.atlassian.net/browse/CP-548

Added new config files for EKS dev and stage so that we can reference them when starting up the UI. Let me know if you have concerns about this approach or if there's another approach that would be better!

This should take the place of our current config map for the UI and work better as we deploy to different environments.

JoeTravisKiva

This might be a good time to consider how we can read these values from env vars and populate them similarly to apolloBatching and memcachedServers. In an ideal world, we would be able to change these without needing to create a new build.

JoeTravisKiva · 2023-10-03T23:33:53Z

config/eks.js

+				cNTV7eN5sBKgv9nQOxDpAz1pPfJGlBI5: `https://admin.${baseUrl}/admin/login?force=1`,
+				e6wSaTBDpKRkV5SV5cWw6zD6eJjd2DEk: `https://partners.${baseUrl}/pa2/login/login?authLevel=recent`,
+				xOXldYg02WsLnlnn0D5xoPWI2i3aNsFD: `https://www.${baseUrl}/authenticate?authLevel=recent`,
+				KIzjUBQjKZwMRgYSn6NvMxsUwNppwnLH: `https://www.$baseUrl}/ui-login?force=true`,


missing a { around baseUrl

kathrynlovett · 2023-10-03T23:34:35Z

@JoeTravisKiva I took a stab at making all the settings that differ between stage and dev configurable. Let me know what you think (also not married to the env/config file name). If this looks good, I can remove the staging file and we can move forward with this. It's set to default to dev values that can then be overriden for stage. Not sure if we want to make it work for prod as well. The current app uses the prod config (index.js) as a base, so we may want a plan for EKS rollout but perhaps after that we'd simply want to continue using that as a base?

JoeTravisKiva · 2023-10-03T23:36:09Z

config/eks.js

+			domain: `login.${env}.kiva.org`,
+		},
+		paypal : {
+			url: 'www.sandbox.paypal.com',


I suspect we'll want to make a few more of these values configurable (like the paypal values), but I think this approach is great!

Yeah, I figured I'd start small with just the values we'd have to override for stage so as not to bloat the file with variables we would never set. Let me know if you think it would be helpful to add any others in at this point, though!

] Removing unnecessary staging file

hobbsh · 2023-10-04T15:27:40Z

config/eks.js

@@ -0,0 +1,78 @@
+const { merge } = require('webpack-merge');


Is there a better name we can come up with other than eks? I'm not a huge fan of putting that in our configs.

Maybe dynamic?

mcstover · 2023-10-04T16:46:33Z

config/dynamic.js

+				e6wSaTBDpKRkV5SV5cWw6zD6eJjd2DEk: `https://partners.${baseUrl}/pa2/login/login?authLevel=recent`,
+				xOXldYg02WsLnlnn0D5xoPWI2i3aNsFD: `https://www.${baseUrl}/authenticate?authLevel=recent`,
+				KIzjUBQjKZwMRgYSn6NvMxsUwNppwnLH: `https://www.${baseUrl}/ui-login?force=true`,
+				ouGKxT4mE4wQEKqpfsHSE96c9rHXQqZF: `https://www.${baseUrl}/ui-login?force=true`,


The keys in this object are environment specific, matching the application id in each Auth0 env.

So should they be dynamic as well?

Yes, they will have to be if you want to use this config file across environments.

These are app names in order:
Kiva Admin
partners.dev.kiva.org
Kiva.org php
Ui Server
UI Client

mcstover · 2023-10-04T16:58:57Z

config/dynamic.js

+		oneTrust: {
+			enable: true,
+			key: 'db9dcf94-1c32-40fb-9a57-cefafea1088d',
+			domainSuffix: '-test',


This would need to be an empty string for use in prod.

mcstover · 2023-10-04T17:11:36Z

config/dynamic.js

+				[browserClientID]: `https://www.${baseUrl}/ui-login?force=true`,
+			},
+			enable: true,
+			checkFakeAuth: true,


We would not want this to propagate to prod so it should be false by default and be setup to pass in as true only in lower envs...

The way this is currently handled is that the key isn't defined in the index.js config file so it's false by default. Then the key is only added to lower env config files.

Sorry, I'd mostly been setting this up mimicking the other lower envs, so it was importing from the prod (index.js) file and overriding that. I was picturing that we may do something similar to the current setup where prod is the default (perhaps create a duplicate of index.js for EKS configuration) that is then inherited from and overridden by the lower environments. Because of that, I hadn't really set this up for prod configuration yet. Do you think we should focus on using this dynamic config file for all EKS environments (and thus configure it with prod in mind) or continue with the existing configuration file inheritance pattern in this repo (and possibly spin up the base configuration file for EKS that contains prod values and is inherited by dynamic)?

I am not sure if we want to tackle that problem in this PR (I would personally like it) but I think the end goal should definitely be allowing UI services to be configured entirely via secrets and environment variables, so a dynamic config seems attractive to me. I'll let @JoeTravisKiva chime in in terms of priority.

This seemed to be trending toward something that might get used for all eks deployments so I was just trying to safe guard that incase it was fast tracked into use for prod...

If you want to skip the prod setup for now, I think we should name this file in a way that signifies it's only for lower envs, maybe dynamic-dev.js. It could also be good to startup a dynamic-prod.js for the prod base config which has a few values not present in the files that import it as a base.

I think in terms of fast-tracking to prod, it would still just be EKS prod which is basically a pre-prod environment at the moment. We should still have time to vet it. Totally get what you're saying though. I'd personally prefer to have a global dynamic config (I like the 12-factor philosophy: apps should have no awareness of their environment in their code, or "strict separation of config from code").

@mcstover and @hobbsh I hear you both. I've attempted to update the dynamic config to stand alone and work for prod. I pulled in all the properties that were only in the index file, so we no longer need to merge that in. At this point, pre-prod envs will have to set CHECK_FAKE_AUTH to true to enable that. Let me know if you have any thoughts on the current setup/default values.

(Also, I alphabetized for ease of finding properties. I tried to put that in a separate commit for readability. Let me know if the previous grouping was preferable).

mcstover · 2023-10-04T18:26:22Z

config/dynamic.js

+const formattedUrlEnv = env === 'prod' ? '' : `${env}.`;
+const enableOptimizely = process.env.ENABLE_OPTIMIZELY !== 'false';
+const enablePerimeterx = process.env.ENABLE_PERIMETERX !== 'false';
+const disableCluster = process.env.SERVER_DISABLE_CLUSTER === 'true';


This one can just be set to true now. We always disable cluster most in k8s infra.

feat: [CP-548] Adding config files for EKS stage and dev

5c22586

kathrynlovett requested review from a team October 3, 2023 22:38

JoeTravisKiva reviewed Oct 3, 2023

View reviewed changes

kathrynlovett added 2 commits October 3, 2023 16:29

feat: [CP-548] Generic config that can be overriden

4e43da3

feat: [CP-548] Simplify boolean vars

3319d5d

JoeTravisKiva reviewed Oct 3, 2023

View reviewed changes

kathrynlovett requested a review from JoeTravisKiva October 3, 2023 23:34

JoeTravisKiva reviewed Oct 3, 2023

View reviewed changes

feat: [CP-548] Missing bracket

f9a6f02

kathrynlovett requested a review from JoeTravisKiva October 4, 2023 14:35

feat: [CP-548

7a961f5

] Removing unnecessary staging file

hobbsh reviewed Oct 4, 2023

View reviewed changes

feat: [CP-548] Rename new config file

b42bece

kathrynlovett requested a review from hobbsh October 4, 2023 16:25

mcstover reviewed Oct 4, 2023

View reviewed changes

kathrynlovett added 2 commits October 4, 2023 09:59

feat: [CP-548] Make auth0 app IDs configurable

a19ca40

feat: [CP-548] Make config support configuration for prod

d22726d

kathrynlovett requested a review from mcstover October 4, 2023 17:03

mcstover reviewed Oct 4, 2023

View reviewed changes

kathrynlovett added 2 commits October 4, 2023 10:40

feat: [CP_548] Alphabetize

04f6429

feat: [CP-548] Set up dynamic config to work for prod

342c914

kathrynlovett requested a review from mcstover October 4, 2023 18:05

mcstover reviewed Oct 4, 2023

View reviewed changes

mcstover approved these changes Oct 4, 2023

View reviewed changes

feat: [CP-548] Set disableCluster to true

de2789e

kathrynlovett merged commit d95eee9 into main Oct 4, 2023
1 check passed

kathrynlovett deleted the feat-CP-548-eks-configs branch October 4, 2023 19:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: [CP-548] Adding config files for EKS stage and dev #5009

feat: [CP-548] Adding config files for EKS stage and dev #5009

kathrynlovett commented Oct 3, 2023

JoeTravisKiva left a comment

JoeTravisKiva Oct 3, 2023

kathrynlovett commented Oct 3, 2023

JoeTravisKiva Oct 3, 2023

kathrynlovett Oct 4, 2023

hobbsh Oct 4, 2023

hobbsh Oct 4, 2023

mcstover Oct 4, 2023

kathrynlovett Oct 4, 2023

mcstover Oct 4, 2023

mcstover Oct 4, 2023

mcstover Oct 4, 2023

mcstover Oct 4, 2023

kathrynlovett Oct 4, 2023

hobbsh Oct 4, 2023

mcstover Oct 4, 2023

hobbsh Oct 4, 2023 •

edited

Loading

kathrynlovett Oct 4, 2023

kathrynlovett Oct 4, 2023

mcstover Oct 4, 2023

feat: [CP-548] Adding config files for EKS stage and dev #5009

feat: [CP-548] Adding config files for EKS stage and dev #5009

Conversation

kathrynlovett commented Oct 3, 2023

JoeTravisKiva left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kathrynlovett commented Oct 3, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hobbsh Oct 4, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hobbsh Oct 4, 2023 •

edited

Loading