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
chore: bump manifets to version 1.3.0 for BoS (#17)
* fix: wrong app name in frontend service yaml
* chore: update manifests for 1.3.0 release
* chore: update all necessary files for v1.3.0
* fix: remove backup files from commit
* chore: update all necessary files for v1.3.0
* fix: remove backup files from commit
Copy file name to clipboardExpand all lines: README.md
+23-9Lines changed: 23 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,31 +2,45 @@
2
2
3
3
# Bank of Sirius
4
4
5
-
6
-
**Bank of Sirius** is a open source fork of [**Bank of Anthos**](https://github.com/nginxinc/bank-of-anthos). This project
7
-
improves upon **Bank of Anthos** by adding additional telemetry, instrumentation, performance tuning, upgraded libraries, and more.
8
-
The intention is for it to me a more *productionized* example.
5
+
**Bank of Sirius** is a open source fork of [**Bank of Anthos**](https://github.com/nginxinc/bank-of-anthos). This
6
+
project improves upon **Bank of Anthos** by adding additional telemetry, instrumentation, performance tuning, upgraded
7
+
libraries, and more. The intention is for it to me a more *productionized* example.
9
8
10
9
## Project
11
10
12
-
13
-
**Bank of Sirius** is a sample HTTP-based web app that simulates a bank's payment processing network, allowing users to create artificial bank accounts and complete transactions.
11
+
**Bank of Sirius** is a sample HTTP-based web app that simulates a bank's payment processing network, allowing users to
12
+
create artificial bank accounts and complete transactions.
14
13
15
14
If you’re using this app, please ★Star the repository to show your interest!
16
15
17
16
## Important Note
18
-
This repository is intended to be used with the NGINX Modern Application Architecture (MARA) project [kic-reference-architectures](https://github.com/nginxinc/kic-reference-architectures). This includes modifications to the deployment process, as well as the inclusion of OTEL elements that work with the above project.
19
17
20
-
If you wish to run this outside of the NGINX MARA project you may run into issues, so it is recommended in this case you either fork this project or the original [Google Bank of Anthos](https://github.com/GoogleCloudPlatform/bank-of-anthos) project.
18
+
This repository is intended to be used with the NGINX Modern Application Architecture (MARA)
19
+
project [kic-reference-architectures](https://github.com/nginxinc/kic-reference-architectures). This includes
20
+
modifications to the deployment process, as well as the inclusion of OTEL elements that work with the above project.
21
+
22
+
If you wish to run this outside of the NGINX MARA project you may run into issues, so it is recommended in this case you
23
+
either fork this project or the original [Google Bank of Anthos](https://github.com/GoogleCloudPlatform/bank-of-anthos)
24
+
project.
21
25
26
+
### Release Process
27
+
This process is intended to be used for releases that are intended to be used with the NGINX Modern Application
28
+
Architecture (MARA) project [kic-reference-architectures](https://github.com/nginxinc/kic-reference-architectures). If
29
+
you are using a forked version of MARA you will want to examine the [GNUMakefile](./GNUmakefile) and adjust your
30
+
repository or other targets as required.
31
+
32
+
1. Set the version: `make version-set`.
33
+
2. Update the maven files: `make update-maven-versions`
34
+
3. Update the manifest files: `make update-manifest-image-versions`
35
+
4. Build the docker images: `make docker-all-images`
36
+
5. Push the resulting images to the container registry: `make release`
2.[GNU Make 4.x](https://www.gnu.org/software/make/)
16
16
5.[JDK **8**](https://www.azul.com/downloads/?package=jdk) (newer versions might cause issues)
17
17
6.[Maven **3.6**](https://downloads.apache.org/maven/maven-3/) (newer versions might cause issues)
18
18
19
19
## Makefile Targets
20
20
21
-
The following code block shows the valid targets for the make process. Most of these options are self-explanatory, but to completely build the application one can run `make docker-all-images`. To push the new versions to the defined registry, you can run `make release`. Note that this assumes you have the appropriate permissions to push to the defined registry.
21
+
The following code block shows the valid targets for the make process. Most of these options are self-explanatory, but
22
+
to completely build the application one can run `make docker-all-images`. To push the new versions to the defined
23
+
registry, you can run `make release`. Note that this assumes you have the appropriate permissions to push to the defined
24
+
registry.
22
25
23
26
```
24
27
checkstyle Run all code style checks
@@ -44,36 +47,45 @@ version Outputs the current version
44
47
version-update Prompts for a new version
45
48
```
46
49
47
-
## Adding External Packages
50
+
## Adding External Packages
48
51
49
-
### Python
52
+
### Python
50
53
51
-
If you're adding a new feature that requires a new external Python package in one or more services (`frontend`, `contacts`, `userservice`), you must regenerate the `requirements.txt` file using `piptools`. This is what the Python Dockerfiles use to install external packages inside the containers.
54
+
If you're adding a new feature that requires a new external Python package in one or more services (`frontend`
55
+
, `contacts`, `userservice`), you must regenerate the `requirements.txt` file using `piptools`. This is what the Python
56
+
Dockerfiles use to install external packages inside the containers.
52
57
53
-
To add a package:
58
+
To add a package:
54
59
55
60
1. Add the package name to `requirements.in` within the `src/<service>` directory:
56
61
57
-
2. Then run the make target `python-preproc-requirements`. This will transform all Python projects' `requirements.in` files to `requirements.txt` if there have been changes to the `requirements.in` file.
62
+
2. Then run the make target `python-preproc-requirements`. This will transform all Python projects' `requirements.in`
63
+
files to `requirements.txt` if there have been changes to the `requirements.in` file.
58
64
59
-
3. Re-run `make` with the appropriate target for your build. To build just the python packages you can run `make docker-python-images`
65
+
3. Re-run `make` with the appropriate target for your build. To build just the python packages you can
66
+
run `make docker-python-images`
60
67
68
+
### Java
61
69
62
-
### Java
70
+
If you're adding a new feature to one or more of the Java services (`ledgerwriter`, `transactionhistory`
71
+
, `balancereader`) and require a new third-party package, do the following:
63
72
64
-
If you're adding a new feature to one or more of the Java services (`ledgerwriter`, `transactionhistory`, `balancereader`) and require a new third-party package, do the following:
65
-
66
-
1. Add the package to the `pom.xml` file in the `src/<service>` directory, under `<dependencies>`. You can find specific package info in [Maven Central](https://search.maven.org/) ([example](https://search.maven.org/artifact/org.postgresql/postgresql/42.2.16.jre7/jar)). Example:
73
+
1. Add the package to the `pom.xml` file in the `src/<service>` directory, under `<dependencies>`. You can find specific
74
+
package info
75
+
in [Maven Central](https://search.maven.org/) ([example](https://search.maven.org/artifact/org.postgresql/postgresql/42.2.16.jre7/jar))
76
+
. Example:
67
77
68
78
```
69
79
<dependency>
70
80
<groupId>org.postgresql</groupId>
71
81
<artifactId>postgresql</artifactId>
72
82
</dependency>
73
83
```
74
-
3. Re-run `make` with the appropriate target for your build. To build just the java packages you can run `make docker-java-images`
75
84
85
+
3. Re-run `make` with the appropriate target for your build. To build just the java packages you can
86
+
run `make docker-java-images`
76
87
77
88
## Continuous Integration
78
89
79
-
Github actions are used for continuous integration (CI) for this project. Due to time constrains we have been unable to reimplement the UI tests and deployment tests in the fork.
90
+
Github actions are used for continuous integration (CI) for this project. Due to time constrains we have been unable to
91
+
reimplement the UI tests and deployment tests in the fork.
0 commit comments