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

Bootstrap proposal: convert Figures 3-8 to PlantUML, add make target to generate #1058

Merged

Conversation

dlipovetsky
Copy link
Contributor

What this PR does / why we need it:

Removes dependency on external service to generate sequence diagrams in #997. Allows sequence diagrams to be generated locally.

Special notes for your reviewer:
I tried to use an upstream containerized PlantUML client, but none of them rendered the UTF-8 characters (checkmarks) correctly, so I kept the native java client.

/cc @vincepri

@k8s-ci-robot k8s-ci-robot requested a review from vincepri June 21, 2019 20:11
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 21, 2019
@vincepri
Copy link
Member

/test pull-cluster-api-test

Copy link
Member

@vincepri vincepri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve
/assign @timothysc @davidewatson

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 21, 2019
@vincepri
Copy link
Member

@dlipovetsky

I0621 21:26:51.634] Makefile:165: recipe for target 'verify' failed
W0621 21:26:51.640] Boilerplate header is wrong for: /go/src/sigs.k8s.io/cluster-api/docs/proposals/images/machine-states-preboot/Makefile

.gitignore Outdated Show resolved Hide resolved
#
.PHONY: figures

figures: *.png plantuml.jar
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should really be doing this via containers IMO.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried existing public containers. None of them rendered all the characters.

I know I can make it work with a different base image and the newest PlantUML version. Should I publish my own container and reference it here?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's talk with google folks to see if we can get some build containers in place.
/cc @BenTheElder @spiffxp

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'm not sure where this image would be hosted, I'm still waiting on wg-k8s-infra to give arbitrary repos official hosting, keys etc. kind is still quietly using a docker-hub 🙃

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll need to figure out a base image with a font that renders the checkmarks.

https://forum.plantuml.net/6114/default-font-used

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

paging - @dims

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I created my own image, based on the Dockerfile of the official plantuml-server image.

The checkmark (✅) codepoint did not render correctly because a font was missing. I found out which font(s) were capable of rendering this codepoint with this helpful script.

I installed fonts-symbola to the image, and the checkmark rendered correctly.

I am hosting the image on Docker hub. The Dockerfile for my image is https://github.com/dlipovetsky/plantuml-docker.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/uncc
I'm fine with the dockerhub container for now, if you want to host on gcr.io open a PR against kuberentes/k8s.io, ref: kubernetes/k8s.io#158 (comment)

@dlipovetsky
Copy link
Contributor Author

(I'll squash once we've agreed on all the details)

@detiber
Copy link
Member

detiber commented Jun 25, 2019

/test pull-cluster-api-test

@dlipovetsky dlipovetsky force-pushed the states-preboot-proposal branch from c7c19d6 to 42bc75e Compare June 25, 2019 18:55
@dlipovetsky
Copy link
Contributor Author

Squashed.

Copy link
Member

@timothysc timothysc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/approve
/hold
^ only for final comments, if there are none then feel free to unhold async.

@k8s-ci-robot k8s-ci-robot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. lgtm "Looks good to me", indicates that a PR is ready to be merged. labels Jun 25, 2019
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dlipovetsky, timothysc, vincepri

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@detiber
Copy link
Member

detiber commented Jun 25, 2019

/test pull-cluster-api-test

@dlipovetsky dlipovetsky force-pushed the states-preboot-proposal branch from 42bc75e to ab15bcd Compare June 26, 2019 23:28
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 26, 2019
@dlipovetsky
Copy link
Contributor Author

Rebased due to conflict with .gitignore

@dlipovetsky
Copy link
Contributor Author

/test pull-cluster-api-test

@dlipovetsky
Copy link
Contributor Author

machine deployment reconcile test failed

/retest

@k8s-ci-robot k8s-ci-robot removed the request for review from spiffxp June 27, 2019 00:12
@detiber
Copy link
Member

detiber commented Jun 27, 2019

/hold cancel
/lgtm

@k8s-ci-robot k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. and removed do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels Jun 27, 2019
@k8s-ci-robot k8s-ci-robot merged commit 0a3d842 into kubernetes-sigs:master Jun 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants