Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 50 additions & 24 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,85 @@
# Contributing Guidelines

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.

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.
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.

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.

## Reporting Bugs/Feature Requests

We welcome you to use the GitHub issue tracker to report bugs or suggest features.
We welcome you to use the GitHub issue tracker to report bugs or suggest
features.

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:
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:

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


## Contributing via Pull Requests
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:

Contributions via pull requests are much appreciated. Before sending us a pull
request, please ensure that:

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

To send us a pull request, please:

1. Fork the repository.
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.
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.
3. Ensure local tests pass.
4. Commit to your fork using clear commit messages.
5. Send us a pull request, answering any default questions in the pull request interface.
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
5. Send us a pull request, answering any default questions in the pull request
interface.
6. Pay attention to any automated CI failures reported in the pull request, and
stay involved in the conversation.

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/).
GitHub provides additional document on [forking a repository][fork] and
[creating a pull request][pr].

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

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

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.

## Developer documentation

[See the documentation][dev-docs] for detailed development information.

[dev-docs]: https://aws-controllers-k8s.github.io/community/docs/contributor-docs/overview/

## Code of Conduct
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
opensource-codeofconduct@amazon.com with any additional questions or comments.

We adhere to the [Amazon Open Source Code of Conduct][coc].

[coc]: https://aws.github.io/code-of-conduct

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

If you discover a potential security issue in this project we ask that you
notify AWS/Amazon Security via our [vulnerability reporting page][vuln]. Please
do **not** create a public Github issue.

[vuln]: http://aws.amazon.com/security/vulnerability-reporting/

## Licensing
## License

See the [LICENSE](/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
This project is [licensed][./LICENSE] under the Apache-2.0 License.
20 changes: 16 additions & 4 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,30 @@
# Project governance

This document lays out the guidelines under which the AWS Controllers for Kubernetes (ACK) project will be governed.
This document lays out the guidelines under which the AWS Controllers for Kubernetes (ACK) project will be governed.
The goal is to make sure that the roles and responsibilities are well defined and clarify on how decisions are made.

## Roles

In the context of ACK, we consider the following roles:

* __Users__ ... everyone using ACK, typically willing to provide feedback on ACK by proposing features and/or filing issues.
* __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).
* __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.
* __Advisory Board__ ... is responsible for defining the guidelines and processes that the project operates under.

The initial members of the Advisory Board are `@jaypipes` and `@mhausenblas`.


## Communication

The primary mechanism for communication will be via the `#provider-aws` channel on the Kubernetes Slack community.
The primary mechanism for communication will be via the `#provider-aws` channel on the Kubernetes Slack community.
All features and bug fixes will be tracked as issues in GitHub. All decisions will be documented in GitHub issues.

In the future, we may consider using a public mailing list, which can be better archived.
In the future, we may consider using a public mailing list, which can be better archived.

## Roadmap Planning

Maintainers will share roadmap and release versions as milestones in GitHub.
Maintainers will share roadmap and release versions as milestones in GitHub.

## Release Management

Expand Down
3 changes: 1 addition & 2 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
13 changes: 13 additions & 0 deletions apis/v1alpha1/ack-generate-metadata.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
ack_generate_info:
build_date: "2023-07-24T21:35:44Z"
build_hash: e9b68590da73ce9143ba1e4361cebdc1d876c81e
go_version: go1.20.6
version: v0.26.1-7-ge9b6859-dirty
api_directory_checksum: e21bfad36ac581912d611c9c390ab4bd2c2fb46d
api_version: v1alpha1
aws_sdk_go_version: v1.44.303
generator_config_info:
file_checksum: bfca77347e9ccada9ee0c53136c169cdca88443b
original_file_name: generator.yaml
last_modification:
reason: API generation
4 changes: 4 additions & 0 deletions apis/v1alpha1/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
// +k8s:deepcopy-gen=package
// Package v1alpha1 is the v1alpha1 version of the cloudwatch.services.k8s.aws API.
// +groupName=cloudwatch.services.k8s.aws
package v1alpha1
151 changes: 151 additions & 0 deletions apis/v1alpha1/enums.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

37 changes: 37 additions & 0 deletions apis/v1alpha1/generator.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
ignore:
resource_names:
- AnomalyDetector
- CompositeAlarm
- InsightRule
- ManagedInsightRule
- MetricStream
model_name: monitoring
operations:
DeleteAlarms:
operation_type:
- Delete
resource_name: MetricAlarm
DescribeAlarms:
output_wrapper_field_path: MetricAlarms
operation_type:
- List
resource_name: MetricAlarm
PutMetricAlarm:
operation_type:
- Create
- Update
resource_name: MetricAlarm
resources:
MetricAlarm:
fields:
Name:
is_primary_key: true
is_required: true
renames:
operations:
PutMetricAlarm:
input_fields:
AlarmName: Name
hooks:
sdk_delete_post_build_request:
template_path: hooks/metricalarm/sdk_delete_post_build_request.go.tpl
32 changes: 32 additions & 0 deletions apis/v1alpha1/groupversion_info.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading