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

DEVOPS-7868 1password get field and get kubeconfig actions #103

Merged
merged 3 commits into from
Jun 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions 1password/get-item-field/action.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: 'Get item field from 1Password'
description: "Gets a field from specified 1Password vault/item"
inputs:
op-sa-token:
required: true
description: "1Password Service Account Token"
op-vault:
required: true
description: "1Password Vault"
op-item:
required: true
description: "1Password Item"
op-field:
required: true
description: "1Password Item.Field"
outputs:
field:
description: Value from 1Password Item.Field
value: ${{ steps.get-item-field.outputs.field }}

runs:
using: "composite"
steps:
- name: Install 1Password CLI
uses: 1password/install-cli-action@v1

- name: Get item field
id: get-item-field
shell: bash
env:
OP_SERVICE_ACCOUNT_TOKEN: ${{ inputs.op-sa-token }}
run: echo "field=$(op item get ${{ inputs.op-item }} --vault=${{ inputs.op-vault }} --fields label=${{ inputs.op-field }})" >> $GITHUB_OUTPUT
34 changes: 34 additions & 0 deletions 1password/get-kubeconfig/action.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: 'Get Kubeconfig from 1Password'
description: "Gets a kubeconfig from specified 1Password vault/item"
inputs:
op-sa-token:
required: true
description: "1Password Service Account Token"
op-vault:
required: true
description: "1Password Vault"
default: "Promil-preprod-gha-kubeconfigs"
op-item:
required: true
description: "1Password Item"
outputs:
kubeconfig:
description: Value from 1Password Item.kubeconfig
value: ${{ steps.decode-kubeconfig.outputs.kubeconfig }}

runs:
using: "composite"
steps:
- name: Get Kubeconfig from 1Password
id: get-kubeconfig
uses: PiwikPRO/actions/1password/get-item-field@master
with:
op-sa-token: ${{ inputs.op-sa-token }}
op-vault: ${{ inputs.op-vault }}
op-item: ${{ inputs.op-item }}
op-field: kubeconfig

- name: Decode kubeconfig
id: decode-kubeconfig
shell: bash
run: echo "kubeconfig=$(echo '${{ steps.get-kubeconfig.outputs.field }}' | base64 --decode)" >> $GITHUB_OUTPUT
74 changes: 74 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@
- [K6](#k6)
- [Benchmarking](#benchmarking)
- [Platform outdated dependencies notifier](#platform-outdated-dependencies-notifier)
- [1Password](#1Password)
- [Get item field](#get-item-field)
- [Get kubeconfig](#get-kubeconfig)
<!--toc:end-->

Custom github actions and reusable workflows used both internally and externally by Piwik PRO employees. This repo is public and licensed on MIT license, but contains some actions, that cannot be launched without Piwik PRO proprietary components or secrets - sorry!
Expand Down Expand Up @@ -641,3 +644,74 @@ jobs:
github-token-charts: ${{ steps.get-token.outputs.token }}
github-token-platform: ${{ secrets.GITHUB_TOKEN }}
```

### 1Password
#### Get item field
`1password/get-item-field` action is a Github Action that fetches specified field from 1Password item.

Example usage:
```yaml
on:
pull_request:
push:
branches: ["master"]
name: Test actions
jobs:
test-get-field:
runs-on: ubuntu-latest
timeout-minutes: 2
steps:
- name: Check out repository code
uses: actions/checkout@v3

- name: Get field
id: get-field
uses: PiwikPRO/actions/1password/get-item-field@master
with:
op-sa-token: <token-from-secrets>
op-vault: foo
op-item: bar
op-field: xyz

- name: Echo get-field
shell: bash
run: echo ${{ steps.get-field.outputs.field }}
```

#### Get kubeconfig
`1password/get-kubeconfig` action is a Github Action that fetches `kubeconfig` field from 1Password item and base64 decodes it.

Example usage:
```yaml
on:
pull_request:
push:
branches: ["master"]
name: Test actions
jobs:
test-get-kubeconfig:
runs-on: ubuntu-latest
timeout-minutes: 2
strategy:
fail-fast: false
max-parallel: 2
matrix:
infra-name:
example-infra-1
example-infra-2
steps:
- name: Check out repository code
uses: actions/checkout@v3

- name: Get kubeconfig
id: get-kubeconfig
uses: PiwikPRO/actions/1password/get-kubeconfig@master
with:
op-sa-token: ${{ secrets.OP_PREPROD_KUBECONFIG_SA_TOKEN}}
op-vault: ${{ secrets.OP_PREPROD_KUBECONFIG_VAULT }}
op-item: ${{ matrix.infra-name }}

- name: Echo get-kubeconfig
shell: bash
run: echo ${{ steps.get-kubeconfig.outputs.kubeconfig }}
```
Loading