Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions docs/learning/dev-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ To install the IBM Cloud CLI follow the instructions in the [IBM Cloud documenta

The oc command is available from all installations of RedHat OpenShift or CodeReady Containers. Navigate and log into the web console for the cluster, then in the dropdown accessed by clicking the help icon (a question mark next to you username at the top of the web console) you will find a link to the install images for various operating systems.

The install images are also available to download from [RedHat](https://mirror.openshift.com/pub/openshift-v4/x86_64/clients/ocp/){: target=_blank}. Be sure to get the latest version of the oc command.
The install images are also available to download from [RedHat](https://mirror.openshift.com/pub/openshift-v4/x86_64/clients/ocp/stable/){: target=_blank}. Be sure to get the latest version of the oc command.

## User accounts

Expand Down Expand Up @@ -97,6 +97,28 @@ npm i -g @ibmgaragecloud/cloud-native-toolkit-cli
```

!!!Note
If you have access to multiple IBM Cloud accounts you may find the [IBM Cloud cluster fast-switching tool (icc)](../resources/ibm-cloud/icc.md){: target=_blank} of use. The **icc** tool is installed as part of the Cloud-Native Toolkit CLI.
If you have access to multiple IBM Cloud accounts you may find the [IBM Cloud cluster fast-switching tool (icc)](../resources/ibm-cloud/icc.md){: target=_blank} of use. See the [Shell Command section](#ibm-cloud-shell-command) below to install icc.

If you are working on the IBM Cloud there is a browser based shell environment you can use. Information about setting up and accessing the browser based shell to work with the Cloud-Native Toolkit can be found in the [resources section](../resources/ibm-cloud/cloud-shell.md){: target=_blank}

## IBM Cloud Shell Command

There is a useful [IBM Cloud Shell Command](https://github.com/cloud-native-toolkit/cloud-shell-commands){target=_blank} utility which can install a number of command line tools, including:

- IBM Garage Cloud CLI (igc)
- ArgoCD cli (argocd)
- Tekton cli (tkn)
- IBM Cloud fast switching (icc)
- kube-ps1 prompt
- OpenShift cli (oc)
- Kubernetes cli (kubectl)
- JSON cli (jq)
- IBM Cloud cli (ibmcloud)

To run the utility use command:

```shell
curl -sL shell.cloudnativetoolkit.dev | sh -
```

See the [git repository readme](https://github.com/cloud-native-toolkit/cloud-shell-commands/blob/main/README.md){target=_blank} for more details
4 changes: 2 additions & 2 deletions docs/reference/tools/sonar-qube.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ SonarQube performs static code analysis to evaluate code quality, using analysis
- **Application Security**: Detect vulnerabilities and hot spots that can be exploited to compromise the program
- **Technical Debt**: Keep you codebase maintainable to increase developer velocity

SonarQube [plugs into the application lifecycle management (ALM)](https://docs.sonarqube.org/latest/architecture/architecture-integration/#header-2) process to make continuous inspection part of continuous integration. Adding code analysis to ALM provides regular, timely feedback on the quality of the code being produced. The goal is to detect problems as soon as possible so that they can be resolved before they can impact production end users.
SonarQube makes continuous inspection of code part of continuous integration to provide regular, timely feedback on the quality of the code being produced. The goal is to detect problems as soon as possible so that they can be resolved before they can impact production end users.

The continuous integration (CI) server integrates SonarQube into the ALM.The SonarQube solution consists of several components: The central component is the SonarQube Server, which runs the SonarScanner, processes the resulting analysis reports, stores the reports in SonarQube Database, and displays the reports in the SonarQube UI. A CI server uses a stage/goal/task in its build automation to trigger the language-specific SonarScanner to scan the code being built. Developers can view the resulting analysis report in the SonarQube UI.
The SonarQube solution consists of several components: The central component is the SonarQube Server, which runs the SonarScanner, processes the resulting analysis reports, stores the reports in SonarQube Database, and displays the reports in the SonarQube UI. A CI server uses a stage/goal/task in its build automation to trigger the language-specific SonarScanner to scan the code being built. Developers can view the resulting analysis report in the SonarQube UI.

## Code Analysis in the Pipeline

Expand Down
4 changes: 2 additions & 2 deletions docs/setup/fast-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Select the option you want for your cluster, then follow the instructions.
Add any additional post install configuration steps needed here - storage class?

2. Once installed you need to ensure you can sign onto the OpenShift cluster using the web console (see the Web console section in the docs for details on how to access the console).
3. Once you are signed into the console you can download and install the OpenShift Command Line Interface (CLI) tools. The CLI tools are available from the question mark icon next to you login name at the top of the OpenShift console, or from [Red Hat](https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/){: target="_blank" .external }.
3. Once you are signed into the console you can download and install the OpenShift Command Line Interface (CLI) tools. The CLI tools are available from the question mark icon next to you login name at the top of the OpenShift console, or from [Red Hat](https://mirror.openshift.com/pub/openshift-v4/x86_64/clients/ocp/stable/){: target="_blank" .external }.
4. On your local workstation or laptop open a command prompt and sign in to your OpenShift cluster. The exact command needed is available from the OpenShift web console, select your name at the top of the screen, then in the dropdown select the **Copy login command** link. This will open a screen where you can select **Display Token** (you may be asked to authenticate again before the token is displayed) then you can copy the command line command needed to login to the cluster.

=== "CodeReady Containers"
Expand All @@ -115,7 +115,7 @@ Select the option you want for your cluster, then follow the instructions.
!!!Warning
CodeReady Containers needs to adjust your laptop networking, so on some platforms it will not work alongside VPN clients needed to access corporate networks. If you need to run a VPN client, then you can install CodeReady Containers in a virtual machine on your laptop and work inside the virtual machine to access CodeReady Containers.

3. Download and install the OpenShift Command Line Interface (CLI) tools. The CLI tools are available from the question mark icon next to you login name at the top of the OpenShift console - see [section 3.3.1 in the CodeReady Containers Getting Started Guide](https://access.redhat.com/documentation/en-us/red_hat_codeready_containers/1.25.0/html/getting_started_guide/using-codeready-containers_gsg#accessing-the-openshift-web-console_gsg), or from [Red Hat](https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/){: target="_blank" .external }.
3. Download and install the OpenShift Command Line Interface (CLI) tools. The CLI tools are available from the question mark icon next to you login name at the top of the OpenShift console - see [section 3.3.1 in the CodeReady Containers Getting Started Guide](https://access.redhat.com/documentation/en-us/red_hat_codeready_containers/1.25.0/html/getting_started_guide/using-codeready-containers_gsg#accessing-the-openshift-web-console_gsg), or from [Red Hat](https://mirror.openshift.com/pub/openshift-v4/x86_64/clients/ocp/stable/){: target="_blank" .external }.
4. Once you have the CodeReady Containers CLI installed you need to login to the cluster - this is covered in the [CodeReady Containers Getting Started Guide - section 3.3.2](https://access.redhat.com/documentation/en-us/red_hat_codeready_containers/1.25.0/html/getting_started_guide/using-codeready-containers_gsg#accessing-the-openshift-cluster-with-oc_gsg){: target="_blank" .external }
5. Move onto the next section to install the Cloud-Native Toolkit

Expand Down
2 changes: 2 additions & 0 deletions linkcheckerrc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ ignore=
xml.gz$
^https://ccp-ui.csplab.intranet.ibm.com
^https://ccp-ui.apps.labprod.ocp.csplab.local
^https://github.com/IBM
^https://mirror.openshift.com/pub/openshift-v4/x86_64/clients/ocp/stable/
fonts.gstatic.com

nofollow=
Expand Down