-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Document connection details #1143
Copy link
Copy link
Closed
Labels
docsenhancementNew feature or requestNew feature or requestexempt-from-staleroadmapIssues that have priority and are included in the roadmap, or are candidates to add to the roadmapIssues that have priority and are included in the roadmap, or are candidates to add to the roadmapuser experience
Metadata
Metadata
Assignees
Labels
docsenhancementNew feature or requestNew feature or requestexempt-from-staleroadmapIssues that have priority and are included in the roadmap, or are candidates to add to the roadmapIssues that have priority and are included in the roadmap, or are candidates to add to the roadmapuser experience
Type
Projects
Status
Done
What problem are you facing?
There is documentation on every field of the CRDs and this is really awesome. However, in many cases resources create a connection secret that includes the credential to use the resource such as root user credentials for
MySQLInstanceresources. But there isn't really a documentation that tells you what the keys of those secrets are or what each of them means.How could Crossplane help solve your problem?
Just like CRD documentation, Crossplane docs could have a section that shows the format of the connection secret and what to expect for each managed resource. Ideally, this'd be auto-generated like the CRD doc.
Edit (@jbw976): This problem domain is likely solved in a complete way for the Crossplane ecosystem by:
ManagedResourceDefinitiontype #2262