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

Enable Goole WIF Support for Tecton-Caches #71

Closed
wants to merge 9 commits into from
62 changes: 62 additions & 0 deletions dev/google-wif.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
#!/usr/bin/env bash
set -x
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should have this script in e2e section.

Copy link
Contributor Author

@pramodbindal pramodbindal Oct 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For now we dont have have e2e for GCS and AWS as that will require test accounts configuration in Github action. once that is done we can move it to e2e.

#Step 0 - Define Common Variables

POOL_ID=openshift-pool
PROVIDER_ID=opeshift-wif
NAMESPACE=default
SERVICE_ACCOUNT=default
PROJECT_ID=pipelines-qe
PROJECT_NUMBER=272779626560
MAPPED_SUBJECT=system:serviceaccount:$NAMESPACE:$SERVICE_ACCOUNT

#Step 1 - Enable IAM APIs on Google Cloud

# Step 2 - Define an attribute mapping and condition
MAPPINGS=google.subject=assertion.sub


#Step 3 - Create workload identity pool and provider
ISSUER=$(kubectl get --raw /.well-known/openid-configuration | jq -r .issuer)


# Download the cluster's JSON Web Key Set (JWKS):
kubectl get --raw /openid/v1/jwks > cluster-jwks.json


# Create a new workload identity pool:
gcloud iam workload-identity-pools create $POOL_ID \
--location="global" \
--description="DESCRIPTION" \
--display-name="DISPLAY_NAME"


# Add the Kubernetes cluster as a workload identity pool provider and upload the cluster's JWKS:

gcloud iam workload-identity-pools providers create-oidc $PROVIDER_ID \
--location="global" \
--workload-identity-pool=$POOL_ID \
--issuer-uri=$ISSUER \
--attribute-mapping=$MAPPINGS \
--jwk-json-path="cluster-jwks.json"


# Create Service Account or use default one

# kubectl create serviceaccount $KSA_NAME --namespace $NAMESPACE

# Grant IAM access to the Kubernetes ServiceAccount for a Google Cloud resource.
gcloud projects add-iam-policy-binding projects/$PROJECT_ID \
--role=roles/owner \
--member=principal://iam.googleapis.com/projects/$PROJECT_NUMBER/locations/global/workloadIdentityPools/$POOL_ID/subject/$MAPPED_SUBJECT \
--condition=None

gcloud iam workload-identity-pools create-cred-config \
projects/$PROJECT_NUMBER/locations/global/workloadIdentityPools/$POOL_ID/providers/$PROVIDER_ID \
--credential-source-file=/workspace/token/token \
--credential-source-type=text \
--output-file=credential-configuration.json



kubectl -n $NAMESPACE create secret generic gcs-cred --from-file=credential-configuration.json
24 changes: 22 additions & 2 deletions dev/install.sh
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,9 +1,29 @@
#!/usr/bin/env bash

# Create a Kind Cluster if dont have sone
#kind create cluster --name tekton-caches --config kind/kind-config.yaml


# Install Pipelines if not already installed.
#kubectl apply --filename https://storage.googleapis.com/tekton-releases/pipeline/latest/release.yaml

#Enable Step Actions Feature
kubectl patch configmap -n tekton-pipelines --type merge -p '{"data":{"enable-step-actions": "true"}}' feature-flags

kubectl create secret generic regcred \
--from-file=config.json=${HOME}/.docker/config.json
# Create Docker creds secret Specifc to OCI Images
#kubectl create secret generic regcred --from-file=config.json=${HOME}/.docker/config.json

# Create Secret for AWS S3
#kubectl create secret generic aws-cred --from-file=${HOME}/.aws/config --from-file=${HOME}/.aws/credentials

#Deploy Step Actions
ko apply -BRf ./step-action

# Deploy Pipelines
kubectl apply -f ./pipeline

#Create PipelineRuns using this command
kubectl create -f ./pr



7 changes: 7 additions & 0 deletions dev/kind/kind-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
kind: Cluster
apiVersion: kind.x-k8s.io/v1alpha4
nodes:
- role: control-plane
- role: worker
- role: worker
- role: worker
107 changes: 107 additions & 0 deletions dev/pipeline/pipeline-wif.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
---
apiVersion: tekton.dev/v1
kind: Pipeline
metadata:
name: pipeline-wif
spec:
params:
- name: repo_url
type: string
- name: revision
type: string
- name: registry
type: string
- name: buildCommand
type: string
default: go build -v .
- name: cachePatterns
type: array
default: [ "**go.mod", "**go.sum" ]
- name: image
type: string
default: golang:latest
- name: force-cache-upload
type: string
default: "false"
workspaces:
- name: source
- name: cred
- name: token
tasks:
- displayName: Build go application
name: build-task
workspaces:
- name: source
- name: cred
- name: token
taskSpec:
params:
- name: buildCommand
default: $(params.buildCommand)
- name: cachePatterns
default: $(params.cachePatterns)
- name: image
default: $(params.image)
steps:
- name: create-repo
image: $(params.image)
script: |
mkdir -p $(workspaces.source.path)/repo
chmod 777 $(workspaces.source.path)/repo
- name: fetch-repo
ref:
resolver: http
params:
- name: url
value: https://raw.githubusercontent.com/tektoncd/catalog/main/stepaction/git-clone/0.1/git-clone.yaml
params:
- name: output-path
value: $(workspaces.source.path)/repo
- name: url
value: $(params.repo_url)
- name: revision
value: $(params.revision)
- name: cache-fetch
ref:
name: cache-fetch
params:
- name: patterns
value: $(params.cachePatterns)
- name: source
value: $(params.registry)/cache-go:{{hash}}
- name: cachePath
value: $(workspaces.source.path)/cache
- name: workingdir
value: $(workspaces.source.path)/repo
- name: googleCredentialsPath
value: $(workspaces.cred.path)/credential-configuration.json

- name: run-go-build
workingDir: $(workspaces.source.path)/repo
image: $(params.image)
env:
- name: GOCACHE
value: $(workspaces.source.path)/cache/gocache
- name: GOMODCACHE
value: $(workspaces.source.path)/cache/gomodcache
script: |
set -x
git config --global --add safe.directory $(workspaces.source.path)/repo
$(params.buildCommand)
echo "Cache size is $(du -sh $(workspaces.source.path)/cache)"
- name: cache-upload
ref:
name: cache-upload
params:
- name: patterns
value: $(params.cachePatterns)
- name: target
value: $(params.registry)/cache-go:{{hash}}
- name: cachePath
value: $(workspaces.source.path)/cache
- name: workingdir
value: $(workspaces.source.path)/repo
- name: googleCredentialsPath
value: $(workspaces.cred.path)/credential-configuration.json
- name: force-cache-upload
value: $(params.force-cache-upload)
34 changes: 34 additions & 0 deletions dev/pr/gcs-wif-pipelinerun.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file should ideally be in example folder.

apiVersion: tekton.dev/v1
kind: PipelineRun
metadata:
generateName: pipelinerun-gcs-
spec:
pipelineRef:
name: pipeline-wif
params:
- name: repo_url
value: https://github.com/chmouel/go-helloworld
- name: revision
value: main
# This uses GCS bucket to upload Caches
- name: registry
value: gs://tekton-caches
- name: buildCommand
value: go build -v ./
- name: image
value: golang:1.21
workspaces:
- name: source
emptyDir: { }
- name: cred
secret:
secretName: gcs-cred
- name: token
projected:
sources:
- serviceAccountToken:
audience: https://iam.googleapis.com/projects/272779626560/locations/global/workloadIdentityPools/openshift-pool/providers/opeshift-wif
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please put this in conventional format for k8s and OpenShift?

Copy link
Member

@khrm khrm Oct 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some of our customers will complain that WIF isn't properly supported if do this. We already have a mail on this for OpenShift Logging.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They way it was setup audience is getting generated like this only. Will check if this can be simplified

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that and location where we project should also be similar.

expirationSeconds: 3600
path: token

2 changes: 1 addition & 1 deletion dev/step-action/cache-upload.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,12 @@ spec:
value: $(params.googleCredentialsPath)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file should be in the config folder. That's how we do it for every other Tekton project.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be done in a separate PR.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We now have step actions in two folder - tekton and this.

Should be merged to config.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May be after productization we can do that. for now we want to keep a dev version which we can use with ko:// and a released version which can be used for stepAction

- name: CRED_STORE
value: $(params.cred-store)
# FIXME: use a released version once something is released :)
image: ko://github.com/openshift-pipelines/tekton-caches/cmd/cache
args: ["$(params.patterns[*])"]
script: |
#!/usr/bin/env sh
set -x
if [[ ${PARAM_FORCE_CACHE_UPLOAD} == "false" && ${RESULT_CACHE_FETCHED} == "true" ]]; then
echo "no need to upload cache"
exit 0
Expand Down
11 changes: 6 additions & 5 deletions internal/fetch/fetch.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,10 @@ import (
"os"
"strings"

"github.com/openshift-pipelines/tekton-caches/internal/tar"

"github.com/openshift-pipelines/tekton-caches/internal/provider/s3"

"github.com/openshift-pipelines/tekton-caches/internal/provider/gcs"
"github.com/openshift-pipelines/tekton-caches/internal/provider/oci"
"github.com/openshift-pipelines/tekton-caches/internal/provider/s3"
"github.com/openshift-pipelines/tekton-caches/internal/tar"
)

func Fetch(ctx context.Context, hash, target, folder string, insecure bool) error {
Expand All @@ -39,7 +37,10 @@ func Fetch(ctx context.Context, hash, target, folder string, insecure bool) erro
}
return tar.Untar(ctx, file, folder)
case "gs":
return gcs.Fetch(ctx, hash, source, folder)
if err := gcs.Fetch(ctx, source, file.Name()); err != nil {
return err
}
return tar.Untar(ctx, file, folder)
default:
return fmt.Errorf("unknown schema: %s", target)
}
Expand Down
41 changes: 0 additions & 41 deletions internal/provider/gcs/common.go

This file was deleted.

Loading