Skip to content

Flux tutorial - add required token role level

David Tulloh requested to merge dtulloh/gitlab:docs/flux-tutorial-token-developer-role into master

What does this MR do?

Add required token role level

Creating a project token defaults to the guest role. Creating a token with the api scope and guest role is insufficient as it does not allow checking out the code of the repository, the bootstrap git checkout step fails with a permission error. A project token with the api scope and developer role works.

Before, with a project token that had api permissions but the default guest role.

► connecting to https://private
► cloning branch "private" from Git repository "https://private/private.git"
⚠️  clone failure: unable to clone 'https://private/private.git': authorization failed
⚠️  clone failure: unable to clone 'https://private/private.git': authorization failed
✗ failed to clone repository: unable to clone 'https://private/private.git': authorization failed

After, with a project token that had api permissions and the developer role set.

► connecting to https://private
► cloning branch "private" from Git repository "https://private/private.git"
✔ cloned repository
► generating component manifests
✔ generated component manifests
...

Related issues

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.

Merge request reports