Skip to content

Latest commit

 

History

History
128 lines (100 loc) · 3.31 KB

DEVELOPMENT.md

File metadata and controls

128 lines (100 loc) · 3.31 KB
Raw

Local Development Install

When using public registries

Access to a Kubernetes cluster is needed in order to install the kpack controllers.

kubectl cluster-info # ensure you have access to a cluster
./hack/apply.sh <IMAGE/NAME> # <IMAGE/NAME> is a writable and publicly accessible location

When using private registries

Create a kubernetes secret with the registry creds

kubectl create secret docker-registry regcreds -n kpack --docker-server=gcr.io --docker-username=_json_key --docker-password="$(cat gcp.json)"

Create an overlay to use those registry creds

cat > ./config/overlay.yaml <<EOF
#@ load("@ytt:overlay", "overlay")

#@overlay/match by=overlay.subset({"kind": "ServiceAccount"}),expects=2
---
#@overlay/match missing_ok=True
imagePullSecrets:
  #@overlay/append
  - name: regcreds
#@overlay/match missing_ok=True
secrets:
  #@overlay/append
  - name: regcreds

#@overlay/match by=overlay.subset({"metadata":{"name":"kpack-controller"}, "kind": "Deployment"})
---
spec:
  template:
    spec:
      containers:
        #@overlay/match by="name"
        - name: controller
          #@overlay/match missing_ok=True
          env:
            #@overlay/append
            - name: CREDENTIAL_PROVIDER_SECRET_PATH
              value: /var/kpack/credentials
          #@overlay/match missing_ok=True
          volumeMounts:
            #@overlay/append
            - name: credentials
              mountPath: /var/kpack/credentials
              readOnly: true
      #@overlay/match missing_ok=True
      volumes:
        #@overlay/append
        - name: credentials
          secret:
            secretName: regcreds
EOF

Running Unit Tests

go test ./pkg/...

Running End-to-end Tests

go test ./test/...

  • To run the e2e tests, kpack must be installed and running on a cluster

  • The KPACK_TEST_NAMESPACE_LABELS environment variable allows you to define additional labels for the test namespace, e.g.

export KPACK_TEST_NAMESPACE_LABELS="istio-injection=disabled,purpose=test"
  • The IMAGE_REGISTRY environment variable must point at a registry with local write access
IMAGE_REGISTRY=gcr.io/<some-project> go test ./test/...

Libgit2 v1.3.0 Dependency and Installation

Several unit tests depend upon libgit2 v1.3.0.

macOS Installation Instructions (Intel):

  1. Install cmake and pkg-config
brew install cmake pkg-config
  1. Verify no conflicting version of libgit2 is installed
pkg-config --print-provides libgit2

You should expect output which reads either: Package libgit2 was not found in the pkg-config search path or libgit2 = 1.3.0. If a version of libgit2 other than 1.3.0 is reported as installed, consider uninstalling 1.3.0 or running the unit tests in a different environment.

  1. Download libgit2 v1.3.0 source code
mkdir libgit2-install && cd libgit2-install
curl -L -O https://github.com/libgit2/libgit2/archive/refs/tags/v1.3.0.tar.gz
  1. Compile and Install
tar -zxf libgit2-1.3.0.tar.gz
cd libgit2-1.3.0
mkdir build && cd build
cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local -DCMAKE_OSX_ARCHITECTURES="x86_64"
cmake --build . --target install
  1. Verify installation
pkg-config --print-provides libgit2

You should expect output which reads: libgit2 = 1.3.0