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 GCP credentials docs #6837

Merged
merged 4 commits into from
Dec 15, 2023
Merged

Conversation

GGP1
Copy link
Member

@GGP1 GGP1 commented Dec 7, 2023

Description

Improves the GCP credentials documentation by adding a new section explaining how to create a custom role for the gcp-bucket module and a service account creation image.

Checks

Docs building

  • Compiles without warnings.

Code formatting and web optimization

  • Uses three spaces indentation.
  • Adds or updates meta descriptions accordingly.
  • Updates the redirects.js script if necessary (check this guide).

Writing style

  • Uses present tense, active voice, and semi-formal registry.
  • Uses short, simple sentences.
  • Uses bold for user interface elements, italics for key terms or emphasis, and code font for Bash commands, file names, REST paths, and code.

@GGP1 GGP1 self-assigned this Dec 7, 2023
@GGP1 GGP1 linked an issue Dec 7, 2023 that may be closed by this pull request
3 tasks
@fdalmaup fdalmaup self-requested a review December 7, 2023 18:46
Copy link
Member

@fdalmaup fdalmaup left a comment

Choose a reason for hiding this comment

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

LGTM!

@javimed javimed added level/task Task issue type/bug Bug issue labels Dec 14, 2023
source/cloud-security/gcp/prerequisites/credentials.rst Outdated Show resolved Hide resolved

The ``gcp-bucket`` module requires permissions to access storage buckets and objects. These permissions were originally assigned using the **Storage Legacy Bucket Writer** role, but it is no longer available for selection, so it will be necessary to create a new one.

To do so, follow these steps:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
To do so, follow these steps:
To create the new role, follow these steps:


To do so, follow these steps:

1. Go to the **Roles** section and click on **Create Role**.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
1. Go to the **Roles** section and click on **Create Role**.
#. Go to the **Roles** section and click on **Create Role**.

To do so, follow these steps:

1. Go to the **Roles** section and click on **Create Role**.
2. Choose a name and click on **Add Permissions**.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
2. Choose a name and click on **Add Permissions**.
#. Establish a **Title** and click on **Add Permissions**.


1. Go to the **Roles** section and click on **Create Role**.
2. Choose a name and click on **Add Permissions**.
3. On the search bar, type **Storage Legacy Bucket Writer** and select the following permissions:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
3. On the search bar, type **Storage Legacy Bucket Writer** and select the following permissions:
#. On the search bar, filter available permissions by typing **Storage Legacy Bucket Writer**. Select the following ones:

@GGP1 GGP1 force-pushed the fix/4996-update-gcp-credentials-docs branch from 681b78e to 0f57c64 Compare December 15, 2023 11:44
Creating a custom role
----------------------

The ``gcp-bucket`` module requires permissions to access storage buckets and objects. These permissions were originally assigned using the **Storage Legacy Bucket Writer** role, but it is no longer available for selection, so it will be necessary to create a new one.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
The ``gcp-bucket`` module requires permissions to access storage buckets and objects. These permissions were originally assigned using the **Storage Legacy Bucket Writer** role, but it is no longer available for selection, so it will be necessary to create a new one.
The ``gcp-bucket`` module requires permissions to access storage buckets and objects. To create a role with the required permissions, follow these steps:


The ``gcp-bucket`` module requires permissions to access storage buckets and objects. These permissions were originally assigned using the **Storage Legacy Bucket Writer** role, but it is no longer available for selection, so it will be necessary to create a new one.

To create the new role, follow these steps:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
To create the new role, follow these steps:

@GGP1 GGP1 requested a review from javimed December 15, 2023 19:22
@javimed javimed merged commit 5bb8cc0 into 4.7.2 Dec 15, 2023
@javimed javimed deleted the fix/4996-update-gcp-credentials-docs branch December 15, 2023 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
level/task Task issue type/bug Bug issue
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Update Configuring GCP credentials documentation
4 participants