Skip to content

Commit b3070f6

Browse files
a-hilalya-hilaly
committed
Initial commit
0 parents  commit b3070f6

16 files changed

+1782
-0
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Issue #, if available:
2+
3+
Description of changes:
4+
5+
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

‎.github/workflows/unit-tests.yaml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: unit-tests
2+
on:
3+
pull_request:
4+
branches:
5+
- main
6+
paths:
7+
- '**.go'
8+
- Makefile
9+
- '**.tpl'
10+
- go.mod
11+
- go.sum
12+
13+
jobs:
14+
unit-tests:
15+
name: make test
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: checkout code
19+
uses: actions/checkout@v2
20+
- uses: actions/setup-go@v2
21+
with:
22+
go-version: '1.14'
23+
- name: make test
24+
run: make test

‎.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.DS_Store
2+
*.swp
3+
*~
4+
.idea
5+
/docs/site
6+
bin
7+
build

‎ATTRIBUTIONS.md

Lines changed: 1365 additions & 0 deletions
Large diffs are not rendered by default.

‎CODE_OF_CONDUCT.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
## Code of Conduct
2+
3+
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
4+
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
5+
[email protected] with any additional questions or comments.
6+

‎CONTRIBUTING.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Contributing Guidelines
2+
3+
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.
4+
5+
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.
6+
7+
## Reporting Bugs/Feature Requests
8+
9+
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
10+
11+
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
12+
13+
* A reproducible test case or series of steps
14+
* The version of our code being used
15+
* Any modifications you've made relevant to the bug
16+
* Anything unusual about your environment or deployment
17+
18+
## Contributing via Pull Requests
19+
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
20+
21+
1. You are working against the latest source on the *master* branch.
22+
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
23+
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
24+
25+
To send us a pull request, please:
26+
27+
1. Fork the repository.
28+
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
29+
3. Ensure local tests pass.
30+
4. Commit to your fork using clear commit messages.
31+
5. Send us a pull request, answering any default questions in the pull request interface.
32+
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
33+
34+
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
35+
36+
## Finding contributions to work on
37+
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
38+
39+
## Developer documentation
40+
[See the documentation](https://aws.github.io/aws-controllers-k8s/dev-docs/overview/) for detailed development information.
41+
42+
## Code of Conduct
43+
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
44+
45+
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact [email protected] with any additional questions or comments.
46+
47+
## Security issue notifications
48+
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
49+
50+
## Licensing
51+
See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.

‎GOVERNANCE.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Project governance
2+
3+
This document lays out the guidelines under which the AWS Controllers for Kubernetes (ACK) project will be governed.
4+
The goal is to make sure that the roles and responsibilities are well defined and clarify on how decisions are made.
5+
6+
## Roles
7+
8+
In the context of ACK, we consider the following roles:
9+
10+
* __Users__ ... everyone using ACK, typically willing to provide feedback on ACK by proposing features and/or filing issues.
11+
* __Contributors__ ... everyone contributing code, documentation, examples, testing infra, and participating in feature proposals as well as design discussions. Code contributions will require a Developer Certificate of Origin (DCO).
12+
* __Maintainers__ ... are responsible for engaging with and assisting contributors to iterate on the contributions until it reaches acceptable quality. Maintainers can decide whether the contributions can be accepted into the project or rejected. Any active contributor meeting the project quality can be made a Maintainer by the Advisory Board.
13+
* __Advisory Board__ ... is responsible for defining the guidelines and processes that the project operates under.
14+
15+
The initial members of the Advisory Board are `@jaypipes` and `@mhausenblas`.
16+
17+
18+
## Communication
19+
20+
The primary mechanism for communication will be via the `#provider-aws` channel on the Kubernetes Slack community.
21+
All features and bug fixes will be tracked as issues in GitHub. All decisions will be documented in GitHub issues.
22+
23+
In the future, we may consider using a public mailing list, which can be better archived.
24+
25+
## Roadmap Planning
26+
27+
Maintainers will share roadmap and release versions as milestones in GitHub.
28+
29+
## Release Management
30+
31+
The Advisory Board will propose a release management proposal via a GitHub issue and resolve it there.
32+
33+
## Other relevant governance resources
34+
35+
* The ACK [Contributing Guidelines](CONTRIBUTING.md)
36+
* Our [Code of Conduct](CODE_OF_CONDUCT.md)
37+

‎LICENSE

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+

‎Makefile

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
SHELL := /bin/bash # Use bash syntax
2+
3+
# Set up variables
4+
GO111MODULE=on
5+
6+
# Build ldflags
7+
VERSION ?= "v0.0.0"
8+
GITCOMMIT=$(shell git rev-parse HEAD)
9+
BUILDDATE=$(shell date -u +'%Y-%m-%dT%H:%M:%SZ')
10+
GO_LDFLAGS=-ldflags "-X main.version=$(VERSION) \
11+
-X main.buildHash=$(GITCOMMIT) \
12+
-X main.buildDate=$(BUILDDATE)"
13+
14+
.PHONY: all test
15+
16+
all: test
17+
18+
test: ## Run code tests
19+
go test -v ./...
20+
21+
help: ## Show this help.
22+
@grep -F -h "##" $(MAKEFILE_LIST) | grep -F -v grep | sed -e 's/\\$$//' \
23+
| awk -F'[:#]' '{print $$1 = sprintf("%-30s", $$1), $$4}'

‎NOTICE

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+

‎OWNERS

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# See the OWNERS docs at https://go.k8s.io/owners
2+
3+
approvers:
4+
# TODO: in your repo created from this template, you should replace the
5+
# github-admin-team with a list of project owners, see the doc linked above.
6+
- github-admin-team

‎OWNERS_ALIASES

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# See the OWNERS docs at https://go.k8s.io/owners#owners_aliases
2+
3+
aliases:
4+
# TODO: remove this alias, it will go stale in your repo, and in your repo
5+
# you should have your own set of approvers (see OWNERS)
6+
# in the original template repo, we must maintain this list to approve changes
7+
# to the template itself
8+
github-admin-team:
9+
- jaypipes
10+
- mhausenblas
11+
- a-hilaly

‎README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Controllers Template Project
2+
3+
The ACK Template Project is a template for starting new projects in the `aws-controller-k8s` Github organization. All controller projects, at minimum, must have the following files:
4+
5+
- a `README.md` outlining the project goals, sponsoring sig, and community contact information
6+
- an `OWNERS` with the project leads listed as approvers ([docs on `OWNERS` files](./OWNERS))
7+
- a `CONTRIBUTING.md` outlining how to contribute to the project
8+
- an unmodified copy of `CODE_OF_CONDUCT.md` from this repo, which outlines community behavior and the consequences of breaking the code
9+
- a `LICENSE` which must be Apache 2.0 for code projects, without any custom content.
10+
- a `SECURITY.md` which contains steps to take if you discover a potential security issue in this project.
11+
12+
## Community, discussion, contribution, and support
13+
14+
We welcome community contributions and pull requests.
15+
16+
See our [contribution guide](/CONTRIBUTING.md) for more information on how to
17+
report issues, set up a development environment, and submit code.
18+
19+
You can reach the maintainers of this project at:
20+
21+
- [Slack](http://slack.k8s.io/) via `#provider-aws` channel
22+
23+
### Code of conduct
24+
25+
Participation in the AWS community is governed by the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md).

0 commit comments

Comments
 (0)