fix: integration with Tekton

The integration with Tekton was broken for the following reasons: - The service account integration was totally broken: so, neither private container registry could be used, nor the k8s manifests could be installed - The kaniko image used to build and push the images was not working (one missing parameter and a wrong parameter related to the context) - The extension was not supporting a multi-module project - The image-pull-secret property was not taking into account: I had to revert 1bcf751 - Added kaniko support for unsecure container registries - Updated documentation and CI
dekorateio · Jun 16, 2023 · c48bfab · c48bfab
1 parent ac4393e
commit c48bfab
Show file tree

Hide file tree

Showing 20 changed files with 428 additions and 103 deletions.
diff --git a/.github/workflows/integration-tests-with-dockerio.yml b/.github/workflows/integration-tests-with-dockerio.yml
@@ -146,3 +146,89 @@ jobs:
         with:
           name: ci-manifests
           path: manifests-ocp-jvm${{ matrix.java }}.zip
+
+  tekton:
+    name: Tekton Build
+    needs: cache
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        kubernetes: [ v1.22.2 ]
+        tekton: [ v0.39.0 ]
+    steps:
+      - name: Checkout
+        uses: actions/[email protected]
+      - name: Get Date
+        id: get-date
+        run: |
+          echo "::set-output name=date::$(/bin/date -u "+%Y-%m")"
+        shell: bash
+      - name: Cache .m2 registry
+        uses: actions/[email protected]
+        with:
+          path: ~/.m2/repository
+          key: ${{ runner.os }}-maven-${{ steps.get-date.outputs.date }}
+          restore-keys: ${{ runner.os }}-maven-
+      - name: Setup Minikube-Kubernetes
+        uses: manusa/[email protected]
+        with:
+          minikube version: v1.23.2
+          kubernetes version: ${{ matrix.kubernetes }}
+          github token: ${{ secrets.GITHUB_TOKEN }}
+          driver: 'docker'
+          start args: '--force'
+      - name: Setup Java 8
+        uses: actions/setup-java@v2
+        with:
+          java-version: '8'
+          distribution: 'adopt'
+      - name: Dockerhub login
+        if: ${{ secrets.DOCKERIO_USERNAME != null && secrets.DOCKERIO_PASSWORD != null }}
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKERIO_USERNAME }}
+          password: ${{ secrets.DOCKERIO_PASSWORD }}
+      - name: Install Tekton
+        run: |
+          kubectl apply -f https://github.com/tektoncd/pipeline/releases/download/${{ matrix.tekton }}/release.yaml
+      - name: Build
+        run: |
+          ./mvnw -B clean install -Dformat.skip=true -DskipTests
+      - name: Run Tekton Integration Tests
+        run: |
+          kubectl create namespace tekton
+          kubectl config set-context --current --namespace=tekton
+          cd examples/spring-boot-with-tekton-example
+          # Build example
+          mvn clean install -DskipTests -Ddekorate.docker.registry=docker.io -Ddekorate.docker.group=dekorateio -Ddekorate.tekton.use-local-docker-config-json=true -Ddekorate.tekton.projectBuilderArguments=clean,install,-Pwith-examples,-DskipTests,-Dformat.skip=true,-pl,examples/spring-boot-with-tekton-example,-am
+          # Install Tekton Task manifests
+          kubectl apply -f target/classes/META-INF/dekorate/tekton-task.yml
+          # Trigger Task workflow
+          kubectl apply -f target/classes/META-INF/dekorate/tekton-task-run.yml
+          # Wait to finish
+          kubectl wait --for=condition=Succeeded --timeout=800s TaskRun/spring-boot-with-tekton-example-run-now
+          # Verify application
+          RESULT=$(kubectl exec $(kubectl get pod -l app.kubernetes.io/name=spring-boot-with-tekton-example -o name) -- wget -qO- http://localhost:9090)
+          if [[ "$RESULT" = *"Hello world"* ]]
+          then
+            exit 0
+          fi
+          echo "Application is not working. Result was: $RESULT"
+          exit 1
+      - name: Print logs at failures
+        if: failure()
+        run: |
+          kubectl config set-context --current --namespace=tekton
+          kubectl describe TaskRun/spring-boot-with-tekton-example-run-now
+          kubectl logs spring-boot-with-tekton-example-run-now-pod --all-containers --max-log-requests 10
+          kubectl logs spring-boot-with-tekton-example-run-now-pod -c step-image-build
+      - name: Zip Artifacts
+        if: failure()
+        run: |
+          zip -R manifests-tekton-jvm${{ matrix.java }}.zip 'classes/META-INF/dekorate/*'
+      - uses: actions/upload-artifact@v1
+        if: failure()
+        with:
+          name: ci-manifests
+          path: manifests-tekton-jvm${{ matrix.java }}.zip
diff --git a/.github/workflows/integration-tests.yml b/.github/workflows/integration-tests.yml
@@ -47,6 +47,7 @@ jobs:
     name: Kubernetes Build
     needs: cache
     runs-on: ubuntu-latest
+    if: ${{ false }}
     strategy:
       fail-fast: false
       matrix:
@@ -101,9 +102,9 @@ jobs:
         with:
           name: ci-manifests
           path: manifests-k8s-jvm${{ matrix.java }}.zip
-
   openshift:
     name: Openshift Build
+    if: ${{ false }}
     needs: cache
     # the action "manusa/[email protected]" only works in ubuntu-20.04
     runs-on: ubuntu-20.04
@@ -151,3 +152,82 @@ jobs:
         with:
           name: ci-manifests
           path: manifests-ocp-jvm${{ matrix.java }}.zip
+  tekton:
+    name: Tekton Build
+    needs: cache
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        tekton: [ v0.39.0 ]
+    steps:
+      - name: Checkout
+        uses: actions/[email protected]
+      - name: Get Date
+        id: get-date
+        run: |
+          echo "::set-output name=date::$(/bin/date -u "+%Y-%m")"
+        shell: bash
+      - name: Cache .m2 registry
+        uses: actions/[email protected]
+        with:
+          path: ~/.m2/repository
+          key: ${{ runner.os }}-maven-${{ steps.get-date.outputs.date }}
+          restore-keys: ${{ runner.os }}-maven-
+      - name: Kubernetes KinD Cluster
+        uses: container-tools/kind-action@v1
+        with:
+          version: v0.18.0
+          registry: true
+      - name: Setup Java 8
+        uses: actions/setup-java@v2
+        with:
+          java-version: '8'
+          distribution: 'adopt'
+      - name: Install Tekton
+        run: |
+          kubectl apply -f https://github.com/tektoncd/pipeline/releases/download/${{ matrix.tekton }}/release.yaml || true
+      - name: Build
+        run: |
+          ./mvnw -B clean install -Dformat.skip=true -DskipTests
+      - name: Run Tekton Integration Tests
+        run: |
+          kubectl create namespace tekton
+          kubectl config set-context --current --namespace=tekton
+          cd examples/spring-boot-with-tekton-example
+          # Build example
+          mvn clean install -DskipTests -Ddekorate.docker.registry=$KIND_REGISTRY -Ddekorate.tekton.imageRegistryInsecure=true -Ddekorate.tekton.projectBuilderArguments=clean,install,-Pwith-examples,-DskipTests,-Dformat.skip=true,-pl,examples/spring-boot-with-tekton-example,-am
+          # Install Tekton Task manifests
+          kubectl apply -f target/classes/META-INF/dekorate/tekton-task.yml
+          # Trigger Task workflow
+          kubectl apply -f target/classes/META-INF/dekorate/tekton-task-run.yml
+          # Wait to finish
+          kubectl wait --for=condition=Succeeded --timeout=800s TaskRun/spring-boot-with-tekton-example-run-now
+          kubectl wait deployment spring-boot-with-tekton-example --for condition=Available=True --timeout=180s
+          # Verify application
+          RESULT=$(kubectl exec $(kubectl get pod -l app.kubernetes.io/name=spring-boot-with-tekton-example -o name) -- wget -qO- http://localhost:9090)
+          if [[ "$RESULT" = *"Hello world"* ]]
+          then
+            exit 0
+          fi
+          echo "Application is not working. Result was: $RESULT"
+          exit 1
+      - name: Print logs at failures
+        if: failure()
+        run: |
+          kubectl config set-context --current --namespace=tekton
+          echo "kubectl get pods: "
+          kubectl get pods
+          echo "kubectl describe TaskRun/spring-boot-with-tekton-example-run-now: "
+          kubectl describe TaskRun/spring-boot-with-tekton-example-run-now
+          echo "kubectl logs spring-boot-with-tekton-example-run-now-pod --all-containers --max-log-requests 10: "
+          kubectl logs spring-boot-with-tekton-example-run-now-pod --all-containers --max-log-requests 10
+      - name: Zip Artifacts
+        if: failure()
+        run: |
+          zip -R manifests-tekton-jvm${{ matrix.java }}.zip 'classes/META-INF/dekorate/*'
+      - uses: actions/upload-artifact@v1
+        if: failure()
+        with:
+          name: ci-manifests
+          path: manifests-tekton-jvm${{ matrix.java }}.zip
diff --git a/...ons/tekton-annotations/src/main/java/io/dekorate/tekton/annotation/TektonApplication.java b/...ons/tekton-annotations/src/main/java/io/dekorate/tekton/annotation/TektonApplication.java
@@ -207,6 +207,13 @@
    */
   String[] imagePushArguments() default {};
 
+  /*
+   * If to use an unsecure registry or not.
+   *
+   * @return The container image will be configured to work with an insecure registry.
+   */
+  boolean imageRegistryInsecure() default false;
+
   /**
    * The relative path to the Dockerfile.
    * 

diff --git a/...tekton-annotations/src/main/java/io/dekorate/tekton/decorator/AddDeployStepDecorator.java b/...tekton-annotations/src/main/java/io/dekorate/tekton/decorator/AddDeployStepDecorator.java
@@ -17,6 +17,8 @@
 
 package io.dekorate.tekton.decorator;
 
+import java.nio.file.Path;
+
 import io.dekorate.kubernetes.decorator.Decorator;
 import io.fabric8.tekton.pipeline.v1beta1.Step;
 import io.fabric8.tekton.pipeline.v1beta1.StepBuilder;
@@ -29,18 +31,18 @@ public class AddDeployStepDecorator extends NamedTaskDecorator implements StepDe
   private static final String PATH_TO_YML_PARAM_NAME = "pathToYml";
 
   private final String stepName;
-  private final String projectName;
+  private final Path relativePath;
   private final String deployerImage;
 
-  public AddDeployStepDecorator(String taskName, String stepName, String projectName, String deployerImage) {
+  public AddDeployStepDecorator(String taskName, String stepName, Path relativePath, String deployerImage) {
     super(taskName);
     this.stepName = stepName;
-    this.projectName = projectName;
+    this.relativePath = relativePath;
     this.deployerImage = deployerImage;
   }
 
-  public AddDeployStepDecorator(String taskName, String projectName, String deployerImage) {
-    this(taskName, STEP_NAME, projectName, deployerImage);
+  public AddDeployStepDecorator(String taskName, Path relativePath, String deployerImage) {
+    this(taskName, STEP_NAME, relativePath, deployerImage);
   }
 
   @Override
@@ -50,7 +52,8 @@ public void andThenVisit(TaskSpecFluent taskSpec) {
 
   public Step createDeployStep() {
     return new StepBuilder().withName(stepName).withImage(deployerImage).withCommand(DEPLOY_CMD)
-        .withArgs(new String[] { "apply", "-f", param(PATH_TO_YML_PARAM_NAME) }).withWorkingDir(sourcePath(projectName))
+        .withArgs(new String[] { "apply", "-f", param(PATH_TO_YML_PARAM_NAME) })
+        .withWorkingDir(sourcePath(relativePath.toString()))
         .build();
   }
 

diff --git a/...rator/AddDockerSocketVolumeDecorator.java → ...r/AddDockerSocketVolumeTaskDecorator.java b/...rator/AddDockerSocketVolumeDecorator.java → ...r/AddDockerSocketVolumeTaskDecorator.java
@@ -19,13 +19,13 @@
 
 import io.dekorate.tekton.step.ImageStep;
 
-public class AddDockerSocketVolumeDecorator extends AddHostPathVolumeDecorator {
+public class AddDockerSocketVolumeTaskDecorator extends AddHostPathVolumeTaskDecorator {
 
-  public AddDockerSocketVolumeDecorator(String taskName) {
+  public AddDockerSocketVolumeTaskDecorator(String taskName) {
     super(taskName, ImageStep.DOCKER_SOCKET_NAME, ImageStep.DOCKER_SOCKET_PATH, ImageStep.DOCKER_SOCKET_TYPE);
   }
 
-  public AddDockerSocketVolumeDecorator(String taskName, String name, String path, String type) {
+  public AddDockerSocketVolumeTaskDecorator(String taskName, String name, String path, String type) {
     super(taskName, name, path, type);
   }
 }
diff --git a/...decorator/AddHostPathVolumeDecorator.java → ...rator/AddHostPathVolumeTaskDecorator.java b/...decorator/AddHostPathVolumeDecorator.java → ...rator/AddHostPathVolumeTaskDecorator.java
@@ -23,13 +23,13 @@
 import io.fabric8.tekton.pipeline.v1beta1.TaskSpecFluent;
 
 @Description("Add a persistent host path volume to the specified task.")
-public class AddHostPathVolumeDecorator extends NamedTaskDecorator {
+public class AddHostPathVolumeTaskDecorator extends NamedTaskDecorator {
 
   private final String name;
   private final String path;
   private final String type;
 
-  public AddHostPathVolumeDecorator(String taskName, String name, String path, String type) {
+  public AddHostPathVolumeTaskDecorator(String taskName, String name, String path, String type) {
     super(taskName);
     this.name = name;
     this.path = path;

diff --git a/...on-annotations/src/main/java/io/dekorate/tekton/decorator/AddImageBuildStepDecorator.java b/...on-annotations/src/main/java/io/dekorate/tekton/decorator/AddImageBuildStepDecorator.java
@@ -17,6 +17,8 @@
 
 package io.dekorate.tekton.decorator;
 
+import java.nio.file.Path;
+
 import io.dekorate.kubernetes.decorator.Decorator;
 import io.dekorate.tekton.step.ImageBuildStep;
 import io.dekorate.utils.Strings;
@@ -33,24 +35,24 @@ public class AddImageBuildStepDecorator extends NamedTaskDecorator implements St
   private static final String DOCKER_CONFIG_DEFAULT = "/tekton/home/.docker";
 
   private final String stepName;
-  private final String projectName;
+  private final Path relativePath;
   private final String image;
   private final String command;
   private final String[] args;
 
-  public AddImageBuildStepDecorator(String taskName, String projectName) {
-    this(taskName, ImageBuildStep.ID, projectName);
+  public AddImageBuildStepDecorator(String taskName, Path relativePath) {
+    this(taskName, ImageBuildStep.ID, relativePath);
   }
 
-  public AddImageBuildStepDecorator(String taskName, String stepName, String projectName) {
-    this(taskName, stepName, projectName, BUILDER_IMAGE_REF, BUILDER_COMMAND_REF, BUILDER_ARGS_REF);
+  public AddImageBuildStepDecorator(String taskName, String stepName, Path relativePath) {
+    this(taskName, stepName, relativePath, BUILDER_IMAGE_REF, BUILDER_COMMAND_REF, BUILDER_ARGS_REF);
   }
 
-  public AddImageBuildStepDecorator(String taskName, String stepName, String projectName, String image, String command,
+  public AddImageBuildStepDecorator(String taskName, String stepName, Path relativePath, String image, String command,
       String... args) {
     super(taskName);
     this.stepName = stepName;
-    this.projectName = projectName;
+    this.relativePath = relativePath;
     this.image = Strings.isNotNullOrEmpty(image) ? image : BUILDER_IMAGE_REF;
     this.command = Strings.isNotNullOrEmpty(command) ? command : BUILDER_COMMAND_REF;
     this.args = args != null && args.length != 0 ? args : new String[] { BUILDER_ARGS_REF };
@@ -64,7 +66,7 @@ public void andThenVisit(TaskSpecFluent<?> taskSpec) {
         .addToEnv(new EnvVarBuilder().withName(DOCKER_CONFIG).withValue(DOCKER_CONFIG_DEFAULT).build())
         .withCommand(command)
         .withArgs(args)
-        .withWorkingDir(sourcePath(projectName))
+        .withWorkingDir(sourcePath())
         .endStep();
   }
 

diff --git a/...otations/src/main/java/io/dekorate/tekton/decorator/AddKanikoImageBuildStepDecorator.java b/...otations/src/main/java/io/dekorate/tekton/decorator/AddKanikoImageBuildStepDecorator.java
@@ -17,6 +17,8 @@
 
 package io.dekorate.tekton.decorator;
 
+import static io.dekorate.tekton.step.KanikoBuildStep.FORCE_ARG;
+
 import io.dekorate.kubernetes.decorator.Decorator;
 import io.dekorate.utils.Strings;
 import io.fabric8.kubernetes.api.model.EnvVarBuilder;
@@ -61,7 +63,7 @@ public AddKanikoImageBuildStepDecorator(String taskName, String stepName, String
     this.image = Strings.isNotNullOrEmpty(image) ? image : BUILDER_IMAGE_REF;
     this.command = Strings.isNotNullOrEmpty(command) ? command : KANIKO_CMD;
     this.args = args != null && args.length != 0 ? args
-        : new String[] { DOCKERFILE_ARG, CONTEXT_ARG, IMAGE_DESTINATION_ARG, VERBOSITY_DEBUG };
+        : new String[] { FORCE_ARG, DOCKERFILE_ARG, CONTEXT_ARG, IMAGE_DESTINATION_ARG, VERBOSITY_DEBUG };
   }
 
   @Override

diff --git a/...-annotations/src/main/java/io/dekorate/tekton/decorator/AddProjectBuildStepDecorator.java b/...-annotations/src/main/java/io/dekorate/tekton/decorator/AddProjectBuildStepDecorator.java
@@ -60,7 +60,7 @@ public void andThenVisit(TaskSpecFluent<?> taskSpec) {
         .withImage(image)
         .withCommand(command)
         .withArgs(arguments)
-        .withWorkingDir(sourcePath(projectName))
+        .withWorkingDir(sourcePath())
         .endStep();
   }