Skip to content

Commit b8b7dc5

Browse files
a-hilalya-hilaly
committed
Generate skeleton using ACK runtime 0.12.0
Brings in a generator.yaml file that ignores ALL resources in the Lambda API along with the standard README and governance files.
1 parent 041fc5b commit b8b7dc5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+3728
-32
lines changed

‎ATTRIBUTION.md

+1,365
Large diffs are not rendered by default.

‎CONTRIBUTING.md

+50-24
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,85 @@
11
# Contributing Guidelines
22

3-
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
4-
documentation, we greatly value feedback and contributions from our community.
5-
6-
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
7-
information to effectively respond to your bug report or contribution.
3+
Thank you for your interest in contributing to our project. Whether it's a bug
4+
report, new feature, correction, or additional documentation, we greatly value
5+
feedback and contributions from our community.
86

7+
Please read through this document before submitting any issues or pull requests
8+
to ensure we have all the necessary information to effectively respond to your
9+
bug report or contribution.
910

1011
## Reporting Bugs/Feature Requests
1112

12-
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
13+
We welcome you to use the GitHub issue tracker to report bugs or suggest
14+
features.
1315

14-
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
15-
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
16+
When filing an issue, please check existing open, or recently closed, issues to
17+
make sure somebody else hasn't already reported the issue. Please try to
18+
include as much information as you can. Details like these are incredibly
19+
useful:
1620

1721
* A reproducible test case or series of steps
1822
* The version of our code being used
1923
* Any modifications you've made relevant to the bug
2024
* Anything unusual about your environment or deployment
2125

22-
2326
## Contributing via Pull Requests
24-
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
27+
28+
Contributions via pull requests are much appreciated. Before sending us a pull
29+
request, please ensure that:
2530

2631
1. You are working against the latest source on the *main* branch.
27-
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
28-
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
32+
2. You check existing open, and recently merged, pull requests to make sure
33+
someone else hasn't addressed the problem already.
34+
3. You open an issue to discuss any significant work - we would hate for your
35+
time to be wasted.
2936

3037
To send us a pull request, please:
3138

3239
1. Fork the repository.
33-
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.
40+
2. Modify the source; please focus on the specific change you are contributing.
41+
If you also reformat all the code, it will be hard for us to focus on your
42+
change.
3443
3. Ensure local tests pass.
3544
4. Commit to your fork using clear commit messages.
36-
5. Send us a pull request, answering any default questions in the pull request interface.
37-
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
45+
5. Send us a pull request, answering any default questions in the pull request
46+
interface.
47+
6. Pay attention to any automated CI failures reported in the pull request, and
48+
stay involved in the conversation.
3849

39-
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
40-
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
50+
GitHub provides additional document on [forking a repository][fork] and
51+
[creating a pull request][pr].
4152

53+
[fork]: https://help.github.com/articles/fork-a-repo/
54+
[pr]: https://help.github.com/articles/creating-a-pull-request/
4255

4356
## Finding contributions to work on
44-
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.
4557

58+
Looking at the existing issues is a great way to find something to contribute
59+
on. As our projects, by default, use the default GitHub issue labels
60+
(enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at
61+
any 'help wanted' issues is a great place to start.
62+
63+
## Developer documentation
64+
65+
[See the documentation][dev-docs] for detailed development information.
66+
67+
[dev-docs]: https://aws.github.io/aws-controllers-k8s/dev-docs/overview/
4668

4769
## Code of Conduct
48-
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
49-
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
50-
[email protected] with any additional questions or comments.
5170

71+
We adhere to the [Amazon Open Source Code of Conduct][coc].
72+
73+
[coc]: https://aws.github.io/code-of-conduct
5274

5375
## Security issue notifications
54-
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.
5576

77+
If you discover a potential security issue in this project we ask that you
78+
notify AWS/Amazon Security via our [vulnerability reporting page][vuln]. Please
79+
do **not** create a public Github issue.
80+
81+
[vuln]: http://aws.amazon.com/security/vulnerability-reporting/
5682

57-
## Licensing
83+
## License
5884

59-
See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
85+
This project is [licensed][./LICENSE] under the Apache-2.0 License.

‎GOVERNANCE.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
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)

‎OWNERS

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# See the OWNERS docs at https://go.k8s.io/owners
2+
3+
approvers:
4+
- core-ack-team
5+
- service-team

‎OWNERS_ALIASES

+11
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+
# Always allow the core ACK maintainers to have access to your repository
5+
core-ack-team:
6+
- jaypipes
7+
- a-hilaly
8+
- RedbackThomson
9+
- vijtrip2
10+
# TODO: Add your team members to your team controller alias
11+
service-team: []

‎README.md

+18-8
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,27 @@
1-
## My Project
1+
# ACK service controller for AWS Lambda
22

3-
TODO: Fill this README out!
3+
This repository contains source code for the AWS Controllers for Kubernetes
4+
(ACK) service controller for AWS Lambda.
45

5-
Be sure to:
6+
Please [log issues][ack-issues] and feedback on the main AWS Controllers for
7+
Kubernetes Github project.
68

7-
* Change the title in this README
8-
* Edit your repository description on GitHub
9+
[ack-issues]: https://github.com/aws-controllers-k8s/community/issues
910

10-
## Security
11+
## Contributing
1112

12-
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
13+
We welcome community contributions and pull requests.
14+
15+
See our [contribution guide](/CONTRIBUTING.md) for more information on how to
16+
report issues, set up a development environment, and submit code.
17+
18+
We adhere to the [Amazon Open Source Code of Conduct][coc].
19+
20+
You can also learn more about our [Governance](/GOVERNANCE.md) structure.
21+
22+
[coc]: https://aws.github.io/code-of-conduct
1323

1424
## License
1525

16-
This project is licensed under the Apache-2.0 License.
26+
This project is [licensed](/LICENSE) under the Apache-2.0 License.
1727

‎SECURITY.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Security issue notifications
2+
3+
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.

‎apis/v1alpha1/ack-generate-metadata.yaml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
ack_generate_info:
2+
build_date: "2021-08-24T16:58:51Z"
3+
build_hash: 970b729263d026b85c214cc13330684c06f5860b
4+
go_version: go1.14.4 darwin/amd64
5+
version: v0.12.0
6+
api_directory_checksum: c4f13dee9338e87111cd1c92b69a20000a4a4bc8
7+
api_version: v1alpha1
8+
aws_sdk_go_version: v1.40.28
9+
generator_config_info:
10+
file_checksum: d060250e47ee8076ab88b9e54aa4f91972eef67c
11+
original_file_name: generator.yaml
12+
last_modification:
13+
reason: API generation
14+
timestamp: 2021-08-24 16:59:07.024892 +0000 UTC

‎apis/v1alpha1/doc.go

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
// +k8s:deepcopy-gen=package
2+
// Package v1alpha1 is the v1alpha1 version of the lambda.services.k8s.aws API.
3+
// +groupName=lambda.services.k8s.aws
4+
package v1alpha1

0 commit comments

Comments
 (0)