-
Notifications
You must be signed in to change notification settings - Fork 78
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
Add diagrams #90
Add diagrams #90
Conversation
operatorSdkImage = "operator-sdk-binary" | ||
testSdkImage = "operator-sdk-binary-tester" | ||
genClientImage = "operator-gen-client" | ||
mermaidJsImage = "operator-mermaid-js" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Prefixing with "operator-" to prevent collision with any actual mermaid-js image a user might have. As far as I know, there is not currently an official one.
@@ -0,0 +1,15 @@ | |||
# based on https://github.com/mermaid-js/mermaid.cli/blob/33a8334293308af13d307d5c3754841636e46da8/Dockerfile |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While the official repo does have a Dockerfile, there is, currently, no docker image on dockerhub, and also the Dockerfile doesn't work.
|
||
RUN apt-get update && \ | ||
apt-get install -y gconf-service libxext6 libxfixes3 libxi6 libxrandr2 libxrender1 libcairo2 libcups2 libdbus-1-3 libexpat1 libfontconfig1 libgcc1 libgconf-2-4 libgdk-pixbuf2.0-0 libglib2.0-0 libgtk-3-0 libnspr4 libpango-1.0-0 libpangocairo-1.0-0 libstdc++6 libx11-6 libx11-xcb1 libxcb1 libxcomposite1 libxcursor1 libxdamage1 libxss1 libxtst6 libappindicator1 libnss3 libasound2 libatk1.0-0 libc6 ca-certificates fonts-liberation lsb-release xdg-utils wget &&\ | ||
npm install @mermaid-js/[email protected] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is a known issue with installing mermaid-js globally: https://github.com/mermaid-js/mermaid.cli#install-globally
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💯
This adds diagrams for what the operator does when scaling up and updating a CassandraDatacenter. It also adds a mage task to generate these diagrams using mermaid-js.