Adding a new service documentation #73
Open
+628
−167
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adding a story about how to add new services. This will help guide the devs as we add new services to Jemison.
selfdanielj
reviewed
Jan 6, 2025
| @@ -44,3 +44,6 @@ flowchart LR | |||
| At this point, further services clean, process, and prepare the text for search. | |||
|
|
|||
| Read more about the [data processing pipeline](processing.md). | |||
|
|
|||
| ## administration via API | |||
|
|
|||
There was a problem hiding this comment.
was there meant to be something else here? this is a heading without anything.
Comment on lines
+153
to
+165
| ``` | ||
| var ThisServiceName = "searchapi" | ||
|
|
||
| func main() { | ||
| env.InitGlobalEnv(ThisServiceName) | ||
| engine := common.InitializeAPI() | ||
|
|
||
| zap.L().Info("listening to the music of the spheres", | ||
| zap.String("port", env.Env.Port)) | ||
| // Local and Cloud should both get this from the environment. | ||
| http.ListenAndServe(":"+env.Env.Port, engine) | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Maybe add an In main.go like in add job_creator section?
There was a problem hiding this comment.
Is this code meant to replace the WaitGroup boilerplate from above or add to it?
|
|
||
| We may want to consider having some global constants for service names, instead of strings. However, there's no way to make that constant work across the config files and the applications, so... :shrug:. We use strings for the moment. | ||
|
|
||
| It should now be possible to stand up the stack with the new service, and have it respond to healthchecks. The common API initialization establishes a basic healthcheck for every single service. We need this so that Cloud.gov will be able to tell if our services are alive/responding. |
There was a problem hiding this comment.
if running through make docker macup don't we need a run.sh or similar entrypoint?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PRs at this point do not yet have a full guide template, and are against a system that is not yet production-ready.
This commit is documentation only. It moves some pieces around, and most importantly, adds a document that describes how to add a new service. It is reasonably complete, having been guided by the bringing together of a new service (
e2e), which could provide a starting point for a local/in-stack, repeatable path to end-to-end tests. That service is not complete, but standing up the shell/boilerplate guided this documentation.