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

Add documentation and examples #7

Merged
merged 8 commits into from
Nov 15, 2019
Merged

Add documentation and examples #7

merged 8 commits into from
Nov 15, 2019

Conversation

j-fuentes
Copy link
Member

This adds a decent readme and some other documentation (./docs). It adds a tutorial on how to deploy preflight as a cronjob.

Additionally, it adds a Dockerfile.

@j-fuentes j-fuentes requested a review from munnerz November 15, 2019 02:21
@jetstack-bot jetstack-bot added the dco-signoff: no Indicates that at least one commit in this pull request is missing the DCO sign-off message. label Nov 15, 2019
@jetstack-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: j-fuentes

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

@jetstack-bot jetstack-bot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Nov 15, 2019
Signed-off-by: Jose Fuentes <[email protected]>
Signed-off-by: Jose Fuentes <[email protected]>
Signed-off-by: Jose Fuentes <[email protected]>
Signed-off-by: Jose Fuentes <[email protected]>
@jetstack-bot jetstack-bot added dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. and removed dco-signoff: no Indicates that at least one commit in this pull request is missing the DCO sign-off message. labels Nov 15, 2019
Signed-off-by: Jose Fuentes <[email protected]>

# STAGE 2
# Use a distroless nonroot base image for just our executable
FROM gcr.io/distroless/base:nonroot
Copy link
Contributor

Choose a reason for hiding this comment

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

Instead of using multi stage builds, which don't play well with go's module caching, consider using 'go_container.sh' from 'kind' which makes use of a docker volume to cache go dependencies, giving you host-like performance 😀 this works okay, but is just a bit slow for iterative development: https://github.com/kubernetes-sigs/kind/blob/master/hack/go_container.sh

Copy link
Member Author

Choose a reason for hiding this comment

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

Will do in a separate PR: #8

export IMAGE_NAME=<my image>
make build-docker-image
make push-docker-image
```
Copy link
Contributor

Choose a reason for hiding this comment

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

We should get some images published at some point soon to to avoid this 😀

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, we need to build images and binaries from Prow. Not done yet.

Signed-off-by: Jose Fuentes <[email protected]>
This was referenced Nov 15, 2019
@munnerz
Copy link
Contributor

munnerz commented Nov 15, 2019

/lgtm

@jetstack-bot jetstack-bot added the lgtm Indicates that a PR is ready to be merged. label Nov 15, 2019
@jetstack-bot jetstack-bot merged commit dfaf7d0 into jetstack:master Nov 15, 2019
@j-fuentes j-fuentes deleted the examples branch November 15, 2019 12:07
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. dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. lgtm Indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants