19 | oc sync --dev
20 | oc pipeline
21 | ```
22 |
23 | - If you are bringing your own code run the `oc enable` command to add a Helm chart and make sure you code exposes a `/health` endpoint and the `values.yaml` is exposing the correct port for your application.
24 |
25 | ### Git Repo Links
26 |
27 | | Title | Subtitle | Link
28 | |-------|----------|---------
29 | | React UI Patterns | Carbon based UI to help with common patterns using React framework | [https://github.com/IBM/template-node-react](https://github.com/IBM/template-node-react){: target=_blank}
30 | | Angular UI Patterns | Carbon based UI to help with common patterns using Angular framework | [https://github.com/IBM/template-node-angular](https://github.com/IBM/template-node-angular){: target=_blank}
31 | | Typescript Microservice | Node.js TypeScript Microservice offering OpenAPI endpoints | [https://github.com/IBM/template-node-typescript](https://github.com/IBM/template-node-typescript){: target=_blank}
32 | | Typescript GraphQL | Node.js TypeScript GraphQL Backend for Frontend| [https://github.com/IBM/template-graphql-typescript](https://github.com/IBM/template-graphql-typescript){: target=_blank}
33 | | Spring Boot Microservice | Spring Boot Java Microservice | [https://github.com/IBM/template-java-spring](https://github.com/IBM/template-java-spring){: target=_blank}
34 | | Go Gin Microservice | Go Gin Microservice/Bff/Edge | [https://github.com/IBM/template-go-gin](https://github.com/IBM/template-go-gin){: target=_blank}
35 | | Quarkus Microservice | Quarkus Java Microservice | [https://github.com/IBM/template-quarkus](https://github.com/IBM/template-quarkus){: target=_blank}
36 | | Liberty Microservice | Open Liberty Java Microservice | [https://github.com/IBM/template-liberty](https://github.com/IBM/template-liberty){: target=_blank}
37 | | Artificial Intelligence (AI) Microservice | Deep Learning Model: Locate and identify multiple objects in a single image | [https://github.com/IBM/MAX-Object-Detector](https://github.com/IBM/MAX-Object-Detector){: target=_blank}
38 | | ArgoCD GitOps | Template configuration to help to set up GitOps with ArgoCD | [https://github.com/IBM/template-argocd-gitops](https://github.com/IBM/template-argocd-gitops){: target=_blank}
39 |
--------------------------------------------------------------------------------
/docs/reference/tasks/pipelines.md:
--------------------------------------------------------------------------------
1 | # Pipelines
2 |
3 | The toolkit provides a number of pipelines for a number of programming languages. Each pipeline is composed of several tasks.
4 |
5 | A set of Tekton Pipelines and Pipeline tasks are imported to your cluster when the Cloud-Native Toolkit is installed. The source for these pipelines and tasks can be found in [GitHub](https://github.com/IBM/ibm-garage-tekton-tasks){: target=_blank}
6 |
7 | !!!Todo
8 | Add a breakdown of the pipelines and tasks provided by the Toolkit. Each pipeline and task should have a separate reference page
9 |
--------------------------------------------------------------------------------
/docs/reference/tasks/placeholder.md:
--------------------------------------------------------------------------------
1 | # Task Placeholder page
2 |
3 | !!!Todo
4 | Complete this content for each Pipeline and Task provided in the Toolkit
5 |
6 | ## Template content
7 |
8 | For each task the content should be:
9 |
10 | ## Description
11 |
12 | What is the purpose of the task
13 |
14 | ## Requirements
15 |
16 | For the task to complete successfully what are the assumptions, prereqs, .....
17 |
18 | ## Source
19 |
20 | Link to [github repo source](https://github.com/IBM/ibm-garage-tekton-tasks/tree/main/tasks){: target="_blank" .external }
21 |
--------------------------------------------------------------------------------
/docs/reference/tools/images/CI_CD-pipelines.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/CI_CD-pipelines.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/PactFramework-consumer.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/PactFramework-consumer.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/PactFramework-pactbroker.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/PactFramework-pactbroker.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/PactFramework-provider.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/PactFramework-provider.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/argocd-config.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/argocd-config.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/argocd-key-protect-secret.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/argocd-key-protect-secret.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/argocd-plugin.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/argocd-plugin.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/artifact-repo-browser.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/artifact-repo-browser.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/console-image-details.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/console-image-details.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/console-image-issues-config.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/console-image-issues-config.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/console-image-issues-overview.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/console-image-issues-overview.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/console-image-list.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/console-image-list.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/docker-registry.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/docker-registry.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/helm-chart-structure.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/helm-chart-structure.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/helm-repo-index.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/helm-repo-index.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/kabanero.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/kabanero.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/openshiftconsole.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/openshiftconsole.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/ospipelines.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/ospipelines.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/pipeline-gate-stage-failed.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/pipeline-gate-stage-failed.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/pipeline-os.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/pipeline-os.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/pipeline.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/pipeline.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/pipelines.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/pipelines.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/registry-console.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/registry-console.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/sonar-bugs-code.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/sonar-bugs-code.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/sonar-bugs.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/sonar-bugs.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/sonar-hotspot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/sonar-hotspot.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/sonar-project-failed.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/sonar-project-failed.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/sonar-project-passed.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/sonar-project-passed.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/sonar-project.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/sonar-project.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/steps.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/steps.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/tasks.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/tasks.png
--------------------------------------------------------------------------------
/docs/reference/tools/images/tekton.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/reference/tools/images/tekton.png
--------------------------------------------------------------------------------
/docs/reference/tools/jenkins.md:
--------------------------------------------------------------------------------
1 | # Tekton (OpenShift pipelines)
2 |
3 | !!!Information
4 | Openshift Pipelines (Tekton) is the preferred pipeline technology used by the Toolkit.
5 |
6 | Use Jenkins to automate your continuous integration process
7 |
8 | [Jenkins](https://jenkins.io/){: target=_blank} is a self-contained, open source automation server that can be used to automate all sorts of tasks related to building, testing, and delivering or deploying software. It is a perfect tool for helping manage continuous integration tasks for a wide range of software components.
9 |
10 | Jenkins Pipeline (or simply "Pipeline") is a suite of plugins that supports implementing and integrating continuous delivery pipelines into Jenkins.
11 |
12 | A continuous delivery pipeline is an automated expression of your process for getting software from version control right through to your users and customers.
13 |
14 | Jenkins Pipeline provides an extensible set of tools for modeling simple-to-complex delivery pipelines "as code." The definition of a Jenkins Pipeline is typically written into a text file (called a [Jenkinsfile](https://jenkins.io/doc/pipeline/tour/hello-world/)){: target=_blank}) that in turn is checked into a project’s source control repository.
15 |
16 | ## Pipelines
17 |
18 | Pipelines offer a set of stages or steps that can be chained together to allow a level of software automation. This automation can be tailored to the specific project requirements.
19 |
20 | You can read more information about Jenkins Pipelines [here](https://jenkins.io/doc/book/pipeline/)){: target=_blank}
21 |
22 | ## Stages
23 |
24 | Pipelines are defined in a `Jenkinsfile` that sits in the root of your application code. It defines a number of stages. Each of the [templates](../starter-kit/starter-kit.md)){: target=_blank} includes a `Jenkinsfile` that offers a number of stages. The stages have been configured to complete the build, test, package, and deploy of the application code. Each stage can use the defined defined `secrets` and `config maps` that were previously configured during the installation of Development cluster setup.
25 |
26 | ## Developer Tools Pipeline
27 |
28 | To enable application compatibility between Kubernetes and OpenShift, the `Jenkinsfile` is consistent between pipeline registration with
29 | both platforms. Also, the Docker images are built from [UBI images](https://www.redhat.com/en/blog/introducing-red-hat-universal-base-image)){: target=_blank} so that their containers can run on both platforms.
30 |
31 | These are the stages in the pipeline and a description of what each stage does. The **bold stage names** indicate
32 | the stages that are required; the ***italics stage names*** indicate optional stages that can be deleted or will be ignored if the tool
33 | supporting the stage is not installed. These stages represent a typical production pipeline flow for a cloud-native application.
34 |
35 | - **Setup**: Clones the code into the pipeline
36 | - **Build**: Runs the build commands for the code
37 | - **Test**: Validates the unit tests for the code
38 | - ***Publish pacts***: Publishes any pact contracts that have been defined
39 | - ***Sonar scan***: Runs a sonar code scan of the source code and publishes the results to SonarQube
40 | - **Verify environment**: Validates the OpenShift or IKS environment configuration is valid
41 | - **Build image**: Builds the code into a Docker images and stores it in the IBM Cloud Image registry
42 | - **Deploy to DEV env**: Deploys the Docker image tagged version to `dev` namespace using Helm Chart
43 | - **Health Check**: Validates the Health Endpoint of the deployed application
44 | - ***Package Helm Chart***: Stores the tagged version of the Helm chart in Artifactory
45 | - ***Trigger CD Pipeline***: This is a GitOps stage that will update the build number in designated git repo and trigger ArgoCD for deployment to **test**
46 |
47 | ## Registering Pipelines
48 |
49 | The [templates](../starter-kit/starter-kit.md)){: target=_blank} are a good place to start to see how `Jenkinsfile` and `Dockerfile` should be configured for use in a Jenkins CI pipeline. To register your git repo, use the [IGC CLI](../../reference/cli.md)){: target=_blank}. This command automates a number of manual steps you would have to do with Jenkins, including: managing secrets, webhooks, and pipeline registration in the Jenkins tools.
50 |
51 | ```shell
52 | igc pipeline
53 | ```
54 |
55 | By default, the pipeline will register into the `dev` namespace and will copy all the `configMaps` and `secrets` from the `tools` namespace to the `dev` namespace. This means the pipeline can execute, knowing it has access to the key information that enables it to integrate with both the cloud platform and the various development tools. See [Cluster Configuration](../../adopting/admin/cluster-config.md)){: target=_blank} for more detailed information.
56 |
57 | ### Registering Pipeline in new namespace
58 |
59 | You can use any namespace you want to register a pipeline. If you add `-n` or `namespace` to your `igc pipeline` command, it will create a new namespace if it doesn't already exist. It will copy the necessary `secrets` and `configMaps` into that namespace and configure the build agents pods to run in that namespace.
60 |
61 | ```shell
62 | igc pipeline -n team-one
63 | ```
64 |
65 | This is good if you have various squads, teams, pairs or students working in the same Development Tools environment.
66 |
67 | ## Continuous deployment
68 |
69 | In addition to continuous integration, the environment also supports continuous delivery using Artifactory and ArgoCD:
70 |
71 | - [Artifact Management with Artifactory](artifactory.md){: target=_blank}
72 | - [Continuous Delivery with ArgoCD](argocd.md){: target=_blank}
73 |
--------------------------------------------------------------------------------
/docs/reference/tools/key-protect.md:
--------------------------------------------------------------------------------
1 | # Secret management with Key Protect
2 |
3 | [Key Protect](https://www.ibm.com/cloud/key-protect){: target=_blank} is a tool that provides centralized management of encryption keys and sensitive information. Key Protect manages two different types of keys: `root keys` and `standard keys`.
4 |
5 | `Root keys` are used to encrypt information in other systems, like the etcd database of the cluster, or data in Object Storage, or a MongoDB database. The details of which are the subject for a different article.
6 |
7 | `Standard keys` are used to store any kind of protected information. The Key Protect plugin reads the contents of a standard key, identified by a given key id, and stores the key value into a secret in the cluster.
8 |
9 | ## Getting the Key Protect instance id
10 |
11 | 1. Set the target resource group and region for the Key Protect instance.
12 |
13 | ```shell
14 | ibmcloud target -g {RESOURCE_GROUP} -r {REGION}
15 | ```
16 |
17 | 2. List the available resources and find the name of the Key Protect instance.
18 |
19 | ```shell
20 | ibmcloud resource service-instances
21 | ```
22 |
23 | 3. List the details for the Key Protect instance. The `Key Protect instance id` is listed as `GUID`.
24 |
25 | ```shell
26 | ibmcloud resource service-instance {INSTANCE_NAME}
27 | ```
28 |
29 | ## Creating a standard key
30 |
31 | 1. Open the IBM Cloud console and navigate to the Key Protect service
32 |
33 | 2. Within Key Protect, select the **Manage Keys** tab
34 |
35 | 3. Press the `Add key` button to open the "Add a new key" dialog
36 |
37 | 4. Select the `Import your own key` radio button and `Standard key` from the drop down
38 |
39 | 5. Provide a descriptive name for the key and paste the base-64 encoded value of the key into the `Key material` field
40 |
41 | **Note:** A value can be encoded as base-64 from the terminal with the following command:
42 |
43 | ```shell
44 | echo -n "{VALUE}" | base64
45 | ```
46 |
47 | If you need to encode a larger value, create the value in a file and encode the entire contents of the file with:
48 |
49 | ```shell
50 | cat {file} | base64
51 | ```
52 |
53 | 6. Click **Import key** to create the key
54 |
55 | 7. Copy the value of the **ID**
56 |
--------------------------------------------------------------------------------
/docs/reference/tools/tools.md:
--------------------------------------------------------------------------------
1 | # Tools used by the Toolkit
2 |
3 |
4 |
5 | This section provides details of the set of 3rd party tools used in a default install of the Toolkit.
6 |
7 | | Tool | Description
8 | |------|--------------
9 | | [ArgoCD](argocd.md) | Continuous Deliver tool
10 | | [Artifactory](artifactory.md) | Artifact repository
11 | | [IBM Container Registry](ibm-cloud-container-registry.md) | (*IBM Cloud only*) Container registry
12 | | [IBM Key Protect](key-protect.md) | (*IBM Cloud only*) Secrets manager
13 | | [Jenkins](jenkins.md) | Pipeline tool, now replaced by Tekton as the default pipeline tool
14 | | [OpenShift Pipelines (Tekton)](tekton.md) | Cloud-Native pipeline tool
15 | | [PACT](pact.md) | Contract testing tool
16 | | [SonarQube](sonar-qube.md) | Static analysis tool covering many programming languages
17 |
--------------------------------------------------------------------------------
/docs/resources/ibm-cloud/cloud-shell.md:
--------------------------------------------------------------------------------
1 | # Introduction to IBM Cloud Shell
2 |
3 |
4 |
5 | IBM Cloud Shell is a free service that gives you complete control of your cloud resources, applications, and
6 | infrastructure, from any web browser. It's instantly accessible from your IBM Cloud account - no other installation
7 | is needed.
8 |
9 | Features of IBM Cloud Shell include:
10 |
11 | - Pre-configured environment: IBM Cloud Shell provides a curated, cloud-based workspace with dozens of preinstalled tools
12 | and programming languages. It's automatically authenticated with your IBM Cloud account so you can start to develop
13 | immediately.
14 |
15 | - File upload/download: use this feature to import files to IBM Cloud Shell or pull-down data to your local machine.
16 |
17 | - Multiple sessions: use up to five shell sessions at a time to maximize your productivity. Mirror workflows on your
18 | local machine, or view logs on one session while editing a file in another.
19 |
20 | ## Accessing the Cloud Shell
21 |
22 | - Open the IBM Cloud console (cloud.ibm.com) in your browser and log in if needed.
23 |
24 | - Invoke Cloud Shell by clicking on the button at the top, right-hand corner of the browser window.
25 |
26 | 
27 |
28 | ## Set up the shell environment
29 |
30 | We have provided a simplified installer that will install tools and configure the shell environment. The installer will first check if the required tool is available in the path. If not, the missing tool(s) will be installed into the `bin/` folder of the current user's home directory and the `PATH` variable will be updated in the `.bashrc` or `.zshrc` file to include that directory.
31 |
32 | The following tools are included in the shell installer:
33 |
34 | - IBM Cloud cli (ibmcloud)
35 | - ArgoCD cli (argocd)
36 | - Tekton cli (tkn)
37 | - IBM Cloud fast switching (icc)
38 | - kube-ps1 prompt
39 | - OpenShift cli (oc)
40 | - Kubernetes cli (kubectl)
41 | - JSON cli (jq)
42 | - IBM Garage Cloud CLI (igc)
43 |
44 | 1. Set up the shell environment by running:
45 |
46 | ```shell
47 | curl -sL shell.cloudnativetoolkit.dev | bash -
48 | source ~/.bashrc || source ~/.zshrc
49 |
50 | ```
51 |
52 | 2. If successful, you should see something like the following:
53 |
54 | ```text
55 | Downloading scripts: https://github.com/cloud-native-toolkit/cloud-shell-commands/releases/download/0.3.5/assets.tar.gz
56 | ** Installing argocd cli
57 | ** Installing tkn cli
58 | ** Installing kube-ps1
59 | ** Installing icc
60 | ** Installing Cloud-Native Toolkit cli
61 |
62 | kube-ps1 has been installed to display the current Kubernetes context and namespace in the prompt. It can be turned on and off with the following commands:
63 |
64 | kubeon - turns kube-ps1 on for the current session
65 | kubeon -g - turns kube-ps1 on globally
66 | kubeoff - turns kube-ps1 off for the current session
67 | kubeoff -g - turns kube-ps1 off globally
68 |
69 | Your shell configuration has been updated. Run the following to apply the changes to the current terminal:
70 |
71 | source ~/.zshrc
72 | ```
73 |
74 | 3. Follow the instruction given at the end of the output to enable the changes in the current terminal session.
75 |
76 | 4. You can check the shell was installed correctly by checking the `oc sync` version:
77 |
78 | ```shell
79 | oc sync --version
80 | ```
81 |
--------------------------------------------------------------------------------
/docs/resources/ibm-cloud/crw.md:
--------------------------------------------------------------------------------
1 | # Install CodeReady Workspaces on IBM Cloud cluster
2 |
3 | Add the cloud hosted development integrated development environment, CodeReady Workspaces (CRW) to your environment
4 |
5 | ## Installing CodeReady Workspaces
6 |
7 | CodeReady Workspaces can be easily added to your development experience using the Red Hat Operator Hub. See [Chapter 3. Installing CodeReady Workspaces from Operator Hub](https://access.redhat.com/documentation/en-us/red_hat_codeready_workspaces/1.1/html/administration_guide/installing-codeready-workspaces-from-operator-hub){: target=_blank}.
8 |
9 | CodeReady Workspaces is a developer workspace server and cloud IDE. Workspaces are defined as project code files and all of their dependencies necessary to edit, build, run, and debug them. Each workspace has its own private IDE hosted within it. The IDE is accessible through a browser. The browser downloads the IDE as a single-page web application. CodeReady Workspaces will enable a 100% developer experience to be delivered from a user's browser. This is perfect for running enablement learning from constrained developer laptops, or for site reliability engineers (SREs) to make quick change to a microservice.
10 |
11 | ### CodeReady Workspaces Installation Pre-requisite
12 |
13 | Do this first:
14 |
15 | - Provision the OpenShift Cluster
16 | - Ensure the logged in user has the Administrator privileges
17 | - Ensure you have created a new Project to manage the "codeready workspace operator & cluster"
18 |
19 | Setting up the CRW Operator & Cluster:
20 |
21 | - Navigate to Operator Hub and search of the Red Hat CodeReady workspace. Click on the operator and select the appropriate workspace to install the CRW operator.
22 | - Navigate to the installed operator to view the CRW operator.
23 | - Now click the link visible as part of the operator to create/view the CheCluster part of the workspace
24 | - Create the CheCluster button, to navigate to the YAML Configuration page (displays all the parameters).
25 | - You need to change the following parameter mentioned below, As part of the storage section, please add the following parameters, depending on your cluster type:
26 |
27 | === "VPC"
28 |
29 | ```yaml
30 | postgresPVCStorageClassName: ibmc-vpc-block-10iops-tier
31 | workspacePVCStorageClassName: ibmc-vpc-block-10iops-tier
32 | ```
33 |
34 | === "Classic"
35 |
36 | ```yaml
37 | postgresPVCStorageClassName: ibmc-block-gold
38 | workspacePVCStorageClassName: ibmc-block-gold
39 | ```
40 |
41 | - Post definition the yaml section for storage will look as below
42 |
43 | === "VPC"
44 |
45 | ```yaml
46 | storage:
47 | postgresPVCStorageClassName: ibmc-vpc-block-10iops-tier
48 | pvcStrategy: per-workspace
49 | pvcClaimSize: 1Gi
50 | preCreateSubPaths: true
51 | workspacePVCStorageClassName: ibmc-vpc-block-10iops-tier
52 | ```
53 |
54 | === "Classic"
55 |
56 | ```yaml
57 | storage:
58 | postgresPVCStorageClassName: ibmc-block-gold
59 | pvcStrategy: per-workspace
60 | pvcClaimSize: 1Gi
61 | preCreateSubPaths: true
62 | workspacePVCStorageClassName: ibmc-block-gold
63 | ```
64 |
65 | - Now create, the cluster after doing the above changes. The cluster will take few minutes to get created as its resources such as Postgres DB, Keycloak Auth, CRW workspace will get created.
66 |
67 | - Once Cluster is created navigate to the overview tab of the CheCluster in the CRW operator. You will be able to see the below :
68 | - URL of the CodeReady Workspaces URL
69 | - URL of the Red Hat SSO Admin Console URL
70 | - oAuth SSO Enabled.
71 | - This should be enabled by default, if not please slide the button to enable and confirm
72 | - TLS Would be disabled. Please slide the button to enable https connectivity to the CRW workspace and confirm
73 | - You have now completed the provisioning of the Code Ready Workspaces operator into your development cluster and will enable it to be used by the developers that plan to use this development cluster
74 |
--------------------------------------------------------------------------------
/docs/resources/ibm-cloud/ibm-cloud-roles.md:
--------------------------------------------------------------------------------
1 | # IBM Cloud account management
2 |
3 | The IBM Cloud environment is provided with a number of powerful tools to manage user access and resource provisioning
4 | but little is configured for you out of the box. This guide gives an approach to managing the account in a sensible way that can easily be extended or re-configured based upon the requirements of a given situation.
5 |
6 | This approach to managing the account is organized around four key roles:
7 |
8 | - **Account owner(s)**
9 | - **Account managers**
10 | - **Environment administrators**
11 | - **Environment users**
12 |
13 | This diagram shows the relationship of these access groups to a pair of development environments:
14 |
15 | {: style="width: 90%" .center}
16 |
17 | ## Account owner(s)
18 |
19 | The `account owner(s)` is the user who owns the account or users who have been granted super-user access to the account
20 | at the same level as the account owner.
21 |
22 | An account owner must create the access group for account managers. The account owner will:
23 |
24 | - Create an `ACCT-MGR-IAM-ADMIN` access group using the `acp-mgr` script
25 | - Add a functional ID, configured using the `acp-iaas` script, with API keys for the account managers
26 |
27 | ## Account managers
28 |
29 | The `account managers` are an account owner or other users with account management permissions
30 |
31 | As described in [Configure Account](../../adopting/best-practices/ibm-cloud-account/configure-account.md), the account managers can set up the resource groups and access groups needed to install and use the environments. For each environment, the account managers will:
32 |
33 | - Create a resource group
34 | - Create an access group named `-ADMIN` using the script `acp-admin`
35 | - Create an access group named `-USER` using the script `acp-user`
36 |
37 | ## Environment administrators
38 |
39 | The `environment administrators` are users in the account with permissions to create services in the environment's resource group. In this case, the "environment" is scoped to the `resource group`. Environment administrators are granted broad access to create, manage, and destroy services and resources within a given `resource group`.
40 |
41 | ## Environment users
42 |
43 | The `environment users` are users in the account with permissions to use existing services in the environment's resource group (e.g. developers, data scientists, etc.). They are consumers of the services and resources that have been provisioned in order to build and deploy business applications.
44 |
45 | More information can be found on the [IBM Cloud documentation](https://cloud.ibm.com/docs/account?topic=account-iamoverview){: target=_blank }
46 |
--------------------------------------------------------------------------------
/docs/resources/ibm-cloud/images/access-example.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/ibm-cloud/images/access-example.png
--------------------------------------------------------------------------------
/docs/resources/ibm-cloud/images/cloud-accts-resources.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/ibm-cloud/images/cloud-accts-resources.png
--------------------------------------------------------------------------------
/docs/resources/ibm-cloud/images/cloud-groups-resources.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/ibm-cloud/images/cloud-groups-resources.png
--------------------------------------------------------------------------------
/docs/resources/ibm-cloud/images/cloud-resources.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/ibm-cloud/images/cloud-resources.png
--------------------------------------------------------------------------------
/docs/resources/ibm-cloud/images/group-acct-mgr.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/ibm-cloud/images/group-acct-mgr.png
--------------------------------------------------------------------------------
/docs/resources/ibm-cloud/images/group-env-admin.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/ibm-cloud/images/group-env-admin.png
--------------------------------------------------------------------------------
/docs/resources/ibm-cloud/images/group-env-user.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/ibm-cloud/images/group-env-user.png
--------------------------------------------------------------------------------
/docs/resources/ibm-cloud/images/iam-acct-parts-1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/ibm-cloud/images/iam-acct-parts-1.png
--------------------------------------------------------------------------------
/docs/resources/ibm-cloud/images/iam-acct-parts-2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/ibm-cloud/images/iam-acct-parts-2.png
--------------------------------------------------------------------------------
/docs/resources/ibm-cloud/images/iam-complete.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/ibm-cloud/images/iam-complete.png
--------------------------------------------------------------------------------
/docs/resources/ibm-cloud/images/iam-main-all.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/ibm-cloud/images/iam-main-all.png
--------------------------------------------------------------------------------
/docs/resources/ibm-cloud/images/iam-main-parts-1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/ibm-cloud/images/iam-main-parts-1.png
--------------------------------------------------------------------------------
/docs/resources/ibm-cloud/images/iam-main-parts-2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/ibm-cloud/images/iam-main-parts-2.png
--------------------------------------------------------------------------------
/docs/resources/ibm-cloud/images/iam-parts-ex-1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/ibm-cloud/images/iam-parts-ex-1.png
--------------------------------------------------------------------------------
/docs/resources/ibm-cloud/images/iam-parts-ex-2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/ibm-cloud/images/iam-parts-ex-2.png
--------------------------------------------------------------------------------
/docs/resources/ibm-cloud/images/invokecloudshell.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/ibm-cloud/images/invokecloudshell.png
--------------------------------------------------------------------------------
/docs/resources/ibm-cloud/images/toolkit-access-groups.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/ibm-cloud/images/toolkit-access-groups.png
--------------------------------------------------------------------------------
/docs/resources/resources.md:
--------------------------------------------------------------------------------
1 | # Additional Resources
2 |
3 | Use the links below to find additional resources and learning content around Cloud-Native development, RedHat OpenShift and the IBM Cloud.
4 |
5 | ## Alternate Cloud-Native Toolkit learning options
6 |
7 | - [Workshop](workshop/workshop.md) : Assets to run a workshop with local git server
8 |
9 | ## Additional Cloud-Native and OpenShift learning
10 |
11 | - [Cloud Native Bootcamp : https://cloudnative101.dev](https://cloudnative101.dev){: target=_blank}
12 | - [Learning Journey : https://ibm-gsi-ecosystem.github.io/ibm-gsi-cloudnative-journey/](https://ibm-gsi-ecosystem.github.io/ibm-gsi-cloudnative-journey/){: target=_blank}
13 | - [IBM Open Labs - Red Hat OpenShift on IBM Cloud : https://developer.ibm.com/openlabs/openshift](https://developer.ibm.com/openlabs/openshift){: target=_blank}
14 | - [IBM Garage Methodology : https://www.ibm.com/garage/method/](https://www.ibm.com/garage/method/){: target=_blank}
15 |
16 | ## Useful IBM Cloud resources
17 |
18 | - [IBM Cloud roles](ibm-cloud/ibm-cloud-roles.md)
19 | - [access control](ibm-cloud/access-control.md)
20 | - [cluster fast-switching tool](ibm-cloud/icc.md)
21 | - [cloud shell](ibm-cloud/cloud-shell.md)
22 |
23 | ## Additional resources
24 |
25 | - [Cloud-Native Toolkit YouTube Channel](https://www.youtube.com/channel/UCCv359rg3CxVGFttCp0Tzvg){: target=_blank}
26 |
27 | ## Linking to this site
28 |
29 | As the site is under continuous revisions, you may want to provide links that are guaranteed to be available. The following links will always be maintained:
30 |
31 | - Site home : [https://cloudnativetoolkit.dev](https://cloudnativetoolkit.dev){: target=_blank}
32 | - Install : [https://cloudnativetoolkit.dev/install](https://cloudnativetoolkit.dev/install){: target=_blank}
33 | - Developer setup: [https://cloudnativetoolkit.dev/setup](https://cloudnativetoolkit.dev/setup){: target=_blank}
34 | - Learn : [https://cloudnativetoolkit.dev/learn](https://cloudnativetoolkit.dev/learn){: target=_blank}
35 | - workshop : [https://cloudnativetoolkit.dev/workshop](https://cloudnativetoolkit.dev/workshop){: target=_blank}
36 |
--------------------------------------------------------------------------------
/docs/resources/workshop/AppSrv01.zip:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/AppSrv01.zip
--------------------------------------------------------------------------------
/docs/resources/workshop/images/ai-app-baby-bear.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/images/ai-app-baby-bear.jpg
--------------------------------------------------------------------------------
/docs/resources/workshop/images/appmod.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/images/appmod.jpg
--------------------------------------------------------------------------------
/docs/resources/workshop/images/argo-app-staging.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/images/argo-app-staging.jpg
--------------------------------------------------------------------------------
/docs/resources/workshop/images/argo-app-staging2.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/images/argo-app-staging2.jpg
--------------------------------------------------------------------------------
/docs/resources/workshop/images/argo-app.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/images/argo-app.jpg
--------------------------------------------------------------------------------
/docs/resources/workshop/images/cd-argocd.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/images/cd-argocd.jpg
--------------------------------------------------------------------------------
/docs/resources/workshop/images/ci-tekton.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/images/ci-tekton.jpg
--------------------------------------------------------------------------------
/docs/resources/workshop/images/deploy-qa copy.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/images/deploy-qa copy.jpg
--------------------------------------------------------------------------------
/docs/resources/workshop/images/deploy-qa.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/images/deploy-qa.jpg
--------------------------------------------------------------------------------
/docs/resources/workshop/images/deploy-staging.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/images/deploy-staging.jpg
--------------------------------------------------------------------------------
/docs/resources/workshop/images/deploy-staging2.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/images/deploy-staging2.jpg
--------------------------------------------------------------------------------
/docs/resources/workshop/images/developer-dashboard.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/images/developer-dashboard.jpg
--------------------------------------------------------------------------------
/docs/resources/workshop/images/gitops copy.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/images/gitops copy.jpg
--------------------------------------------------------------------------------
/docs/resources/workshop/images/gitops-pr1.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/images/gitops-pr1.jpg
--------------------------------------------------------------------------------
/docs/resources/workshop/images/gitops.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/images/gitops.jpg
--------------------------------------------------------------------------------
/docs/resources/workshop/images/inventory.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/images/inventory.jpg
--------------------------------------------------------------------------------
/docs/resources/workshop/images/last-run.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/images/last-run.jpg
--------------------------------------------------------------------------------
/docs/resources/workshop/images/login.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/images/login.jpg
--------------------------------------------------------------------------------
/docs/resources/workshop/images/open-url.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/images/open-url.jpg
--------------------------------------------------------------------------------
/docs/resources/workshop/images/pipeline-run.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/images/pipeline-run.jpg
--------------------------------------------------------------------------------
/docs/resources/workshop/images/starter-kits-ai.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/images/starter-kits-ai.jpg
--------------------------------------------------------------------------------
/docs/resources/workshop/images/starter-kits.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/images/starter-kits.jpg
--------------------------------------------------------------------------------
/docs/resources/workshop/images/test-task.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/images/test-task.jpg
--------------------------------------------------------------------------------
/docs/resources/workshop/images/webhook.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/images/webhook.jpg
--------------------------------------------------------------------------------
/docs/resources/workshop/images/workshop.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/resources/workshop/images/workshop.jpg
--------------------------------------------------------------------------------
/docs/resources/workshop/setup.md:
--------------------------------------------------------------------------------
1 | # Setup Workshop Environment
2 |
3 |
4 |
5 | Provides the steps to install the Cloud-Native Toolkit and setting up the Cloud-Native Toolkit Workshop hands on labs.
6 |
7 |
8 |
9 | ## 1. Create OpenShift Cluster
10 |
11 | Create an OpenShift Cluster for example:
12 |
13 | - The 8 hours free Cluster on [IBM Open Labs](https://developer.ibm.com/openlabs/openshift) select lab 6 `Bring Your Own Application`
14 | - Deploy a Cluster on IBM Cloud VPC2 using the [Toolkit](../../adopting/setup/ibmcloud-tile-cluster.md)
15 | - On other Clouds using docs from [cloudnativetoolkit.dev/multi-cloud](../../adopting/setup/provision-cluster.md)
16 | - IBM internal DTE Infrastructure access via [IBM VPN](https://ccp-ui.csplab.intranet.ibm.com/) or [IBM CSPLAB](https://ccp-ui.apps.labprod.ocp.csplab.local/)
17 |
18 | ## 2. Install IBM Cloud Native Toolkit
19 |
20 | - Use one of the install options for example the [Quick Install](../../setup/fast-start.md)
21 |
22 | ```shell
23 | curl -sfL get.cloudnativetoolkit.dev | sh -
24 | ```
25 |
26 | ## 3. Setup IBM Cloud Native Toolkit Workshop
27 |
28 | - Install the foundation for the workshops
29 |
30 | ```shell
31 | curl -sfL workshop.cloudnativetoolkit.dev | sh -
32 | ```
33 |
34 | !!!Note
35 | - The username and password for Git Admin is `toolkit` `toolkit`
36 | - Usernames `user01` through `user15` are configured with a password of `password`.
37 | - Username `userdemo` is configured with the password `password`. You can use this username if using the workshop environment
38 | for self study or giving a demo. If you are preparing the environment for a workshop you can remove `userdemo`
39 | b y running the `uninstall-userdemo.sh` script which is part of the [workshop](https://github.com/cloud-native-toolkit/cloud-native-toolkit-workshop) scripts.
40 |
41 | ## 4. (Optional) Customization of the IBM Cloud Native Toolkit Workshop
42 |
43 | - You can customize the Workshop environment by cloning the [workshop](https://github.com/cloud-native-toolkit/cloud-native-toolkit-workshop) repo
44 |
45 | - Some of the most common customizations are:
46 |
47 | - You can create more than 15 users by setting a `USER_COUNT` environment variable. For example to configure 30 users use the command
48 | ```bash
49 | export USER_COUNT=30
50 | ```
51 |
52 | - You can create more than 15 projects by setting a `PROJECT_COUNT` environment variable. For example to configure 30 projects use the command
53 | ```bash
54 | export PROJECT_COUNT=30
55 | ```
56 |
57 | - Once you have finished configuring your customizations, login to the cluster from the cli and run the `scripts/install.sh` script to perform the install.
58 |
59 | - You can also add additional users to the workshop clusters.
60 | - Create a file with one user id per line.
61 | **IMPORTANT: there needs to be newline after the last entry.**
62 | For example a `users.txt` file with content.
63 | ```bash
64 | additionaluserID
65 | anotheruserID
66 | someuserID
67 |
68 | ```
69 |
70 | !!! note ""
71 | For Openshift clusters on IBM Cloud (ROKS) the user ids are their IBM IDs (email address) all lowercase with an uppercase `IAM#` prefix added to the beginning.
72 | ```bash
73 | IAM#additionaluserid@email.com
74 | IAM#anotheruserid@email.com
75 | IAM#someuserid@email.com
76 |
77 | ```
78 |
79 | - Create a `ADDITIONAL_USERS_FILE` environment variable with the path and name of the file.
80 | ```bash
81 | export ADDITIONAL_USERS_FILE=users.txt
82 | ```
83 | - The additional users will be granted the `self-provisioner` role, meaning they can create new Openshift Projects.
84 | If you wish to remove this permission set an environment
85 | variable `ADDITIONAL_USERS_SELF_PROVISIONER` with a value of `N`
86 | ```bash
87 | export ADDITIONAL_USERS_SELF_PROVISIONER=N
88 | ```
89 |
90 | - Once you have finished configuring the additional users, login to the cluster from the cli and run the `scripts/13-ocp-additional-users.sh` script.
91 |
92 |
93 |
94 |
--------------------------------------------------------------------------------
/docs/resources/workshop/terminal.md:
--------------------------------------------------------------------------------
1 |
2 | # Setup Terminal Shell
3 |
4 | - You can use [IBM Cloud Shell](https://cloud.ibm.com/shell), the [OpenLabs Shell](https://developer.ibm.com/openlabs/openshift) or your local workstation. More details in [Toolkit Dev Setup](../../learning/dev-setup.md) and [Toolkit CLI](../../reference/cli.md).
5 | Run the following command on Cloud, Linux or MacOS shell:
6 |
7 | ```shell
8 | curl -sL shell.cloudnativetoolkit.dev | bash -
9 | source ~/.bashrc || source ~/.zshrc
10 |
11 | ```
12 |
13 | Be sure to follow the instructions provided to enable the changes in the current terminal session.
--------------------------------------------------------------------------------
/docs/resources/workshop/workshop.md:
--------------------------------------------------------------------------------
1 | # IBM Cloud Native Toolkit Workshop
2 |
3 |
4 |
5 | The Workshop is design to provide a quick way to try the methodology leveraging the tools that the Toolkit integrates.
6 |
7 | ## Agenda
8 |
9 | [{: width=30%}](setup.md) Setup Workshop Environment (*workshop admin only*)
10 |
11 | [{: width=30%}](ci.md) Deploy an Application using CI Pipelines with Tekton
12 |
13 | [{: width=30%}](cd.md) Promote an Application using CD with GitOps and ArgoCD
14 |
15 | [{: width=30%}](inventory.md) Deploy a 3 tier Microservice using React, Node.js, and Java
16 |
17 | [{: width=30%}](appmod.md) App Modernization with modern DevOps
18 |
--------------------------------------------------------------------------------
/docs/setup/images/fast-start-install.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/setup/images/fast-start-install.png
--------------------------------------------------------------------------------
/docs/setup/images/fast-start-install.pptx:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/setup/images/fast-start-install.pptx
--------------------------------------------------------------------------------
/docs/setup/setup-options.md:
--------------------------------------------------------------------------------
1 | # Installing the Cloud-Native Toolkit
2 |
3 | !!!note
4 | If you are a developer attending a training event, where the training environment is provided, you should skip this section and move onto the Cloud-Native Toolkit fast [start content](../learning/fast-start.md)
5 |
6 | If you want to host a workshop for a number of developers, then you may want to use the [workshop](../resources/workshop/workshop.md).
7 |
8 | There is no single way to setup an enterprise development infrastructure for cloud native application development. There are [many different tools available](https://www.cncf.io/projects/){: target="_blank" .external } to help create Cloud Native applications. You need to find the set of tools and processes that allow the IT organization to work efficiently to create and manage production-ready applications and services. This can be a time consuming processes, to evaluate available tools and determine how to integrate them into a development environment.
9 |
10 | The Cloud-Native toolkit is an opinionated set of tools to create a production-ready development environment. The toolkit also provides installation options and starter kits to get you up and running quickly.
11 |
12 | If you don't have access to a Cloud-Native Toolkit installation then you can select one of the setup options detailed below to install the toolkit before moving onto the learning.
13 |
14 | ## Options for installing the toolkit
15 |
16 | {style="width: 90%" .center }
17 |
18 | The Cloud-Native toolkit will run on a standard Kubernetes cluster or on the Red Hat OpenShift hybrid cloud platform, which is based on Kubernetes.
19 |
20 | The Cloud-Native toolkit supports many different options for installing and configuring the toolkit across a number of different Kubernetes based environment, but for the first install it is recommended to follow the fast-start setup.
21 |
22 | The [fast-start installation](fast-start.md) will create an environment for you to learn about cloud native development. Once you have a better understanding of cloud native development you can then make informed decisions about how you want to do Cloud-Native Development within your production environment and customize the toolkit to meet your requirements.
23 |
24 | You will find additional installation and toolkit configuration options in the [Adopting the toolkit](../adopting/setup/installing.md) section, but the recommended path for your first installation is the [fast-start installation](fast-start.md) option.
25 |
26 | ## Prerequisites for installing the Cloud-Native Toolkit
27 |
28 | For all options to complete the Fast-start training your need a laptop or workstation with a modern Operating System (MS Windows, Mac OS or Linux) with an up to date browser.
29 |
30 | For IBM Cloud, bare metal, virtualized infrastructure or 3rd party cloud installs you also need to have a terminal for interacting with the cluster using command line tools. If using the IBM Cloud there is a web based command line environment available so you don't need to install additional tooling on your workstation or laptop.
31 |
32 | If using the Learning environment, you only need a browser, as the learning environment provides a web based command line environment.
33 |
34 | ### IBM Cloud Shell
35 |
36 | If you plan to use an IBM Cloud based cluster to complete the learning, then you can opt to use the IBM Cloud web based shell environment. To access the shell simply navigate to [https://cloud.ibm.com/shell](https://cloud.ibm.com/shell){: target="_blank" .external }.
37 |
38 | The web based shell contains all the tool needed (curl, node.js, ibmcloud CLI and oc CLI) to complete the installation.
39 |
40 | ### Install prerequisite tools on your workstation or laptop
41 |
42 | If you are not planning to use the IBM Cloud shell or are going to use the online Learning environment, then you need to have some prerequisite software installed on your laptop or workstation.
43 |
44 | If on Mac OS or Linux then you need to have curl installed. This is usually available from the Linux package manager or installed as part of the base operating system
45 |
46 | For all operating systems [Node.js](https://nodejs.org/en/) needs to be installed
47 |
--------------------------------------------------------------------------------
/docs/videos/deployapp.m4v:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/docs/videos/deployapp.m4v
--------------------------------------------------------------------------------
/linkcheckerrc:
--------------------------------------------------------------------------------
1 | [filtering]
2 | checkextern=1
3 | ignore=
4 | ^https://cloudnativetoolkit.dev
5 | ^https://github.com/cloud-native-toolkit/developer-guide/edit
6 | xml.gz$
7 | ^https://ccp-ui.csplab.intranet.ibm.com
8 | ^https://ccp-ui.apps.labprod.ocp.csplab.local
9 | fonts.gstatic.com
10 |
11 | nofollow=
12 | public/install.html$
13 | public/learn.html$
14 | public/learning.html$
15 | public/setup.html$
16 | public/workshop.html$
17 | public/resources/workshop.html$
18 | public/workshop/setup.html$
19 | public/workshop/terminal.html$
20 | public/workshop/ci.html$
21 | public/workshop/inventory.html$
22 | public/workshop/appmod.html$
23 | public/workshop/ai.html$
24 | public/learning/gitops-int/gitops-with-cloud-native-toolkit.html$
25 | public/learning/gitops-int/gitops-with-app-connect.html$
26 | public/tools/argocd.html$
27 | public/getting-started/dev-env-setup.html$
28 | public/getting-started-day-1/deploy-app.html$
29 | public/learning/ace-pipeline.html$
30 | public/whats-new.html$
31 | public/overview.html$
32 | public/getting-started/cli.html$
33 |
34 |
35 |
36 |
37 |
38 | [checking]
39 | robotstxt=0
40 | localwebroot=./
41 |
--------------------------------------------------------------------------------
/overrides/assets/images/apply.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/overrides/assets/images/apply.png
--------------------------------------------------------------------------------
/overrides/assets/images/catalyst.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/overrides/assets/images/catalyst.png
--------------------------------------------------------------------------------
/overrides/assets/images/learn-min.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/overrides/assets/images/learn-min.jpg
--------------------------------------------------------------------------------
/overrides/assets/images/resources-min.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/overrides/assets/images/resources-min.jpg
--------------------------------------------------------------------------------
/overrides/assets/stylesheets/home.css:
--------------------------------------------------------------------------------
1 | .home-hero {
2 | max-width: 100%;
3 | height: 45vh;
4 | max-height: 560px;
5 | width: 100%;
6 | position: relative;
7 | }
8 |
9 | .home-hero-image {
10 | height: 45vh;
11 | background-image: url(images/code3.png);
12 | background-position: center;
13 | background-size: cover;
14 | }
15 |
16 | .home-hero-text {
17 | bottom: 20px;
18 | right: 50px;
19 | position: absolute;
20 | background-color:rgba(0, 0, 0, 0.3);
21 | padding: 10px 10px 20px 10px;
22 | }
23 |
24 | .home-hero-text h1 {
25 | color: #fff;
26 | background: none;
27 | bottom: 0;
28 | font-size: 3.6em;
29 | padding-left: 20px;
30 | margin-bottom: 10px
31 | }
32 |
33 | .home-description {
34 | max-width: 100%;
35 | width: 100%;
36 | background: #030303;
37 | }
38 | .home-purpose {
39 | max-width: 100%;
40 | width: 100%;
41 | background: #061f80;
42 | }
43 |
44 | .row {
45 | display: flex;
46 | flex-direction: row;
47 | flex-wrap: wrap;
48 | width: 100%;
49 | padding-left: 1rem;
50 | padding-right: 1rem;
51 | padding-top: 4rem;
52 | padding-bottom: 4rem;
53 | font-size: 1.6em;
54 | }
55 |
56 | .column {
57 | display: flex;
58 | flex-direction: column;
59 | flex-basis: 100%;
60 | flex: 1;
61 | height: 100%;
62 | font-family: IBM Plex Sans VF,Helvetica Neue,Arial,sans-serif;
63 | }
64 |
65 | .md-main__inner {
66 | margin: 0;
67 | max-width: 100%;
68 | }
69 |
70 | .md-main__inner .md-content__inner,
71 | .md-sidebar--primary:not([hidden]) ~ .md-content > .md-content__inner {
72 | margin: 0;
73 | padding: 0;
74 | }
75 |
76 | .md-content__inner {
77 | margin-left: 0 !important;
78 | }
79 |
80 | .md-typeset img,
81 | .md-typeset svg {
82 | max-width: initial;
83 | }
84 |
85 | :root >* {
86 | --md-default-bg-color: #161616; /* background */
87 | --md-primary-bg-color: #fff; /* Title bar text */
88 | --md-typeset-a-color: #aaa; /* Additional header text */
89 | --md-typeset-color: #fff; /* nav text normal */
90 | --md-accent-fg-color: #9f9; /* text hover + highlight*/
91 | --md-default-fg-color--lighter: #33f; /* Nav scroll bar */
92 | --md-primary-bg-color--light: #fff; /* Search bar text */
93 | --md-default-fg-color: #fff; /* Search result box section header */
94 | --md-default-fg-color--light: #eee; /* Search box result text */
95 |
96 | }
97 |
98 | /* top banner home page */
99 | [data-md-color-primary=black] .md-header {
100 | background-color: #161616;
101 | border-bottom: 1px solid #393939;
102 | }
103 |
104 |
105 | article.md-content__inner.md-typeset {
106 | background-color: #161616;
107 | border-left: 1px solid #393939;
108 | }
109 |
110 | .md-content {
111 | padding-bottom: 0;
112 | }
113 |
114 | .card {
115 | padding: 10px 10px;
116 | }
117 |
118 | .card div {
119 | font-size: large;
120 | }
121 |
122 | .md-nav__link--active {
123 | color: white !important;
124 | }
125 |
--------------------------------------------------------------------------------
/overrides/assets/stylesheets/images/code3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/cloud-native-toolkit/site-developer-guide/86288545be7c4232875ab3a4abff0d3a9917ed50/overrides/assets/stylesheets/images/code3.png
--------------------------------------------------------------------------------
/overrides/home.html:
--------------------------------------------------------------------------------
1 | {% extends "main.html" %}
2 |
3 |
4 |
5 |
6 | {% block tabs %}{% endblock %}
7 |
8 |
9 | {% block content %}
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
34 |
35 |
36 |
37 |
38 |
55 |
71 |
88 |
89 |
90 |
91 |
92 |
93 | {% endblock %}
94 |
95 |
96 | {% block footer %} {{ super() }} {% endblock %}
97 |
--------------------------------------------------------------------------------
/overrides/main.html:
--------------------------------------------------------------------------------
1 |
2 | {% extends "base.html" %}
3 |
4 |
5 | {% block extrahead %}
6 |
7 |
8 | {% set title = config.site_name %}
9 | {% if page and page.title and not page.is_homepage %}
10 | {% set title = config.site_name ~ " - " ~ page.title | striptags %}
11 | {% endif %}
12 |
13 |
14 | {% set image = config.site_url ~ 'assets/images/banner.png' %}
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 | {% endblock %}
28 |
29 |
30 |
31 |
32 | {% block scripts %}
33 | {{ super() }}
34 |
35 | {% endblock %}
36 |
--------------------------------------------------------------------------------
/overrides/partials/footer.html:
--------------------------------------------------------------------------------
1 |
2 | {% import "partials/language.html" as lang with context %}
3 |
4 |
5 |
27 |
--------------------------------------------------------------------------------
/overrides/partials/nav.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | {% set class = "md-nav md-nav--primary" %}
4 | {% if "navigation.tabs" in features %}
5 | {% set class = class ~ " md-nav--lifted" %}
6 | {% endif %}
7 | {% if "toc.integrate" in features %}
8 | {% set class = class ~ " md-nav--integrated" %}
9 | {% endif %}
10 |
11 |
12 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "developer-guide",
3 | "version": "1.0.0",
4 | "description": "[](https://github.com/cloud-native-toolkit/developer-guide/actions/workflows/publish.yaml)",
5 | "main": "index.js",
6 | "directories": {
7 | "doc": "docs"
8 | },
9 | "scripts": {
10 | "clean": "run-script-os",
11 | "clean:darwin:linux": "dev/clean.sh devguide-dev",
12 | "clean:win32": "dev\\clean.bat devguide-dev",
13 | "predev": "npm run clean",
14 | "dev": "run-script-os",
15 | "dev:darwin:linux": "./dev/run.sh devguide-dev 8000",
16 | "dev:win32": "dev\\run.bat devguide-dev 8000",
17 | "postdev1": "npm run logs",
18 | "logs": "run-script-os",
19 | "logs:darwin:linux": "./dev/logs.sh devguide-dev",
20 | "logs:win32": "dev\\logs.sh devguide-dev",
21 | "dev:stop": "npm run clean",
22 | "dev:spell": "cspell docs/**/*.md",
23 | "dev:links": "linkchecker -f linkcheckerrc --check-extern public",
24 | "build": "run-script-os",
25 | "build:darwin:linux": "./build.sh",
26 | "build:win32": "build.bat",
27 | "dev:build": "run-script-os",
28 | "dev:build:darwin:linux": "dev/build.sh devguide-dev",
29 | "dev:build:win32": "dev\\build.bat devguide-dev",
30 | "test": "echo \"Error: no test specified\" && exit 1"
31 | },
32 | "repository": {
33 | "type": "git",
34 | "url": "git+https://github.com/ibm-garage-cloud/developer-guide.git"
35 | },
36 | "keywords": [],
37 | "author": "",
38 | "license": "ISC",
39 | "bugs": {
40 | "url": "https://github.com/cloud-native-toolkit/developer-guide/issues"
41 | },
42 | "homepage": "https://github.com/cloud-native-toolkit/developer-guide#readme",
43 | "devDependencies": {
44 | "cspell": "^5.4.1",
45 | "run-script-os": "^1.1.6"
46 | }
47 | }
48 |
--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | # Do not use with Docker builds, only for local dev with mkdocs CLI
2 | mkdocs-material==7.1
3 | mkdocs-minify-plugin==0.4.0
4 | mkdocs-redirects==1.0.3
5 | git+https://github.com/linkchecker/linkchecker@v10.0.1#egg=linkchecker
6 |
7 |
8 |
--------------------------------------------------------------------------------
43 | 
60 | 
76 |