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

Ask: Document process for common tasks #1298

Open
jburos opened this issue Jul 18, 2024 · 3 comments
Open

Ask: Document process for common tasks #1298

jburos opened this issue Jul 18, 2024 · 3 comments
Labels
backlog documentation Improvements or additions to documentation enhancement New feature or request Stale v5.0

Comments

@jburos
Copy link

jburos commented Jul 18, 2024

TL;DR

I'm relatively new to devops and trying to learn from this example. The doc is great (and very useful) for setting up the environment, but once it's set up I am at a loss re: how to accomplish a common task. I'm thinking along the lines of a "runbook" for using this setup.

Some examples:

  • Create a new project
  • Grant a user permissions in an existing project
  • Grant a user permissions to administrate gcp-projects repo
  • Modify constraints on a project
  • Reviewing access logs
  • etc.

Terraform Resources

No response

Detailed design

Some other considerations:

1. Common maintenance tasks
    - For example, for my JS apps, I have a scheduled maintenance task to  periodically update the code to the latest versions. Is there an analog for terraform & related modules? I find the APIs do change over time.

Additional information

If this exists already and I have missed it, apologies. A link to examples would be appreciated.

@jburos jburos added the enhancement New feature or request label Jul 18, 2024
@eeaton eeaton added documentation Improvements or additions to documentation backlog v5.0 labels Jul 19, 2024
@eeaton
Copy link
Collaborator

eeaton commented Jul 19, 2024

Thanks for the feedback. It's a fair point that the amount of understanding needed to operate the blueprint is non-trivial, spanning GCP features, and devops practices, and some of the specific design choices of this blueprint. I'll add this to the backlog to try to better document in the next major release.

If you haven't seen it already, the accompanying guide https://cloud.google.com/architecture/security-foundations/deployment-methodology has some high-level explanation of how to customize and make future changes to the code in our recommended DevOps flow. Doesn't address some of the tasks you mention, but it might be a good place to start.

@jburos
Copy link
Author

jburos commented Jul 22, 2024

Thank you sincerely, this and the link are both helpful.

Copy link

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days

@github-actions github-actions bot added the Stale label Sep 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog documentation Improvements or additions to documentation enhancement New feature or request Stale v5.0
Projects
None yet
Development

No branches or pull requests

2 participants