Add developer docs to README #64
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
cmurphy
force-pushed
the
docs
branch
4 times, most recently
from
6d6d4c6
to
b089f4c
Compare
cmurphy
force-pushed
the
docs
branch
3 times, most recently
from
d73bf60
to
dc6ef8d
Compare
cmurphy
force-pushed
the
docs
branch
2 times, most recently
from
cced855
to
d175cde
Compare
KevinJoiner
approved these changes
Jun 26, 2023
rmweir
suggested changes
Aug 30, 2023
README.md
Outdated
| The default schema additionally wraps this proxy store in | ||
| [`metrics.Store`](https://pkg.go.dev/github.com/rancher/steve/pkg/stores/metrics#Store), | ||
| which records request metrics to Prometheus, by calling | ||
| [`metrics.NewNetricsStore`](https://pkg.go.dev/github.com/rancher/steve/pkg/stores/metrics#NewMetricsStore) |
There was a problem hiding this comment.
Suggested change
| [`metrics.NewNetricsStore`](https://pkg.go.dev/github.com/rancher/steve/pkg/stores/metrics#NewMetricsStore) | |
| [`metrics.NewMetricsStore`](https://pkg.go.dev/github.com/rancher/steve/pkg/stores/metrics#NewMetricsStore) |
README.md
Outdated
Comment on lines
381
to
386
| return types.APIObject{ | ||
| Object: map[string]string{ | ||
| "value": "[redacted]", | ||
| }, | ||
| }, nil |
There was a problem hiding this comment.
nit: I think In this case we'd still include the name.
README.md
Outdated
Comment on lines
431
to
433
| As another example, if you wanted to add custom field to all objects in a | ||
| collection response, you can add a schema template with a collection formatter | ||
| omit the ID or the group and kind: |
There was a problem hiding this comment.
Suggested change
| As another example, if you wanted to add custom field to all objects in a | |
| collection response, you can add a schema template with a collection formatter | |
| omit the ID or the group and kind: | |
| As another example, if you wanted to add custom field to all objects in a | |
| collection response, you can add a schema template with a collection formatter | |
| to omit the ID or the group and kind: |
Comment on lines
+643
to
+653
| Rancher implements aggregation for other types of services as well. In Rancher, | ||
| the user can define endpoints via a | ||
| [v3.APIService](https://pkg.go.dev/github.com/rancher/rancher/pkg/apis/management.cattle.io/v3#APIService) | ||
| custom resource (which is distinct from the built-in Kubernetes | ||
| [v1.APIService](https://kubernetes.io/docs/reference/kubernetes-api/cluster-resources/api-service-v1/) | ||
| resource. Then Rancher runs a middleware handler that routes incoming requests | ||
| to defined endpoints. The external services follow the same process of using a | ||
| defined secret containing a URL and token to connect and authenticate to | ||
| Rancher. This aggregation is defined independently and does not use steve's | ||
| aggregation client. |
There was a problem hiding this comment.
Nit: feels like this portion could just be in the rancher README.md.
There was a problem hiding this comment.
We could add it there as well, but I and others have been confused about "steve aggregation" and what it really means, since there is a significant amount of code in steve dedicated to this not-steve functionality, so I prefer to keep it here.
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.
rancher/rancher#38593