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

Create default-security-group-rules.md #167

Closed
wants to merge 2 commits into from

Conversation

josephineSei
Copy link
Contributor

a guide for default security group rules

follow-up part of: SovereignCloudStack/standards#521

a guide for default security group rules

Signed-off-by: josephineSei <[email protected]>
josephineSei added a commit to SovereignCloudStack/standards that referenced this pull request Mar 20, 2024
remove example in favor of the guide in docs:
SovereignCloudStack/docs#167

Signed-off-by: josephineSei <[email protected]>
@berendt
Copy link
Member

berendt commented Apr 2, 2024

@markus-hentsch Can you please review this one?


### Example of a conform set of default Security Group Rules

This is an exapmle how a table with default Security Group Rules may look like:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
This is an exapmle how a table with default Security Group Rules may look like:
This is an example how a table with default Security Group Rules may look like:


:::

The default security Group Rules can differ between default Security Groups and all other Security Groups - called `custom Security Group`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The default security Group Rules can differ between default Security Groups and all other Security Groups - called `custom Security Group`.
Default Security Group Rules may be adjusted individually for one of two different types of Security Groups:
1. The default Security Groups that are automatically created for projects initially.
2. Custom Security Groups created by users and initialized with a default rule set.
The default rule set is configured separately for each of those two types.

I found the original sentence a bit hard to grasp due to the meaning of "default" and "custom" being separate between rules and groups making this multi-dimensional but hard to convey in a single sentence. That's the reason I rephrased this to make a more clear distinction.

:::

The default security Group Rules can differ between default Security Groups and all other Security Groups - called `custom Security Group`.
So it is possible as an administrator to define rules only for one of those groups of Security Groups.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
So it is possible as an administrator to define rules only for one of those groups of Security Groups.
So it is possible as an administrator to define rules only for one of those types of Security Groups.

josephineSei added a commit to SovereignCloudStack/standards that referenced this pull request Jun 12, 2024
* Create scs-XXXX-v1-default-rules-for-security-groups.md

First draft of standard for default security group rules

Signed-off-by: josephineSei <[email protected]>

* Update scs-XXXX-v1-default-rules-for-security-groups.md

Signed-off-by: josephineSei <[email protected]>

* Update Standards/scs-XXXX-v1-default-rules-for-security-groups.md

fix typos

Co-authored-by: Sven <[email protected]>
Signed-off-by: josephineSei <[email protected]>

* Create default-security-group-rules.py

Create Test for the default security group rules

Signed-off-by: josephineSei <[email protected]>

* Update default-security-group-rules.py

Signed-off-by: josephineSei <[email protected]>

* Update default-security-group-rules.py

Signed-off-by: josephineSei <[email protected]>

* Update default-security-group-rules.py

Signed-off-by: josephineSei <[email protected]>

* Update default-security-group-rules.py

Signed-off-by: josephineSei <[email protected]>

* Apply suggestions from code review

fix typos and adjust  some wording

Co-authored-by: Markus Hentsch <[email protected]>
Signed-off-by: josephineSei <[email protected]>

* Update scs-XXXX-v1-default-rules-for-security-groups.md

Add example on how to create a rule only for custom security groups

Signed-off-by: josephineSei <[email protected]>

* Update scs-XXXX-v1-default-rules-for-security-groups.md

remove example in favor of the guide in docs:
SovereignCloudStack/docs#167

Signed-off-by: josephineSei <[email protected]>

* Restructure Tests to allow the special ingress case but only for default security groups.

Signed-off-by: josephineSei <[email protected]>

* Change to allow the OpenStack default default SG rules

This will only allow ingress traffic from the same SG for the default security groups.

Signed-off-by: josephineSei <[email protected]>

* change indentation

Signed-off-by: josephineSei <[email protected]>

* adjust the if clause

Signed-off-by: josephineSei <[email protected]>

* Update scs-XXXX-v1-default-rules-for-security-groups.md

Signed-off-by: josephineSei <[email protected]>

* remove unnecessary sentence

Signed-off-by: josephineSei <[email protected]>

* Update scs-XXXX-v1-default-rules-for-security-groups.md

Signed-off-by: josephineSei <[email protected]>

* Update scs-XXXX-v1-default-rules-for-security-groups.md

Signed-off-by: josephineSei <[email protected]>

* Update scs-XXXX-v1-default-rules-for-security-groups.md

Signed-off-by: josephineSei <[email protected]>

* Update scs-XXXX-v1-default-rules-for-security-groups.md

Signed-off-by: josephineSei <[email protected]>

* add tests for egress traffic rules to be present

Signed-off-by: josephineSei <[email protected]>

* Update default-security-group-rules.py

Signed-off-by: josephineSei <[email protected]>

* clarify conformance test abstract

Signed-off-by: josephineSei <[email protected]>

* Update default-security-group-rules.py

Signed-off-by: josephineSei <[email protected]>

* Apply suggestions from code review

Co-authored-by: Markus Hentsch <[email protected]>
Signed-off-by: josephineSei <[email protected]>

* Update scs-XXXX-v1-default-rules-for-security-groups.md

Signed-off-by: josephineSei <[email protected]>

* Apply suggestions from code review

Co-authored-by: Markus Hentsch <[email protected]>
Signed-off-by: josephineSei <[email protected]>

* Update scs-XXXX-v1-default-rules-for-security-groups.md

Signed-off-by: josephineSei <[email protected]>

* Rename scs-XXXX-v1-default-rules-for-security-groups.md to scs-0115-v1-default-rules-for-security-groups.md

Signed-off-by: josephineSei <[email protected]>

---------

Signed-off-by: josephineSei <[email protected]>
Co-authored-by: Sven <[email protected]>
Co-authored-by: Markus Hentsch <[email protected]>
@mbuechse
Copy link
Contributor

@josephineSei @markus-hentsch This seems to have been in limbo for weeks. What's the status here?

@josephineSei
Copy link
Contributor Author

This belonged to SovereignCloudStack/standards#521. Taht issue was closed automatically, when the standard was merged. So this PR was not on my focus anymore.
But as we have a standard document and within that document, we advise to use the current openstack defaults. I don't think we need a guide anymore. What do you think @markus-hentsch ?

@markus-hentsch
Copy link
Contributor

This belonged to SovereignCloudStack/standards#521. Taht issue was closed automatically, when the standard was merged. So this PR was not on my focus anymore. But as we have a standard document and within that document, we advise to use the current openstack defaults. I don't think we need a guide anymore. What do you think @markus-hentsch ?

I agree.

We already added a user-facing guide for custom SG rule handling.
This PR here was initially intended to add an operator-facing guide for the SG rule defaults but since the corresponding standard ended up not deviating from upstream in that regard, all of this can easily be deduced from the standard itself in combination with the upstream documentation of openstack default security group rule ....

@josephineSei josephineSei deleted the guide-for-default-SG-rules branch July 23, 2024 12:41
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.

4 participants