Skip to content

Commit 5ff9815

Browse files
authored
enterprise deployment docs (#1418)
## Enterprise Deployment Documentation Added comprehensive deployment guides for Bifrost Enterprise across major cloud platforms and on-premise environments. These guides provide detailed instructions for deploying Bifrost using cloud-native identity federation and secure authentication methods. ## Changes - Added overview page explaining the enterprise deployment architecture and authentication options - Created detailed deployment guides for AWS (using IRSA/IAM Task Roles) - Added GCP deployment guide using Workload Identity - Added Azure deployment guide using Workload Identity Federation to GCP - Created on-premise deployment guide for air-gapped environments - Improved OpenAPI bundle workflow to handle branch detection and Git configuration ## Type of change - [ ] Bug fix - [ ] Feature - [ ] Refactor - [x] Documentation - [x] Chore/CI ## Affected areas - [ ] Core (Go) - [ ] Transports (HTTP) - [ ] Providers/Integrations - [ ] Plugins - [ ] UI (Next.js) - [x] Docs ## How to test 1. Review the deployment guides for accuracy and completeness 2. Verify the OpenAPI bundle workflow changes by triggering the workflow ```sh # Test OpenAPI bundle workflow cd docs/openapi python bundle.py ``` ## Breaking changes - [x] No ## Related issues Addresses the need for enterprise deployment documentation ## Security considerations - Guides follow security best practices for each cloud platform - Authentication methods prioritize keyless approaches (IRSA, Workload Identity) - Includes credential rotation procedures and security recommendations ## Checklist - [x] I read `docs/contributing/README.md` and followed the guidelines - [x] I updated documentation where needed - [x] I verified the CI pipeline passes locally if applicable
2 parents fbe3d2d + c796d7a commit 5ff9815

File tree

8 files changed

+1917
-12
lines changed

8 files changed

+1917
-12
lines changed

.github/workflows/openapi-bundle.yml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ on:
44
push:
55
branches: ["main"]
66
paths:
7+
- ".github/workflows/openapi-bundle.yml"
78
- "docs/openapi/**"
89
- "!docs/openapi/openapi.json"
910
pull_request:
@@ -29,27 +30,26 @@ jobs:
2930
with:
3031
python-version: "3.11"
3132

33+
- name: Configure Git
34+
run: |
35+
git config user.name "GitHub Actions Bot"
36+
git config user.email "github-actions[bot]@users.noreply.github.com"
37+
3238
- name: Install dependencies
3339
run: pip install pyyaml
3440

3541
- name: Bundle OpenAPI spec
3642
working-directory: ./docs/openapi
3743
run: python bundle.py
3844

39-
- name: Check for changes
40-
id: changes
45+
- name: Commit and push changes
4146
run: |
42-
if git diff --quiet docs/openapi/openapi.json; then
43-
echo "changed=false" >> $GITHUB_OUTPUT
44-
else
45-
echo "changed=true" >> $GITHUB_OUTPUT
47+
CURRENT_BRANCH="$(git rev-parse --abbrev-ref HEAD)"
48+
if [ "$CURRENT_BRANCH" = "HEAD" ]; then
49+
# In detached HEAD state (common in CI), use GITHUB_REF_NAME or default to main
50+
CURRENT_BRANCH="${GITHUB_REF_NAME:-main}"
4651
fi
4752
48-
- name: Commit and push changes
49-
if: steps.changes.outputs.changed == 'true' && github.event_name == 'push'
50-
run: |
51-
git config --local user.email "github-actions[bot]@users.noreply.github.com"
52-
git config --local user.name "github-actions[bot]"
5353
git add docs/openapi/openapi.json
5454
git commit -m "chore: regenerate openapi.json --skip-pipeline"
55-
git push
55+
git push origin "$CURRENT_BRANCH"

.github/workflows/release-pipeline.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ jobs:
8282
uses: actions/setup-go@v5
8383
with:
8484
go-version: "1.25.5"
85+
8586
- name: Configure Git
8687
run: |
8788
git config user.name "GitHub Actions Bot"

0 commit comments

Comments
 (0)