Merge branch 'main' into update_cli_guide

Nordix · Mar 5, 2024 · 2890092 · 2890092
2 parents 58bb6de + 29b1884
commit 2890092
Show file tree

Hide file tree

Showing 6 changed files with 163 additions and 13 deletions.
diff --git a/.github/workflows/porch-e2e.yaml b/.github/workflows/porch-e2e.yaml
@@ -0,0 +1,72 @@
+# Copyright 2024 The Nephio Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: Porch End-to-End Tests
+on:
+  push:
+    paths-ignore:
+      - "docs/**"
+      - "release/**"
+      - "deployments/**"
+  pull_request:
+    paths-ignore:
+      - "docs/**"
+      - "release/**"
+      - "deployments/**"
+
+jobs:
+  tests:
+    name: Porch End-to-End Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Free up disk space
+        run: sudo rm -rf /usr/share/dotnet && sudo rm -rf /opt/ghc && sudo rm -rf "/usr/local/share/boost" && sudo rm -rf "$AGENT_TOOLSDIRECTORY"
+      - name: Checkout Porch
+        uses: actions/checkout@v4
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '>=1.21.5'
+      - name: Setup kubectl
+        uses: azure/setup-kubectl@v3
+      - name: Install kpt
+        uses: jaxxstorm/action-install-gh-release@v1.10.0
+        with:
+          repo: kptdev/kpt
+          tag: v1.0.0-beta.49
+          chmod: 0755
+      - name: Create k8s Kind Cluster
+        uses: helm/kind-action@v1
+        with:
+          cluster_name: kind
+      - name: Build Images and Deploy porch kpt pkg
+        run: IMAGE_REPO=porch-kind IMAGE_TAG=${GITHUB_SHA:0:8} make run-in-kind-kpt
+      - name: Sleep for 15 seconds
+        run: sleep 15s
+        shell: bash
+      - name: e2e test
+        run: E2E=1 go test -v -timeout 20m ${GITHUB_WORKSPACE}/test/e2e
+      - name: Export porch server logs
+        if: always()
+        run: |
+          name=$(kubectl -n porch-system get pod -l app=porch-server -o custom-columns=NAME:.metadata.name --no-headers=true)
+          kubectl -n porch-system logs $name > porch-e2e-server.log
+      - name: Archive logs
+        if: always()
+        uses: actions/upload-artifact@v4  
+        with:
+          name: porch-e2e-server.log
+          path: porch-e2e-server.log
+          compression-level: 0
diff --git a/.github/workflows/porchctl-cli-e2e.yaml b/.github/workflows/porchctl-cli-e2e.yaml
@@ -0,0 +1,72 @@
+# Copyright 2024 The Nephio Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: Porch CLI End-to-End Tests
+on:
+  push:
+    paths-ignore:
+      - "docs/**"
+      - "release/**"
+      - "deployments/**"
+  pull_request:
+    paths-ignore:
+      - "docs/**"
+      - "release/**"
+      - "deployments/**"
+
+jobs:
+  tests:
+    name: Porch CLI End-to-End Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Porch
+        uses: actions/checkout@v4
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '>=1.21.5'
+      - name: Setup kubectl
+        uses: azure/setup-kubectl@v3
+      - name: Install kpt
+        uses: jaxxstorm/action-install-gh-release@v1.10.0
+        with:
+          repo: kptdev/kpt
+          tag: v1.0.0-beta.49
+          chmod: 0755
+      - name: Build and install porchctl
+        run: |
+          go build -o ${GITHUB_WORKSPACE}.build/ ./cmd/porchctl
+          mv ${GITHUB_WORKSPACE}.build/porchctl /usr/local/bin/porchctl
+          sudo chmod 755 /usr/local/bin/porchctl
+      - name: Create k8s Kind Cluster
+        uses: helm/kind-action@v1
+        with:
+          cluster_name: kind
+      - name: Build Images and Deploy porch kpt pkg
+        run: IMAGE_REPO=porch-kind IMAGE_TAG=${GITHUB_SHA:0:8} make run-in-kind-kpt
+      - name: porchctl e2e test
+        run: E2E=1 go test -v -timeout 20m ${GITHUB_WORKSPACE}/test/e2e/cli
+      - name: Export porch server logs
+        if: always()
+        run: |
+          name=$(kubectl -n porch-system get pod -l app=porch-server -o custom-columns=NAME:.metadata.name --no-headers=true)
+          kubectl -n porch-system logs $name > porch-cli-e2e-server.log
+      - name: Archive logs
+        if: always()
+        uses: actions/upload-artifact@v4  
+        with:
+          name: porch-cli-e2e-server.log
+          path: porch-cli-e2e-server.log
+          compression-level: 0
diff --git a/Makefile b/Makefile
@@ -309,6 +309,7 @@ deployment-config-kpt:
 	  --controllers-image "$(IMAGE_REPO)/$(PORCH_CONTROLLERS_IMAGE):$(IMAGE_TAG)" \
 	  --function-image "$(IMAGE_REPO)/$(PORCH_FUNCTION_RUNNER_IMAGE):$(IMAGE_TAG)" \
 	  --wrapper-server-image "$(IMAGE_REPO)/$(PORCH_WRAPPER_SERVER_IMAGE):$(IMAGE_TAG)" \
+	  --test-git-server-image "$(IMAGE_REPO)/$(TEST_GIT_SERVER_IMAGE):${IMAGE_TAG}" \
 	  --enabled-reconcilers "$(ENABLED_RECONCILERS)" \
 	  --kind-context "$(KIND_CONTEXT_NAME)"
 

diff --git a/OWNERS b/OWNERS
@@ -3,9 +3,13 @@ approvers:
   - henderiw
   - s3wong
   - tliron
+  - efiacor
+  - liamfallon
 
 reviewers:
   - johnbelamaric
   - henderiw
   - s3wong
   - tliron
+  - efiacor
+  - liamfallon
diff --git a/docs/porchctl-cli-guide.md b/docs/porchctl-cli-guide.md
@@ -1,18 +1,12 @@
 ## Using the porchctl cli
 
-When Porch was ported to Nephio, the `kpt alpha rpkg` commands in kpt were moved into a new command called `porchctl`. 
 
-See the [project releases](https://github.com/nephio-project/porch/releases) for information on the latest release.
+When Porch was ported to Nephio, the `kpt alpha rpkg` commands in kpt were moved into a new command called `porchctl`. 
 
-Once the preferred binary is downloaded and extracted, we can set it up for use locally.
+To use it locally, [download](https://github.com/nephio-project/porch/releases), unpack and add it to your PATH.
 
-_optional: Configure `porchctl` on your environment_
+_Optional: Generate the autocompletion script for the specified shell to add to your profile._
 
-1. Either add `porchctl` to your PATH or copy it to a directory already in the path. 
-```
-cp porchctl /usr/local/bin/
-```
-2. Generate the autocompletion script for the specified shell to add to your profile.
 ```
 porchctl completion bash
 ```

diff --git a/scripts/create-deployment-kpt.sh b/scripts/create-deployment-kpt.sh
@@ -28,6 +28,7 @@ Supported Flags:
   --controllers-image IMAGE           ... address of the Porch controllers image
   --function-image IMAGE              ... address of the Porch function runtime image
   --wrapper-server-image IMAGE        ... address of the Porch function wrapper server image
+  --test-git-server-image             ... address of the test git server image
   --enabled-reconcilers RECONCILERS   ... comma-separated list of reconcilers that should be enabled in porch controller
 EOF
   exit 1
@@ -67,6 +68,11 @@ while [[ $# -gt 0 ]]; do
       shift 2
     ;;
 
+    --test-git-server-image)
+      TEST_GIT_SERVER_IMAGE="${2}"
+      shift 2
+    ;;
+
     --enabled-reconcilers)
       ENABLED_RECONCILERS="${2}"
       shift 2
@@ -116,6 +122,7 @@ function load-custom-images {
 	kind load docker-image ${CONTROLLERS_IMAGE} -n ${KIND_CONTEXT_NAME}
 	kind load docker-image ${FUNCTION_IMAGE} -n ${KIND_CONTEXT_NAME}
 	kind load docker-image ${WRAPPER_SERVER_IMAGE} -n ${KIND_CONTEXT_NAME}
+  kind load docker-image ${TEST_GIT_SERVER_IMAGE} -n ${KIND_CONTEXT_NAME}
 }
 
 function main() {
@@ -137,19 +144,19 @@ function main() {
   done
 
   customize-pkg-images \
-  "porch-server:latest" \
+  "porch-server:v2.0.0" \
   "${SERVER_IMAGE}"
 
   customize-pkg-images \
-  "porch-controllers:latest" \
+  "porch-controllers:v2.0.0" \
   "${CONTROLLERS_IMAGE}"
 
   customize-pkg-images \
-  "porch-function-runner:latest" \
+  "porch-function-runner:v2.0.0" \
   "${FUNCTION_IMAGE}"
 
   customize-pkg-images \
-  "porch-wrapper-server:latest" \
+  "porch-wrapper-server:v2.0.0" \
   "${WRAPPER_SERVER_IMAGE}"
 
   deploy-porch-dev-pkg