-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Initial checkin of Service docs (aka "Steve") * Partial checkpoint on updating spec * Add service to images Adds Service to images * Update the rest of examples * Reorder errors to group logically into deployment and routing errors. Introduce Service error documentation, and structure error blocks to show how Service aggregates errors from Route and Configuration. * Address small comments from @vaikas-google and @mattmoor. Did not refactor service.pinned behavior.
- Loading branch information
1 parent
46209e1
commit af12226
Showing
16 changed files
with
722 additions
and
389 deletions.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# API Objects - Service | ||
|
||
* Orchestrates Routes and Configurations to support higher-level tooling. | ||
* Configuration of code + inbound routing in a single API call. | ||
* Definition of specific common rollout policies | ||
* Automatic (latest) rollout | ||
* Manual rollout | ||
* Extensible for other rollout strategies which might be requested | ||
* Provides a top-level resource for graphical UI to key off of. | ||
* Recommended starting point for Elafros use, as it provides "guide rails" to avoid unusual and non-idiomatic usage. | ||
* Mirrors labels and annotations to the created objects. | ||
* Advanced scenarios may require disconnecting the Service ownership of the created Route and Configuration. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
# Code layout - Controller | ||
|
||
* ./pkg/controller/{route,configuration,revision}/controller.go | ||
* sync_handler the main method for reconcile | ||
* `./pkg/controller/{configuration,revision,route,service}/controller.go` | ||
* `sync_handler` is the main method for reconcile | ||
* Other resource creation broken into their own files in those directories | ||
* Communicates information via [resource].status field | ||
* Communicates information via `[resource].status` field |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,11 @@ | ||
# Code layout - Webhook | ||
|
||
* ./pkg/webhook/webhook.go | ||
* `./pkg/webhook/webhook.go` | ||
* All the generic mutations / validations | ||
* Serialization / deserialization | ||
* Calls into resource specific validation / mutation | ||
* ./pkg/webhook/{route,revision,configuration} | ||
* `./pkg/webhook/{configuration,revision,route,service}` | ||
* Mutations specified with an array of jsonpatch objects | ||
* ./pkg/webhook/certs.go | ||
* `./pkg/webhook/certs.go` | ||
* CA / Server cert | ||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
Oops, something went wrong.