Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the operator on Porter's website #30

Closed
7 of 8 tasks
carolynvs opened this issue May 11, 2021 · 3 comments
Closed
7 of 8 tasks

Document the operator on Porter's website #30

carolynvs opened this issue May 11, 2021 · 3 comments
Milestone

Comments

@carolynvs
Copy link
Member

carolynvs commented May 11, 2021

  • Requirements
  • How to install
  • Explain what runs where
  • Quickstart with install, upgrade version and uninstall
  • AgentConfig
  • PorterConfig
  • Document the database in the porter operator #144
  • Using with the porter cli - this is explained in contributing.md but not on the website
@carolynvs carolynvs added this to the v1 milestone May 11, 2021
@JeremyGHutchins
Copy link

Can you please add information about using parameters. For example, we have a bundle that we have authored which has a parameter of type "file". Not sure how to pass this in, given that the parameters in the CRD is just a map[string]string.

@carolynvs
Copy link
Member Author

There may be a workaround now for file. I threw out one idea to @donmstewart where we can try setting the parameter type to string and the contentEncoding to base64. I haven't verified it myself to know for sure if it will work. We may need a fix to Porter so that when the parameter is written out to a file, we decode the string first.

I think we are missing a more k8s native way to provide a file, for example being able to make a parameter set where the source of the parameter is a k8s secret or config map.

@carolynvs
Copy link
Member Author

I have created sub issues for remaining tasks and assigned them to the v1 milestone. Closing this issue in favor of the more specific task issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants