You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: dev-local/README.md
+29-15Lines changed: 29 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,10 @@ The containerized local build should provide a local development experience that
8
8
9
9
These tools assume you are a developer working on the project, and have access to the VPN and other systems.
10
10
11
+
## TL;DR
12
+
13
+
14
+
11
15
## pre-requisites
12
16
13
17
It is assumed you have a *NIX-like shell, and have the ability to run GNU Make or a reasonable fascimilie thereof.
@@ -16,7 +20,7 @@ A Mac, out-of-the-box, should "just work," as well as an Intel-based Linux host.
16
20
17
21
### configuring `kion`
18
22
19
-
*To run the tools, you must be in a `kion` shell. What follows is a way to set up an alias that makes running the correct configuration easier.*
23
+
*To run the tools, you must be in a `kion` shell. What follows is a way to set up an alias that makes running the correct configuration easier. You can also run `kion stak` or `kion s` and navigate the menus to achieve a similar result.*
20
24
21
25
You should already have a `.kion.yaml` in your home directory. If not, follow the [local desktop development](https://confluence.cms.gov/spaces/BB2/pages/484224999/Local+Desktop+Development) onboarding docs to set up Cloudtamer/`kion`.
22
26
@@ -31,7 +35,7 @@ Then add the alias as:
31
35
32
36
```
33
37
favorites:
34
-
- name: BB2-NON-PROD
38
+
- name: bbnp
35
39
account: <account-number>
36
40
cloud_access_role: <cloud-access-role>
37
41
access_type: cli
@@ -40,10 +44,10 @@ favorites:
40
44
If you already have some aliases, you can just add this one to the list. The account number and cloud access role can be obtained from the Cloudtamer dashboard. This is not strictly necessary, as the tooling cannot automate a `kion` call *and* then continue, as `kion` opens a new shell. However, it is much easier (and, for this documentation, the preferred method) to invoke
41
45
42
46
```
43
-
kion f BB2-NON-PROD
47
+
kion f bbnp
44
48
```
45
49
46
-
than to navigate a menu structure. You may ultimately choose a shorter alias, e.g. `kion f bnp`.
50
+
than to navigate a menu structure. You may ultimately choose a shorter alias, e.g. `kion f bbnp`.
47
51
48
52
## to start
49
53
@@ -93,26 +97,36 @@ make run-local bfd=test auth=live
93
97
94
98
Each combination has different implications. Only some make sense at this time (Nov '25):
95
99
96
-
|bfd / auth |mock | live |
100
+
|| auth=mock |auth=live |
97
101
| --- | --- | --- |
98
-
| local | local unit tests | testing SLSX sequences |
99
-
| test | ⛔ | Full-up against `test`|
100
-
| sbx | ⛔ | Full-up against `sbx`|
102
+
|**bfd=local**| local unit tests | testing SLSX sequences |
103
+
|**bfd=test**| ⛔ | Full-up against `test`|
104
+
|**bfd=sbx**| ⛔ | Full-up against `sbx`|
101
105
102
106
*`local/mock`: This makes sense for running unit tests; only local tests will run in this configuration.
103
-
*`local/live`: Manual testing of SLSX sequences should be able to be performed with this combination (TBD)
104
-
*`test/mock`: Not a valid condition; a mock authentication will not work with a live server.
107
+
*`local/live`: Manual testing of SLSX sequences should be able to be performed with this combination. No BFD/FHIR URLs are set, though, which may break things.
108
+
*`test/mock`: *Not a valid condition*; a mock authentication will not work with a live server.
105
109
*`test/live`: Live SLSX exchanges with medicare.gov and calls against the `test` BFD environment.
106
-
*`sbx/mock`: Not a valid condition.
110
+
*`sbx/mock`: *Not a valid condition*.
107
111
*`sbx/live`: Live SLSX exchanges and calls against the `sbx` BFD environment.
108
112
109
113
114
+
### running daemonized
115
+
116
+
You cann add `daemon=1` to any of the above commands, and the stack will run in the background.
117
+
118
+
For example:
119
+
120
+
```
121
+
make run-local bfd=test auth=live daemon=1
122
+
```
123
+
110
124
### running against `test`
111
125
112
126
When launched with
113
127
114
128
```
115
-
make run-local TARGET=test
129
+
make run-local bfd=test auth=live
116
130
```
117
131
118
132
the tooling obtains and sources credentials for running against our `test` environment.
@@ -122,7 +136,7 @@ the tooling obtains and sources credentials for running against our `test` envir
122
136
Similarly,
123
137
124
138
```
125
-
make run-local TARGET=sbx
139
+
make run-local bfd=sbx auth=live
126
140
```
127
141
128
142
runs against SBX.
@@ -135,9 +149,9 @@ runs against SBX.
135
149
136
150
In a nutshell:
137
151
138
-
1. Run `kion f BB2-NON-PROD` to authenticate/obtain AWS credentials.
152
+
1. Run `kion f bbnp` to authenticate/obtain AWS credentials.
139
153
1. Obtain certificates for the remote environment (if you selected `test` or `sbx`)
140
-
1.`docker compose --profile mock-sls up` for `local`, `docker compose --profile slsx up` for live envs.
154
+
1.Pass appropriate env vars through to the app, based on choices.
0 commit comments