Add Key Concepts page #950
Merged
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #950 +/- ##
==========================================
+ Coverage 75.70% 75.73% +0.02%
==========================================
Files 620 620
Lines 43741 43744 +3
Branches 878 878
==========================================
+ Hits 33114 33129 +15
+ Misses 10532 10521 -11
+ Partials 95 94 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
closes #961 |
ryanmelt
requested changes
Dec 9, 2023
|
|
||
| ## Projects | ||
|
|
||
| The main COSMOS [repo](https://github.com/OpenC3/cosmos) contains all the source code used to build and run COSMOS. However, users (not developers) of COSMOS should use the COSMOS [project](https://github.com/OpenC3/cosmos-project) to launch COSMOS. The project consists of the [openc3.sh](https://github.com/OpenC3/cosmos-project/blob/main/openc3.sh) and [openc3.bat](https://github.com/OpenC3/cosmos-project/blob/main/openc3.bat) files for starting and stopping COSMOS, the [compose.yaml](https://github.com/OpenC3/cosmos-project/blob/main/compose.yaml) for configuring the COSMOS containers, and the [.env](https://github.com/OpenC3/cosmos-project/blob/main/.env) file for setting runtime variables. |
There was a problem hiding this comment.
Additionally it contains user modifiable config files for both Redis and Traefik.
| | [openc3-base](https://github.com/OpenC3/cosmos/blob/main/openc3/Dockerfile) | Builds on openc3-ruby and includes all the COSMOS source code | | ||
| | [openc3-node](https://github.com/OpenC3/cosmos/blob/main/openc3-node/Dockerfile) | Builds on openc3-base and includes NodeJS for COSMOS frontend development | | ||
| | [openc3-cosmos-init](https://github.com/OpenC3/cosmos/blob/main/openc3-cosmos-init/Dockerfile) | Builds on openc3-node, copies all the COSMOS tools and builds them | | ||
| | [openc3-operator](https://github.com/OpenC3/cosmos/blob/main/openc3-operator/Dockerfile) | Sets up the base image to run microservice_operator.rb | |
There was a problem hiding this comment.
Inconsistent - does not mention builds on openc3-base
| | cosmos-enterprise-openc3-metrics-1 | Rails server that provides metrics on COSMOS performance | | ||
| | cosmos-enterprise-openc3-keycloak-1 | Single-Sign On service for authentication | | ||
| | cosmos-enterprise-openc3-postgresql-1 | SQL Database for use by Keycloak | | ||
|
|
There was a problem hiding this comment.
Also includes nfs in Kubernetes.
| | cosmos-openc3-minio-1 | Provides a S3 like bucket storage interface and also serves as a static webserver for the tool files | | ||
| | cosmos-openc3-traefik-1 | Provides a reverse proxy and load balancer with routes to the COSMOS endpoints | | ||
|
|
||
| The image list for [Enterprise COSMOS](https://openc3.com/enterprise) consists of the following: |
|
Kudos, SonarCloud Quality Gate passed!
|
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.
I'll need to regenerate the site before merge but check this out and let me know what you think. This is the result of a few recent discussions we've had about confusion about the architecture and things we're doing.
closes #816