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

updates to common features #571

Closed
wants to merge 1 commit into from
Closed

Conversation

ianwalkersmithciticom
Copy link
Contributor

I've made some updates to features and removed those that are not common.

@ianwalkersmithciticom ianwalkersmithciticom requested a review from a team as a code owner November 28, 2024 11:41
@@ -1,13 +1,13 @@
features:
- id: CCC.F01 # Encryption in Transit Enabled by Default
title: Encryption in Transit Enabled by Default
Copy link
Contributor Author

Choose a reason for hiding this comment

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

enc in transit isn't a given or enables by default. But you can configure and use enc

Copy link
Contributor

Choose a reason for hiding this comment

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

I was able to easily find documentation describing the places where GCP provides default encryption in transit as a key feature. If other providers aren't doing something similar already, I'd say they need to be held to the same standard.

https://cloud.google.com/docs/security/encryption-in-transit#encryption_in_transit_by_default

Copy link
Contributor

Choose a reason for hiding this comment

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

If it is not enabled by default for the service that you are working on then I suggest don't include this common feature and create a specific feature for that service


- id: CCC.F02 # Encryption at Rest Enabled by Default
title: Encryption at Rest Enabled by Default
Copy link
Contributor Author

Choose a reason for hiding this comment

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

isn't by default...

Copy link
Contributor

Choose a reason for hiding this comment

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

Azure does appear to encrypt all data at rest by default for their storage services. If some other provider doesn't do the same, I would say they need to be held to this standard.

https://learn.microsoft.com/en-us/azure/storage/common/storage-service-encryption#about-azure-storage-service-side-encryption

Copy link
Contributor

Choose a reason for hiding this comment

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

If it is not enabled by default for the service that you are working on then I suggest don't include this common feature and create a specific feature for that service

description: |
Provides default encryption of data before storage, with the option for
Provides encryption of data in storage, with the option for
Copy link
Contributor Author

Choose a reason for hiding this comment

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

grammar change only

Copy link
Contributor

Choose a reason for hiding this comment

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

default should be present here

@@ -22,24 +22,12 @@ features:
Allows the setting of a threshold where industry-standard throughput is
achieved up to the specified rate limit.

- id: CCC.F05 # Signed URLs
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't see this as a common feature. Perhaps I've misunderstood signed-urls but they're not ubiquitous.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ubiquitous and common are two different concepts— the idea is to put items in this file if they will be used by multiple other files.

For Signed URLs, we see them on at least 4 different services:

On a separate note, any time we may decide to remove a common entry, we'll also need to correct places where it's already in use:

https://github.com/search?q=repo%3Afinos%2Fcommon-cloud-controls%20CCC.F05&type=code

Copy link
Contributor

Choose a reason for hiding this comment

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

Common features do not need to apply for all services. We include the common features that do apply to the specific service in the feature file. If there are more than 1 service that has the same feature or you think there are more services that can use that feature when we start working on them in future we can add it as a common feature.

Copy link
Contributor

@eddie-knight eddie-knight left a comment

Choose a reason for hiding this comment

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

Some of the proposed changes here don't seem to be accurate

@@ -1,13 +1,13 @@
features:
- id: CCC.F01 # Encryption in Transit Enabled by Default
title: Encryption in Transit Enabled by Default
Copy link
Contributor

Choose a reason for hiding this comment

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

If it is not enabled by default for the service that you are working on then I suggest don't include this common feature and create a specific feature for that service


- id: CCC.F02 # Encryption at Rest Enabled by Default
title: Encryption at Rest Enabled by Default
Copy link
Contributor

Choose a reason for hiding this comment

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

If it is not enabled by default for the service that you are working on then I suggest don't include this common feature and create a specific feature for that service

@@ -22,24 +22,12 @@ features:
Allows the setting of a threshold where industry-standard throughput is
achieved up to the specified rate limit.

- id: CCC.F05 # Signed URLs
Copy link
Contributor

Choose a reason for hiding this comment

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

Common features do not need to apply for all services. We include the common features that do apply to the specific service in the feature file. If there are more than 1 service that has the same feature or you think there are more services that can use that feature when we start working on them in future we can add it as a common feature.

title: Event Notifications
description: |
Publishes events for creation, deletion, and modification of
objects in a way that enables users to trigger actions in response.
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure why this is removed

description: |
Provides default encryption of data before storage, with the option for
Provides encryption of data in storage, with the option for
Copy link
Contributor

Choose a reason for hiding this comment

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

default should be present here

@eddie-knight
Copy link
Contributor

Hey @ianwalkersmithciticom, appreciate the intent here— though the changes don't seem to be aligned with the project vision.

GitHub Issues may be a good way to reopen some of this topic for consideration, or if you have any more changes that you want to find alignment on prior to working on a PR.

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

Successfully merging this pull request may close these issues.

3 participants