ksobrenat32 commented on code in PR #35524: URL: https://github.com/apache/beam/pull/35524#discussion_r2261621610
########## infra/keys/README.md: ########## @@ -0,0 +1,93 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# Service Account Management + +This module is used to manage Google Cloud service accounts, including creating, retrieving, enabling, and deleting service accounts and their keys. It uses the Google Cloud IAM API to perform these operations. + +## Features + +- Create service accounts and service account keys. +- Store service account keys securely in Google Secret Manager. +- Rotate service account keys regularly. +- Enable and disable service accounts. + +## Usage + +We use the main.py script to manage service account keys. The script can be run with different commands to create, rotate, or retrieve service account keys. + +### Prerequisites + +- Google Cloud SDK installed and configured. +- Appropriate permissions to manage service accounts and secrets in your Google Cloud project. +- Required Python packages installed (see requirements.txt). + +### Configuration + +#### config.yaml + +This file contains configuration settings for the service account management, including project ID, key rotation settings, and logging configuration. + +#### keys.yaml + +All the service accounts are managed through a configuration file in YAML format, `keys.yaml`. This file contains the necessary information about each service account, including its ID, display name, and authorized users. + +```yaml +service_accounts: + - account_id: my-service-account + display_name: My Service Account + authorized_users: + - email: us...@example.com + - email: us...@example.com +``` + +Where: + +- `account_id`: The unique identifier for the service account. +- `display_name`: A human-readable name for the service account. +- `authorized_users`: A list of users who will be granted access to the service account. + +The accounts defined in this file will be created if they do not already exist when running the script. Review Comment: Added to readme :) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: github-unsubscr...@beam.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
