Skip to content

Commit

Permalink
Add quay.io and toolkit options (#49)
Browse files Browse the repository at this point in the history
* More codespaces options

Signed-off-by: Trevor Dolby <[email protected]>

* Add additional quay.io option

Signed-off-by: Trevor Dolby <[email protected]>

* Codespaces link

* More codespace options

Signed-off-by: Trevor Dolby <[email protected]>

---------

Signed-off-by: Trevor Dolby <[email protected]>
  • Loading branch information
trevor-dolby-at-ibm-com authored Nov 2, 2023
1 parent dd68da3 commit 25e8c1d
Show file tree
Hide file tree
Showing 5 changed files with 55 additions and 15 deletions.
10 changes: 10 additions & 0 deletions .devcontainer/ace-toolkit-xvnc/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"name": "ace-demo-pipeline-toolkit-xvnc-devcontainer",
"image": "tdolby/experimental:ace-devcontainer-xvnc-12.0.10.0",
"containerEnv": {
"LICENSE": "accept"
},
"remoteEnv": {
"REMOTE_LICENSE": "accept"
}
}
10 changes: 10 additions & 0 deletions .devcontainer/quay.io-ace-toolkit-xvnc/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"name": "ace-demo-pipeline-quay.io-toolkit-xvnc-devcontainer",
"image": "quay.io/trevor_dolby/ace-devcontainer-xvnc:12.0.10.0",
"containerEnv": {
"LICENSE": "accept"
},
"remoteEnv": {
"REMOTE_LICENSE": "accept"
}
}
10 changes: 10 additions & 0 deletions .devcontainer/quay.io/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"name": "ace-demo-pipeline-devcontainer-quay-io",
"image": "quay.io/trevor_dolby/ace-minimal-devcontainer:12.0.10.0",
"containerEnv": {
"LICENSE": "accept"
},
"remoteEnv": {
"REMOTE_LICENSE": "accept"
}
}
15 changes: 11 additions & 4 deletions README-codespaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,9 @@ The first Maven run will download lots of plugins, and subsequent runs will be f

## Use cases

As the ACE toolkit is not available (the web console is taken up with vscode and there is
no X-Windows display), codespaces are most useful for incremental coding and fixing issues.
Although it is possible to create message flows with a text editor, and this is supported
as long as the format is exactly right, the toolkit is a much more efficient way to do this!
The default container does not have the ACE toolkit available (the web console is taken
up with vscode and there is no X-Windows display) and so these codespaces are most useful
for incremental coding and fixing issues.

For ESQL or Java coding, unit testing, or fixing CI build breaks, codespaces provide an
easy-to-start environment that removes the need to install the product locally while still
Expand All @@ -36,3 +35,11 @@ allowing building and testing with the actual product.
Codespaces for this repo use the [ace-minimal devcontainer](https://github.com/ot4i/ace-docker/tree/main/experimental/devcontainers)
which is built on the standard Ubuntu devcontainer with ACE and Maven installed. The container
is pre-built for faster startup, but could also be run as a docker build during codespace startup.

## Toolkit-enabled container

This repo has a "toolkit-xvnc" option for codespaces which will use an ACE devcontainer that
can run the toolkit in a browser session; see https://github.com/trevor-dolby-at-ibm-com/ace-vnc-devcontainer
for details on how to access the toolkit. This option takes significantly longer to start than
the default devcontainer.

25 changes: 14 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,23 @@ being constructed to show pipeline-friendliness rather than being a "best practi
- IBM Cloud Kubernetes cluster (free tier) for running the application container
- DB2 on Cloud (free tier) for use by the application container; credentials stored in Kubernetes secrets

This repo can also be built using a GitHub action for CI enablement. It is also possible to run the
pipeline using OpenShift with RedHat OpenShift Pipelines instead of using the IBM Cloud Kubernetes
service, and the instructions contain OpenShift-specific sections for the needed changes.
This repo can also be built using a GitHub action for CI enablement. It is also possible to run the
pipeline using OpenShift with RedHat OpenShift Pipelines instead of using the IBM Cloud Kubernetes
service, and the instructions contain OpenShift-specific sections for the needed changes.

There is also a variant of the pipeline that uses the IBM Cloud Pak for Integration and creates
custom resources to deploy the application (amongst other changes). See the
[CP4i README](tekton/os/cp4i/README.md) for details and instructions.
There is also a variant of the pipeline that uses the IBM Cloud Pak for Integration and creates
custom resources to deploy the application (amongst other changes). See the
[CP4i README](tekton/os/cp4i/README.md) for details and instructions.

Jenkins can also be used to run the pipeline and deploy the application to an integration node.
See the [Jenkins README](demo-infrastructure/README-jenkins.md) for details and instructions.

Note that the Tekton pipeline can also create temporary databases for use during pipeline runs; see
[temp-db2](tekton/temp-db2/README.md) for more details.
Jenkins can also be used to run the pipeline and deploy the application to an integration node.
See the [Jenkins README](demo-infrastructure/README-jenkins.md) for details and instructions.

Note that the Tekton pipeline can also create temporary databases for use during pipeline runs; see
[temp-db2](tekton/temp-db2/README.md) for more details.

For online testing and development, see [README-codespaces](README-codespaces.md) for details on
using a github-hosted container.

## The application

The application used to demonstrate the pipeline consists of a REST API that accepts JSON and interacts
Expand Down

0 comments on commit 25e8c1d

Please sign in to comment.