Skip to content

Commit

Permalink
Updated the instructions
Browse files Browse the repository at this point in the history
Signed-off-by: cmoulliard <[email protected]>
  • Loading branch information
cmoulliard committed Nov 8, 2024
1 parent 42a4ac0 commit 8bd8473
Showing 1 changed file with 19 additions and 17 deletions.
36 changes: 19 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
- podman (>= 5.2) or docker
- git

- Install idpbuilder (>= 0.8) as [documented](https://cnoe.io/docs/reference-implementation/installations/idpbuilder/quick-start).
- Install idpbuilder (>= 0.8.1) as [documented](https://cnoe.io/docs/reference-implementation/installations/idpbuilder/quick-start).
- git clone the forked project to use the branch created to deploy using idpbuilder
```bash
git clone -b idpbuilder https://github.com/ch007m/fork-konflux-ci.git
Expand Down Expand Up @@ -38,26 +38,31 @@ EOF
- Change within the cfg file the `hostPath: $HOME/.config/containers/auth.json` to point locally to your podman `auth.json` or docker `config.json` which includes
your registry credentials. This is needed to avoid to get the `docker rate limit` issue !

- Create a cluster and deploy the konflux packages
- Create a cluster and deploy the konflux's dependencies (cert manager, keycloak, tekton, etc)
```bash
alias idp=idpbuilder
export DOCKER_HOST="unix://$XDG_RUNTIME_DIR/podman/podman.sock"
export KIND_EXPERIMENTAL_PROVIDER=podman

idp create \
--color \
--build-name my-konflux \
--name my-konflux \
--kind-config my-konflux-cfg.yaml \
-p fork-konflux-ci/idp/dependencies \
-p fork-konflux-ci/idp/konflux \
-p fork-konflux-ci/idp/testing
-p fork-konflux-ci/idp/dependencies
```

**Note**: If you plan to install the project on a remote machine, you can pass as parameter to `idpbuilder` the following parameter `--host <IP_VM>` where `<IP_VM>` should be expressed as `IP.nip.io` or `host.domain` to allow to access the UI outside the VM.

When all the pods are up and running, then access the ui using the url: `https://konflux.cnoe.localtest.me:8443/application-pipeline` or `https://konflux.IP.nip.io:8443` if you passed the parameter `--host`
- When the Argocd Applications are healthy `kubectl get applications -A`, then deploy konflux
```bash
idp create \
--color \
--name my-konflux \
--kind-config my-konflux-cfg.yaml \
-p fork-konflux-ci/idp/konflux \
-p fork-konflux-ci/idp/testing
```

**Warning**: If some resources are not sync (such as Bundles CR needed by the build-service and registry), then open the argocd console `https://argocd.cnoe.localtest.me:8443/` and resync the resources. You can get the passwords using the command `idp get secrets`
- When all the pods are up and running, then access the ui using the url: `https://konflux.cnoe.localtest.me:8443/application-pipeline` or `https://konflux.IP.nip.io:8443` if you passed the parameter `--host`

- If you would like to use: smee, the image-controller and your GitHub application (as documented [here](https://github.com/konflux-ci/konflux-ci/tree/main?tab=readme-ov-file#enable-pipelines-triggering-via-webhooks)) to allow Tekton PaC to talk with your GitHub repositories, then create the following files:
- File containing as k=v pairs the following parameters
Expand All @@ -76,24 +81,21 @@ When all the pods are up and running, then access the ui using the url: `https:/
**Warning**: The `GITHUB_PRIVATE_KEY` is the GitHub application private key file converted as one line string here and where the `\n` has been replaced with `#`. TODO: To be improved !
- A kubernetes secret resource file `secrets.yaml` using the following command:
```bash
kubectl create secret generic argocd-secret-vars -n argocd --from-file=secret_vars.yaml=fork-konflux-ci/idp/secret-plugin/secrets/secret_vars.yaml
kubectl create secret generic argocd-secret-vars -n argocd --from-file=secret_vars.yaml=fork-konflux-ci/idp/secret-plugin/secrets/secret_vars.yaml \
--dry-run=client -o yaml >> fork-konflux-ci/idp/secret-plugin/manifests/secrets.yaml
```
- Deploy then the additional packages able to install/configure: smee, image-controlle, etc
- Deploy then the additional packages able to install/configure: smee, image-controller, etc
```bash
export KIND_EXPERIMENTAL_PROVIDER=podman
idp create \
--color \
--build-name my-konflux \
--name my-konflux \
--kind-config my-konflux-cfg.yaml \
-p fork-konflux-ci/idp/dependencies \
-p fork-konflux-ci/idp/konflux \
-p fork-konflux-ci/idp/testing \
-p fork-konflux-ci/idp/secret-plugin \
-p fork-konflux-ci/idp/github-app-secrets \
-p fork-konflux-ci/idp/smee \
-p fork-konflux-ci/idp/image-controller
```
- When done, go back to the console: `https://konflux.cnoe.localtest.me:8443/application-pipeline` and enjoy :-)

## How to guide

Expand Down

0 comments on commit 8bd8473

Please sign in to comment.