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

Update README and add Samples #52

Open
wants to merge 13 commits into
base: main
Choose a base branch
from

Conversation

ndbhat
Copy link
Contributor

@ndbhat ndbhat commented May 2, 2024

Description of changes:

  1. Update README
  2. Add Samples folder with tutorial to set up a CA hierarchy

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

ndbhat and others added 13 commits January 12, 2024 10:00
* Update to ACK runtime `v0.29.2`, code-generator `v0.29.2` (aws-controllers-k8s#29)

### Update to ACK runtime `v0.29.2`, code-generator `v0.29.2`

----------

* ACK code-generator `v0.29.2` [release notes](https://github.com/aws-controllers-k8s/code-generator/releases/tag/v0.29.2)
* ACK runtime `v0.29.2` [release notes](https://github.com/aws-controllers-k8s/runtime/releases/tag/v0.29.2)

----------

NOTE:
This PR increments the release version of service controller from `v0.0.5` to `v0.0.6`

Once this PR is merged, release `v0.0.6` will be automatically created for `acmpca-controller`

**Please close this PR, if you do not want the new patch release for `acmpca-controller`**

----------

#### stdout for `make build-controller`:

```
building ack-generate ... ok.
==== building acmpca-controller ====
Copying common custom resource definitions into acmpca
Building Kubernetes API objects for acmpca
Generating deepcopy code for acmpca
Generating custom resource definitions for acmpca
Building service controller for acmpca
Generating RBAC manifests for acmpca
Running gofmt against generated code for acmpca
Updating additional GitHub repository maintenance files
==== building acmpca-controller release artifacts ====
Building release artifacts for acmpca-v0.0.6
Generating common custom resource definitions
Generating custom resource definitions for acmpca
Generating RBAC manifests for acmpca
```

----------

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

* Refactor e2e tests (aws-controllers-k8s#30)

Description of changes:
Separate out e2e tests into different files for each of the resources.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

* Add CertificateAuthorityActivation certificateAuthorityRef field (aws-controllers-k8s#23)

Description of changes:
Update customFindCertificateAuthorityActivation method to use CertificateAuthorityActivation certificateAuthorityRef field.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

* Implement CertificateAuthorityActivation deletion (aws-controllers-k8s#24)

Description of changes:
If a CertificateAuthorityActivation resource is deleted, set the corresponding CertificateAuthority resource's status to "DISABLED".

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

* Update to ACK runtime `v0.32.0`, code-generator `v0.32.1` (aws-controllers-k8s#36)

### Update to ACK runtime `v0.32.0`, code-generator `v0.32.1`

----------

* ACK code-generator `v0.32.1` [release notes](https://github.com/aws-controllers-k8s/code-generator/releases/tag/v0.32.1)
* ACK runtime `v0.32.0` [release notes](https://github.com/aws-controllers-k8s/runtime/releases/tag/v0.32.0)

----------

NOTE:
This PR increments the release version of service controller from `v0.0.6` to `v0.0.7`

Once this PR is merged, release `v0.0.7` will be automatically created for `acmpca-controller`

**Please close this PR, if you do not want the new patch release for `acmpca-controller`**

----------

#### stdout for `make build-controller`:

```
building ack-generate ... ok.
==== building acmpca-controller ====
Copying common custom resource definitions into acmpca
Building Kubernetes API objects for acmpca
Generating deepcopy code for acmpca
Generating custom resource definitions for acmpca
Building service controller for acmpca
Generating RBAC manifests for acmpca
Running gofmt against generated code for acmpca
Updating additional GitHub repository maintenance files
==== building acmpca-controller release artifacts ====
Building release artifacts for acmpca-v0.0.7
Generating common custom resource definitions
Generating custom resource definitions for acmpca
Generating RBAC manifests for acmpca
```

----------

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

* Set Certificate resource fields to immutable and add default values for Secret namespace and key (aws-controllers-k8s#34)

Description of changes:
1. Set all Certificate resource spec fields to immutable
2. If Secret namespace is not specified, use Certificate resource's namespace
3. If Secret key is not specified, use "certificate" as the key
4. Change annotations to follow "acmpca.services.k8s.aws/certificate-secret....."
5. Override Go tag of spec field Validity.Type from "type_" to "type"

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

* Set CA immutable fields, update CA tags, and set CA fields to default values (aws-controllers-k8s#25)

Description of changes:
1. Set certain CA spec fields to be immutable
2. Implementing updating CA tags
3. Set certain CA spec fields to their default values if they're not set by the user
4. Add CA Status fields (from DescribeCertificateAuthority api call)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

* Implement Certificate Chain Secret and set CertificateAuthorityActivation default fields (aws-controllers-k8s#32)

Description of changes:
1. Input certificateChain field as a Secret
2. Output updated certificateChain to a Secret
3. Set spec field "Status" to a default value

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

* Release artifacts for release v0.0.8 (aws-controllers-k8s#38)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

* Update to ACK runtime `v0.33.0`, code-generator `v0.33.0` (aws-controllers-k8s#42)

### Update to ACK runtime `v0.33.0`, code-generator `v0.33.0`

----------

* ACK code-generator `v0.33.0` [release notes](https://github.com/aws-controllers-k8s/code-generator/releases/tag/v0.33.0)
* ACK runtime `v0.33.0` [release notes](https://github.com/aws-controllers-k8s/runtime/releases/tag/v0.33.0)

----------

NOTE:
This PR increments the release version of service controller from `v0.0.8` to `v0.0.9`

Once this PR is merged, release `v0.0.9` will be automatically created for `acmpca-controller`

**Please close this PR, if you do not want the new patch release for `acmpca-controller`**

----------

#### stdout for `make build-controller`:

```
building ack-generate ... ok.
==== building acmpca-controller ====
Copying common custom resource definitions into acmpca
Building Kubernetes API objects for acmpca
Generating deepcopy code for acmpca
Generating custom resource definitions for acmpca
Building service controller for acmpca
Generating RBAC manifests for acmpca
Running gofmt against generated code for acmpca
Updating additional GitHub repository maintenance files
==== building acmpca-controller release artifacts ====
Building release artifacts for acmpca-v0.0.9
Generating common custom resource definitions
Generating custom resource definitions for acmpca
Generating RBAC manifests for acmpca
```

----------

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

---------

Co-authored-by: AWS Controllers for Kubernetes Bot <82905295+ack-bot@users.noreply.github.com>
@ack-prow ack-prow bot requested review from a-hilaly and anbaig May 2, 2024 13:08
Copy link

ack-prow bot commented May 2, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ndbhat

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

@ack-prow ack-prow bot added the approved label May 2, 2024
acmpca.services.k8s.aws/chain-secret-key: certificateChain
...
```

Copy link
Collaborator

Choose a reason for hiding this comment

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

Add a blurb here on how to actually use this with the CertManager Plugin for PCA to start issuing certificates.

Copy link
Collaborator

@anbaig anbaig May 3, 2024

Choose a reason for hiding this comment

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

would it be slightly confusing to add that? You can issue certificates with ACK if you want, there is just no management involved in the certificate issued via ACK.

I support a blurb like "If you want to issue certificates with management, use cert-manager with the CA you created" -- elaborate in real text what "management" means.

divyansh-gupta

This comment was marked as resolved.


Please [log issues][ack-issues] and feedback on the main AWS Controllers for
Kubernetes Github project.

[ack-issues]: https://github.com/aws/aws-controllers-k8s/issues

## Resources Supported
Copy link
Member

@a-hilaly a-hilaly May 2, 2024

Choose a reason for hiding this comment

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

This file will soon be auto-generate for all the controllers, i'd advice to put this content under a different file or directory. Other controllers that have documentation on their main page will have to do the same

Comment on lines +19 to +22
### Pricing
Learn more about [AWS Private Certificate Authority Pricing][pricing].

[pricing]: https://aws.amazon.com/private-ca/pricing
Copy link
Member

Choose a reason for hiding this comment

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

This is miss leading, ACK controllers are open source and free to use. Maybe just include a link to ACM documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
4 participants