Skip to content

Add Bitbucket federation docs, CI/CD reference, and pre-requisites to federation pages#420

Merged
alexellis merged 2 commits intoopenfaas:masterfrom
welteki:bitbucket-oidc
Apr 2, 2026
Merged

Add Bitbucket federation docs, CI/CD reference, and pre-requisites to federation pages#420
alexellis merged 2 commits intoopenfaas:masterfrom
welteki:bitbucket-oidc

Conversation

@welteki
Copy link
Copy Markdown
Member

@welteki welteki commented Mar 27, 2026

Description

Add Web Identity Federation guide for Bitbucket Pipelines, covering OIDC issuer setup, custom audience configuration, and example pipelines.

Add a CI/CD reference page for Bitbucket Pipelines with examples for building, pushing, and deploying functions.

Add a pre-requisites section to all federation pages (Bitbucket, GitHub Actions, GitLab) documenting the faas-cli pro CLI license requirement and how to configure it in each CI provider.

Motivation and Context

Bitbucket Pipelines users had no documentation for deploying to OpenFaaS using OIDC federation or for setting up CI/CD pipelines. The faas-cli pro plugin now supports a CLI license for use in CI workflows, which needs to be documented across all federation guides.

  • I have raised an issue to propose this change (required)

How Has This Been Tested?

Reviewed rendered markdown locally.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have signed-off my commits with git commit -s

@reviewfn

This comment has been minimized.

@alexellis
Copy link
Copy Markdown
Member

Could you take a pass over the "Detailed Review" please?

@reviewfn

This comment has been minimized.

@welteki welteki changed the title Add Bitbucket federation docs, add pre-requisites to all federation pages Add Bitbucket federation docs, CI/CD reference, and pre-requisites to federation pages Mar 30, 2026
@reviewfn

This comment has been minimized.

@reviewfn

This comment has been minimized.

@reviewfn

This comment has been minimized.

welteki added 2 commits March 30, 2026 19:00
…ages

Add guide for Bitbucket Pipelines Web Identity Federation.

All federation pages now document the faas-cli pro license requirement
and how to configure it as a secret/variable in each CI provider.

Signed-off-by: Han Verstraete (OpenFaaS Ltd) <han@openfaas.com>
Signed-off-by: Han Verstraete (OpenFaaS Ltd) <han@openfaas.com>
@reviewfn
Copy link
Copy Markdown

reviewfn bot commented Mar 30, 2026

AI Pull Request Overview

Summary

  • Adds comprehensive Bitbucket Pipelines federation documentation for OpenFaaS IAM
  • Includes OIDC issuer setup, custom audience configuration, and example pipelines
  • Adds CI/CD reference page for Bitbucket Pipelines with build, push, and deploy examples
  • Adds pre-requisites sections to all federation pages documenting faas-cli pro license requirements
  • Updates existing GitHub Actions and GitLab federation docs with license info and minor fixes
  • Updates navigation in mkdocs.yml to include new Bitbucket pages

Approval rating (1-10)

8 - Solid documentation with good consistency, but some outdated references in examples.

Summary per file

Summary per file
File path Summary
docs/images/iam/bitbucket-oidc-settings.png Added screenshot for Bitbucket OIDC settings
docs/openfaas-pro/iam/bitbucket-federation.md New comprehensive guide for Bitbucket federation with IAM
docs/openfaas-pro/iam/github-actions-federation.md Added license pre-requisites and minor policy updates
docs/openfaas-pro/iam/gitlab-federation.md Added license pre-requisites and minor policy updates
docs/openfaas-pro/iam/overview.md Added link to Bitbucket federation in examples
docs/reference/cicd/bitbucket.md New CI/CD guide for Bitbucket Pipelines
mkdocs.yml Added navigation entries for new Bitbucket pages

Overall Assessment

The PR successfully adds missing Bitbucket support to OpenFaaS IAM federation and CI/CD documentation. The new content follows the established patterns from GitHub and GitLab guides, maintaining consistency. License pre-requisites have been appropriately added across all federation docs. Minor updates to policies and workflows improve functionality. No security or correctness issues identified in the technical content.

Detailed Review

Detailed Review

docs/openfaas-pro/iam/bitbucket-federation.md

  • The JWT claims example accurately reflects Bitbucket's OIDC token structure based on their documentation
  • Custom audience configuration correctly matches the JwtIssuer aud field requirements
  • Policy and Role examples properly scope permissions to specific repositories and branches
  • Pipeline examples include proper OIDC configuration and token usage
  • The reference to CI/CD guide in line 108 is correct and helpful

docs/reference/cicd/bitbucket.md

  • Pipeline structure follows standard Bitbucket practices
  • Environment variable usage for registry and namespace is properly templated
  • Recommendation for federation over password auth is appropriate for enterprises
  • Build validation step correctly excludes push to avoid test artifacts
  • Parallel build flag mention is useful for performance

docs/openfaas-pro/iam/github-actions-federation.md

  • Added Function:Update permission is necessary for deployment workflows
  • License environment variable setup is consistent with other federation docs
  • Removal of deprecated faas-cli pro enable command is appropriate
  • Token expiry explanation improves understanding of security trade-offs

docs/openfaas-pro/iam/gitlab-federation.md

  • Similar improvements as GitHub: added update permission and license setup
  • Removed obsolete enable command maintains current CLI usage
  • Variable masking and protection settings are correctly documented

docs/openfaas-pro/iam/overview.md

  • Addition of Bitbucket federation link maintains alphabetical ordering in examples

mkdocs.yml

  • Navigation additions correctly place Bitbucket docs alongside other federation guides
  • CI/CD section ordering maintains logical flow

Potential Improvements

  • GitHub Actions example uses @master branch which may be outdated; consider updating to specific version tag for reproducibility
  • GitLab CI example installs git unnecessarily since curl is already available in the image
  • Bitbucket federation could mention workspace-level vs repository-level variables for license configuration clarity

AI agent details.

Agent processing time: 45.347s
Environment preparation time: 4.225s
Total time from webhook: 54.338s

@alexellis alexellis merged commit 27b14b6 into openfaas:master Apr 2, 2026
5 checks passed
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.

2 participants