Document using route prefix #1797
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 #1797 +/- ##
==========================================
- Coverage 79.57% 79.57% -0.01%
==========================================
Files 517 517
Lines 40737 40737
==========================================
- Hits 32418 32417 -1
- Misses 8319 8320 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
jmthomas
approved these changes
Dec 28, 2024
|
|
||
| OPENC3_OPERATOR_HOSTNAME is used to override the default service name for our regular docker compose operator of "openc3-operator". Usually this is not set. | ||
|
|
||
| In OpenC3 Enterprise, KUBERNETES_SERVICE_HOST is used to detect if we are running in a Kubernetes environment (it will be set by Kubernetes), in which case the service is expected to have a Kubernetes service named scope-user-microservicename-service. For example, if you are using the DEFAULT scope and have a microservice named MYMICROSERVICE the service would be found at the hostname: default-user-mymicroservice-service. In double underscores or single underscores are replaced by a dash and the name is all lower case. |
There was a problem hiding this comment.
"In double underscores" ... remove 'In'
|
|
||
| - The microservice will be exposed internally to Docker (Open Source or Enterprise) at: `http://openc3-operator:2905` | ||
| - The microservice will be exposed internally to Kubernetes (Enterprise) at: `http://default-user-cfdp-service:2905` | ||
| - The microservice will be exposed externally to the network at: `http://localhost:2900/cfdp` |
ryan-pratt
approved these changes
Dec 30, 2024
|
|
||
| :::warning Sharded Operator on Kubernetes (Enterprise) | ||
|
|
||
| The sharded operator is expected to be used on Kubernetes whenever the Kubernetes Operator is not used. Typically this will be because the user does not have permission to use the Kubernetes API directly to spawn containers which is required for use of the Kubernetes Operator. In this case, Kubernetes services will NOT be automatically created, and will have to be manually created by a user with permissions in Kubernetes, or through some other authorized method. |
There was a problem hiding this comment.
What are "some other authorized methods?" Is that detailed anywhere?
There was a problem hiding this comment.
This was referencing unique methods to deploy to Kubernetes like in some of our gov contracts.
|
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.
No description provided.