Diego API documentation should be more easily discoverable #58
Comments
|
We have created an issue in Pivotal Tracker to manage this. You can view the current status of your issue at: https://www.pivotaltracker.com/story/show/97939766. |
|
Hi, @shalako, Thanks very much for your feedback. The diego-release README now links to the receptor API docs on GitHub, towards the top of the document. Is that sufficiently discoverable? As you requested in #56, we'll shortly be improving the documentation for operators deploying a stable or metastable diego-release alongside a given CF version. Thanks again, |
|
Much better. Thank you. |
jfmyers9
pushed a commit
that referenced
this issue
Mar 2, 2016
Submodule src/github.com/pkg/sftp cbc2879..e84cc8c: > Merge pull request #85 from pkg/rootdir > Merge pull request #81 from pkg/server-option > Merge pull request #80 from pkg/functional-options > Merge pull request #78 from pkg/server-readonly > Merge pull request #79 from pkg/readme-badges > Merge pull request #77 from pkg/namedreturns > Merge pull request #75 from pkg/golint > Merge pull request #73 from mdlayher/golint > Merge pull request #74 from LiterallyElvis/master > Merge pull request #72 from mdlayher/master > Merge pull request #70 from pkg/fixedbugs/69 > Merge pull request #67 from mdlayher/master > Merge pull request #64 from pkg/fixedbugs/28 > Merge pull request #63 from pkg/fixedbugs/5 > Merge pull request #61 from pkg/add-travis > Merge pull request #62 from xiu/bugfix/35-cant-remove-directories-on-servu > Merge pull request #58 from sykesm/client-realpath > Merge pull request #60 from pkg/fixedbugs/57 > updated contribution guidelines Signed-off-by: James Myers <jmyers@pivotal.io>
bdshroyer
pushed a commit
that referenced
this issue
Feb 21, 2017
Submodule src/code.cloudfoundry.org/guardian af786aa..0272c51:
> Refactor the rootfs_test
> Ensure tests use correct client after restartGarden
> Make fake network plugin name consistent
> Don't log spurious errors on server start
> Ensure test kills correct garden server
> Fix flakes caused by gqts not stopping garden
> Assert file closed for both Go 1.7 and 1.8
> add integration tests for cases where apparmor is disabled
> Allow NetIn config at container creation time
> Make setup tests not interfere with rest of GQT
> use idmapper package to determine max UID and GID
> Fail if image requires credential and image plugin is not used
> Can use image credentials with image plugin
> remove todo that had already been completed
> iptables fix race condition
> Allow NetOut operations at container creation time
> Extend test coverage for the root case and cleanup
> gdn server --skip-setup runs process as non-root user
> Add --skip-setup flag to server command
> Add iptables starter
> Add BulkStarter and CgroupStarter
> Add cgroup starter to gdn setup command
> Ensure gdn still runs without a sub command
> Split GuardianCommand into Server and Setup
> Add handle as a comment to iptables rules
> Small fix to iptables test
> Ensure dadoo logs always get sent to guardian
> dadoo logs in logfmt format
> stop leaking dadoo stdout/stderr FD from ExecRunner
> ExecRunner send dadoo output to file in process dir
> Remove {the-secret,inspector}-garden
> Remove unused -uid and -gid flags
> Don't try to capture dadoo stderr (yet)
> Remove unneeded comment
> Return meaningful error if dadoo exits/panics before runc starts
> Make sure kill the process when setup TTY fails
> Add --console-sockets-path to guardiancommand
> Little refactor of the panic test
> Add a test for SockDirPath length
> Rename runcStartCmd -> runcExecCmd
> Initial work on bumping runc to 477c75 (from fork)
> bump iptables' tests eventually timeout
> Don't use a static name for the test net ns
> Add Image property to ContainerSpec
> Support 'standalone' mode for gdn command
> Move cmd/guardian -> cmd/gdn
> Remove id mapping flags from call to image plugin
> Ensure image plugin runs as Garden user
> Rework the image plugin
> Adapt port pool test for 8 parallel nodes
> Merge branch '136770727-default_container_rootfs_flag'
> Reduce port range size to make room for 8 ginkgo nodes in gqt
> Pass logger through to local fetcher
> Add `image_plugin_extra_args` and `privileged_image_plugin_extra_args` properties
> Prevent Deadlock when runc writes lots to pipes
> Add NOTICE
> Don't start debug server by default
> Rename pid limit │···············································
> Introduce pidlimits to limit processes in a container
> Add --iptables-restore flag
> Add edge case test for runc
> Revert "Fix unmounting loop devices on 4.4"
> Fix external plugin test
> Merge branch 'image-plugin-tags'
> Fix compilation error
> Relog imageplugin logs
> Merge branch 'image-plugin-exclusive-quotas'
> Rename grootfs `metrics` command to `stats`
> Improve BulkNetOut test description
> Merge branch 'bulk-net-out-133632317' of https://github.com/cf-container-networking/guardian
> Merge branch 'external-image-envvars'
> Fix unmounting loop devices on 4.4
> Append imageplugin output to the returned error
> Merge pull request #60 from cloudfoundry/imageplugin-metrics
> Merge pull request #58 from cloudfoundry/image-plugin-gc
> remove unneded line
> Do not propagate additional groups
> Update runc
> Merge branch 'fix-integrootion'
> ExternalNetworker BulkNetOut propagates to NetOut
> Ensure BulkNetOut works concurrently
> Use BulkPrepend to increase iptables speed
> Improve performance of BulkNetOut
> Add BulkNetOut
> Run image plugin as container user
> Pass image plugin --default-rootfs if not in spec
> Truncate hostname when longer then 49 characters
> Pass uid/gid mappings to image plugin when unprivileged
> Make sure guardian trims imageplugin output
> Return rootfs path on ExternalImageManager create
Submodule src/code.cloudfoundry.org/inigo c02cf00..3484e91:
> Modify GardenRunner call to use updated version of guardian.
mariash
added a commit
that referenced
this issue
Dec 2, 2021
Submodule src/code.cloudfoundry.org/executor ea8d6a952..d0eafcd6c: > Add TLS listener with app internal routes in SAN to Envoy (#58) Submodule src/code.cloudfoundry.org/rep ee149c3e5..0337e4171: > Add internal routes to executor RunInfo (#32) Submodule src/code.cloudfoundry.org/vizzini ecd9cfd33..901d0f6ba: > Expect extra port for default HTTP port for c2c TLS
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
As a consumer of Diego, I care most about two things:
The README does mention use of CF, however Diego's API docs are buried in a docs directory in the Receptor repo (not even in the README for Receptor), to which there is no link on the diego-release README. I did eventually find a link to the API docs in the design notes repo.
The user experience would be improved if there were a link to the API docs on the README.
The text was updated successfully, but these errors were encountered: