-
Notifications
You must be signed in to change notification settings - Fork 246
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merge submodules #2654
base: integration
Are you sure you want to change the base?
Merge submodules #2654
Changes from all commits
1f96d1a
c5ed797
342deba
ed41c73
6f03263
10f3c6c
88f9ea3
5006bea
4632c3c
037d4b0
a4e7047
495a494
c5861a0
97d7ba1
4207b81
4197425
a998ec6
84118fe
9c4cb96
5de15ca
28f4951
5b0f7db
f153b52
3c95341
aeef6cc
6f42aab
8ec75c0
16261fb
ea39a27
a9278cd
c868816
aac3eb4
21470e7
95b22f7
f147983
e8032dd
4bc062f
cde0b9c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,90 +0,0 @@ | ||
[submodule "microservices/services/authorization"] | ||
path = microservices/services/authorization | ||
url = [email protected]:NationalSecurityAgency/datawave-authorization-service.git | ||
[submodule "core/in-memory-accumulo"] | ||
path = core/in-memory-accumulo | ||
url = [email protected]:NationalSecurityAgency/datawave-in-memory-accumulo.git | ||
[submodule "core/utils/accumulo-utils"] | ||
path = core/utils/accumulo-utils | ||
url = [email protected]:NationalSecurityAgency/datawave-accumulo-utils.git | ||
[submodule "core/utils/common-utils"] | ||
path = core/utils/common-utils | ||
url = [email protected]:NationalSecurityAgency/datawave-common-utils.git | ||
[submodule "core/base-rest-responses"] | ||
path = core/base-rest-responses | ||
url = [email protected]:NationalSecurityAgency/datawave-base-rest-responses.git | ||
[submodule "core/utils/type-utils"] | ||
path = core/utils/type-utils | ||
url = [email protected]:NationalSecurityAgency/datawave-type-utils.git | ||
[submodule "core/utils/metadata-utils"] | ||
path = core/utils/metadata-utils | ||
url = [email protected]:NationalSecurityAgency/datawave-metadata-utils.git | ||
[submodule "microservices/services/accumulo"] | ||
path = microservices/services/accumulo | ||
url = [email protected]:NationalSecurityAgency/datawave-accumulo-service.git | ||
[submodule "microservices/services/dictionary"] | ||
path = microservices/services/dictionary | ||
url = [email protected]:NationalSecurityAgency/datawave-dictionary-service.git | ||
[submodule "microservices/services/audit"] | ||
path = microservices/services/audit | ||
url = [email protected]:NationalSecurityAgency/datawave-audit-service.git | ||
[submodule "microservices/services/query-metric"] | ||
path = microservices/services/query-metric | ||
url = [email protected]:NationalSecurityAgency/datawave-query-metric-service.git | ||
[submodule "core/metrics-reporter"] | ||
path = core/metrics-reporter | ||
url = [email protected]:NationalSecurityAgency/datawave-metrics-reporter.git | ||
[submodule "microservices/starters/cache"] | ||
path = microservices/starters/cache | ||
url = [email protected]:NationalSecurityAgency/datawave-spring-boot-starter-cache.git | ||
[submodule "microservices/starters/datawave"] | ||
path = microservices/starters/datawave | ||
url = [email protected]:NationalSecurityAgency/datawave-spring-boot-starter.git | ||
[submodule "microservices/services/hazelcast"] | ||
path = microservices/services/hazelcast | ||
url = [email protected]:NationalSecurityAgency/datawave-hazelcast-service.git | ||
[submodule "microservices/starters/metadata"] | ||
path = microservices/starters/metadata | ||
url = [email protected]:NationalSecurityAgency/datawave-spring-boot-starter-metadata.git | ||
[submodule "microservices/starters/query-metric"] | ||
path = microservices/starters/query-metric | ||
url = [email protected]:NationalSecurityAgency/datawave-spring-boot-starter-query-metric.git | ||
[submodule "microservices/starters/audit"] | ||
path = microservices/starters/audit | ||
url = [email protected]:NationalSecurityAgency/datawave-spring-boot-starter-audit.git | ||
[submodule "microservices/services/config"] | ||
path = microservices/services/config | ||
url = [email protected]:NationalSecurityAgency/datawave-config-service.git | ||
[submodule "microservices/microservice-parent"] | ||
path = microservices/microservice-parent | ||
url = [email protected]:NationalSecurityAgency/datawave-parent.git | ||
[submodule "microservices/microservice-service-parent"] | ||
path = microservices/microservice-service-parent | ||
url = [email protected]:NationalSecurityAgency/datawave-service-parent.git | ||
[submodule "contrib/datawave-utils"] | ||
path = contrib/datawave-utils | ||
url = [email protected]:NationalSecurityAgency/datawave-utils.git | ||
[submodule "microservices/starters/query"] | ||
path = microservices/starters/query | ||
url = [email protected]:NationalSecurityAgency/datawave-spring-boot-starter-query.git | ||
[submodule "microservices/services/query"] | ||
path = microservices/services/query | ||
url = [email protected]:NationalSecurityAgency/datawave-query-service.git | ||
[submodule "microservices/services/query-executor"] | ||
path = microservices/services/query-executor | ||
url = [email protected]:NationalSecurityAgency/datawave-query-executor-service.git | ||
[submodule "microservices/services/modification"] | ||
path = microservices/services/modification | ||
url = [email protected]:NationalSecurityAgency/datawave-modification-service.git | ||
[submodule "microservices/services/mapreduce-query"] | ||
path = microservices/services/mapreduce-query | ||
url = [email protected]:NationalSecurityAgency/datawave-mapreduce-query-service.git | ||
[submodule "microservices/starters/cached-results"] | ||
path = microservices/starters/cached-results | ||
url = [email protected]:NationalSecurityAgency/datawave-spring-boot-starter-cached-results.git | ||
[submodule "microservices/services/map"] | ||
path = microservices/services/map | ||
url = [email protected]:NationalSecurityAgency/datawave-map-service.git | ||
[submodule "microservices/services/file-provider"] | ||
path = microservices/services/file-provider | ||
url = [email protected]:NationalSecurityAgency/datawave-file-provider-service.git | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,42 +19,74 @@ Basic build instructions are [here](BUILDME.md) | |
|
||
## How to Use this Repository | ||
|
||
The microservices and associated utility projects are intended to be | ||
developed, versioned, and released independently and as such are stored | ||
in separate repositories. This repository includes them all as submodules | ||
in order to provide an easy way to import them all in an IDE for viewing | ||
the code, or refactoring. [Git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) | ||
require some extra commands over the normal ones that one may be familiar | ||
with. | ||
|
||
### Cloning with all submodules | ||
Cloning with all of the submodules is not required; however, if you are interested in checking | ||
out and building all of the datawave projects under one repo, read this! | ||
|
||
It's easiest to clone the repository pointing the submodules at the same branch | ||
```bash | ||
# Start out by cloning the project as you normally would. | ||
git clone [email protected]:NationalSecurityAgency/datawave.git | ||
|
||
# Now, use git to retrieve all of the datawave submodules. | ||
# This will leave your submodules in a detached head state. | ||
cd datawave | ||
git submodule update --init --recursive | ||
|
||
# You can checkout the main branch for each submodule so that you are no longer in a detached head state. | ||
# The addition of `|| :` will ensure that the command is executed for each submodule, | ||
# ignoring failures for submodules that don't have a main branch. | ||
git submodule foreach 'git checkout main || :' | ||
|
||
# It is recommended to build the project using multiple threads. | ||
mvn -Pdocker,dist clean install -T 1C | ||
The microservices and associated utility projects are intended to be developed, versioned, | ||
and released independently. The following subdirectories contain those independently | ||
versioned modules: | ||
|
||
``` | ||
core/utils/type-utils | ||
contrib/datawave-utils | ||
core/base-rest-responses | ||
core/in-memory-accumulo | ||
core/metrics-reporter | ||
core/utils/accumulo-utils | ||
core/utils/common-utils | ||
core/utils/metadata-utils | ||
microservices/microservice-parent | ||
microservices/microservice-service-parent | ||
microservices/starters/audit | ||
microservices/starters/cache | ||
microservices/starters/cached-results | ||
microservices/starters/datawave | ||
microservices/starters/metadata | ||
microservices/starters/query | ||
microservices/starters/query-metric | ||
microservices/services/accumulo | ||
microservices/services/audit | ||
microservices/services/authorization | ||
microservices/services/config | ||
microservices/services/dictionary | ||
microservices/services/file-provider | ||
microservices/services/hazelcast | ||
microservices/services/map | ||
microservices/services/mapreduce-query | ||
microservices/services/modification | ||
microservices/services/query | ||
microservices/services/query-executor | ||
microservices/services/query-metric | ||
``` | ||
|
||
# If you don't want to build the microservices, you can skip them. | ||
mvn -Pdocker,dist -DskipMicroservices clean install -T 1C | ||
Each of those subdirectories contain a .gitrepo file that keeps track of where the code came from. | ||
|
||
# If you decide that you no longer need the submodules, you can remove them. | ||
git submodule deinit --all | ||
### Updating one of the datawave sub-repositories | ||
At one point we used submodules to link in a all of the sub-repositories. We have now switched | ||
to including the submodules' code directly into the main datawave repository. The git subrepo | ||
mechanism (https://github.com/ingydotnet/git-subrepo) was used to facilitate the transition. | ||
That same mechanism can be used to pull in changes from the other repositories as needed until | ||
they can be removed altogether. The original cloning of the sub repositories was done using | ||
the subrepo command as follows: | ||
``` | ||
git subrepo clone <repo> <dir> | ||
``` | ||
If changes need to be pulled in, then the following process can be used: | ||
``` | ||
git subrepo pull <dir> | ||
``` | ||
### Building | ||
|
||
It is recommended to build the project using multiple threads. This will not build the starters, utilities, and services. | ||
``` | ||
mvn -Pdocker,dist clean install -T 1C | ||
``` | ||
|
||
If you want to build the starters, util modules, and services as well then try this | ||
``` | ||
mvn -Pdocker,dist -Dstarters -Dservices -Dutils clean install -T 1C | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This says "if you dont want to build..." but the command adds the properties to build them. Did you mean "if you want to" There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ah, this one was in error.... fixing |
||
``` | ||
If you want to build the service apis but not the services themselveds then add -DonlyServiceApis | ||
|
||
NOTE: The util modules, starters, and services are actually tagged and deployed separately. | ||
Hence the snapshot versions within those sub repos are not connected together. | ||
|
||
### DataWave Microservices | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
target/ | ||
|
||
.idea/ | ||
*.iml | ||
*.iws | ||
|
||
.classpath | ||
.project | ||
.settings/ |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
; DO NOT EDIT (unless you know what you are doing) | ||
; | ||
; This subdirectory is a git "subrepo", and this file is maintained by the | ||
; git-subrepo command. See https://github.com/ingydotnet/git-subrepo#readme | ||
; | ||
[subrepo] | ||
remote = [email protected]:NationalSecurityAgency/datawave-utils.git | ||
branch = main | ||
commit = 4348fc36a3519ca9e5d1b96ac47c3f0b64abe34b | ||
parent = 1f96d1af84c45f32007da0105b8eab514ec3f7d3 | ||
method = merge | ||
cmdver = 0.4.9 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know this is commented out, but in the before it was specifically skipping services. Why are we now not skipping services?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is correct here. See the comment at the top of this comment block. This build was intended to build all of the starters, utilities, and service apis which is achieved with -Dstarters -Dservices -Dutils -DonlyServiceApis