Merge pull request #2 from Nordix/init-mael

⚠️ Creation of CRDs and controller

Author: metal3-io-bot

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Tell us about a problem you are experiencing
+
+---
+
+**What steps did you take and what happened:**
+[A clear and concise description on how to REPRODUCE the bug.]
+
+
+**What did you expect to happen:**
+
+
+**Anything else you would like to add:**
+[Miscellaneous information that will assist in solving the issue.]
+
+
+**Environment:**
+
+- Cluster-api version:
+- CAPM3 version:
+- IPAM version:
+- Minikube version:
+- environment (metal3-dev-env or other):
+- Kubernetes version: (use `kubectl version`):
+
+/kind bug

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature addition
+about: Suggest and track an idea for this project
+
+---
+
+**User Story**
+
+As a [developer/user/operator] I would like to [high level description] for [reasons]
+
+**Detailed Description**
+
+[A clear and concise description of what you want to happen.]
+
+**Anything else you would like to add:**
+
+[Miscellaneous information that will assist in solving the issue.]
+
+/kind feature

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,7 @@
+<!-- please add a icon to the title of this PR (see https://sigs.k8s.io/cluster-api/VERSIONING.md), and delete this line and similar ones -->
+<!-- the icon will be either ⚠️ (:warning:, major or breaking changes), ✨ (:sparkles:, minor or feature additions), 🐛 (:bug:, patch and bugfixes), 📖 (:book:, documentation or proposals), or 🏃 (:running:, other) -->
+
+**What this PR does / why we need it**:
+
+**Which issue(s) this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close the issue(s) when PR gets merged)*:
+Fixes #

.gitignore

@@ -0,0 +1,18 @@
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, build with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+bin/*
+hack/tools/bin/*
+examples/_out/*
+examples/provider-components/*-components.yaml
+out/*

.mdlrc

@@ -0,0 +1,2 @@
+#Disable line-length for some code examples in getting-started
+rules "~MD013", "~MD005"

CONTRIBUTING.md

@@ -0,0 +1,116 @@
+# How to Contribute
+
+Metal3 projects are [Apache 2.0 licensed](LICENSE) and accept contributions via
+GitHub pull requests. Those guidelines are the same as the
+[Cluster API guidelines](https://github.com/kubernetes-sigs/cluster-api/blob/master/CONTRIBUTING.md)
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [Certificate of Origin](#certificate-of-origin)
+- [Finding Things That Need Help](#finding-things-that-need-help)
+- [Contributing a Patch](#contributing-a-patch)
+- [Backporting a Patch](#backporting-a-patch)
+  - [Merge Approval](#merge-approval)
+  - [Google Doc Viewing Permissions](#google-doc-viewing-permissions)
+  - [Issue and Pull Request Management](#issue-and-pull-request-management)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Certificate of Origin
+
+By contributing to this project you agree to the Developer Certificate of
+Origin (DCO). This document was created by the Linux Kernel community and is a
+simple statement that you, as a contributor, have the legal right to make the
+contribution. See the [DCO](DCO) file for details.
+
+## Finding Things That Need Help
+
+If you're new to the project and want to help, but don't know where to start, we
+have a semi-curated list of issues that
+should not need deep knowledge of the system. [Have a look and see if anything
+sounds interesting](https://github.com/metal3-io/cluster-api-provider-metal3/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
+Alternatively, read some of the docs on other controllers and try to write your
+own, file and fix any/all issues that come up, including gaps in documentation!
+
+## Contributing a Patch
+
+1. If you haven't already done so, sign a Contributor License Agreement (see
+   details above).
+1. Fork the desired repo, develop and test your code changes.
+1. Submit a pull request.
+
+All code PR must be labeled with one of
+
+- ⚠️ (:warning:, major or breaking changes)
+- ✨ (:sparkles:, minor or feature additions)
+- 🐛 (:bug:, patch and bugfixes)
+- 📖 (:book:, documentation or proposals)
+- 🏃 (:running:, other)
+
+All changes must be code reviewed. Coding conventions and standards are
+explained in the official [developer
+docs](https://github.com/kubernetes/community/tree/master/contributors/devel).
+Expect reviewers to request that you
+avoid common [go style
+mistakes](https://github.com/golang/go/wiki/CodeReviewComments) in your PRs.
+
+## Backporting a Patch
+
+Cluster API maintains older versions through `release-X.Y` branches. We accept
+backports of bug fixes to the most recent
+release branch. For example, if the most recent branch is `release-0.2`, and the
+`master` branch is under active
+development for v0.3.0, a bug fix that merged to `master` that also affects
+`v0.2.x` may be considered for backporting
+to `release-0.2`. We generally do not accept PRs against older release branches.
+
+## Breaking Changes
+
+Breaking changes are generally allowed in the `master` branch, as this is the
+branch used to develop the next minor release of Cluster API.
+
+There may be times, however, when `master` is closed for breaking changes. This
+is likely to happen as we near the release of a new minor version.
+
+Breaking changes are not allowed in release branches, as these represent minor
+versions that have already been released.
+These versions have consumers who expect the APIs, behaviors, etc. to remain
+stable during the life time of the patch stream for the minor release.
+
+Examples of breaking changes include:
+
+- Removing or renaming a field in a CRD
+- Removing or renaming a CRD
+- Removing or renaming an exported constant, variable, type, or function
+- Updating the version of critical libraries such as controller-runtime,
+  client-go, apimachinery, etc.
+- Some version updates may be acceptable, for picking up bug fixes, but
+  maintainers must exercise caution when reviewing.
+
+There may, at times, need to be exceptions where breaking changes are allowed in
+release branches. These are at the discretion of the project's maintainers, and
+must be carefully considered before merging. An example of an allowed
+breaking change might be a fix for a behavioral bug that was released in an
+initial minor version (such as `v0.3.0`).
+
+### Merge Approval
+
+Please see the [Kubernetes community document on pull
+requests](https://git.k8s.io/community/contributors/guide/pull-requests.md) for
+more information about the merge process.
+
+### Google Doc Viewing Permissions
+
+To gain viewing permissions to google docs in this project, please join the
+[metal3-dev](https://groups.google.com/forum/#!forum/metal3-dev) google
+group.
+
+### Issue and Pull Request Management
+
+Anyone may comment on issues and submit reviews for pull requests. However, in
+order to be assigned an issue or pull request, you must be a member of the
+[Metal3-io organization](https://github.com/metal3-io) GitHub organization.
+
+Metal3 maintainers can assign you an issue or pull request by leaving a
+`/assign <your Github ID>` comment on the issue or pull request.

DCO

@@ -0,0 +1,37 @@
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+1 Letterman Drive
+Suite D4700
+San Francisco, CA, 94129
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.

Dockerfile

@@ -0,0 +1,47 @@
+# Copyright 2019 The Kubernetes Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Build the manager binary on golang image
+FROM registry.hub.docker.com/library/golang:1.13 as builder
+WORKDIR /workspace
+
+# Run this with docker build --build_arg $(go env GOPROXY) to override the goproxy
+ARG goproxy=https://proxy.golang.org
+ENV GOPROXY=$goproxy
+
+# Copy the Go Modules manifests
+COPY go.mod go.mod
+COPY go.sum go.sum
+# Cache deps before building and copying source so that we don't need to re-download as much
+# and so that source changes don't invalidate our downloaded layer
+RUN go mod download
+
+# Copy the sources
+COPY main.go main.go
+COPY api/ api/
+COPY ipam/ ipam/
+COPY controllers/ controllers/
+
+# Build
+ARG ARCH
+RUN CGO_ENABLED=0 GOOS=linux GOARCH=${ARCH} \
+    go build -a -ldflags '-extldflags "-static"' \
+    -o manager .
+
+# Copy the controller-manager into a thin image
+FROM gcr.io/distroless/static:latest
+WORKDIR /
+COPY --from=builder /workspace/manager .
+USER nobody
+ENTRYPOINT ["/manager"]