Introduction
Architecture
Onboard
Introduction
IntroductionPromote an image in Amazon ECRDownload a file from JFrog ArtifactoryMove or copy an image from JFrog ArtifactoryUpload a file to JFrog ArtifactoryStore an object on Amazon S3Retrieve an object from Amazon S3
IntroductionCreate or update a functionInvoke a function
IntroductionRun an AWS CodePipelineRun a Bamboo projectRun a Bitbucket pipelineRun a CloudBees CI jobRun a CircleCI workflowRun a GitHub Actions workflowRun a GitLab pipelineRun a Harness pipelineRun a Jenkins® jobRun a JFrog pipelineRun a TeamCity project
Check out a Git repository
IntroductionAWS credentialsECR credentialsEKS credentialsGit global credentialsOCI credentials
IntroductionRun Argo WorkflowsCopy a remote image with CraneDeploy a binary with EC2Deploy to ECSRender an ECS task definitionBuild a container image with KanikoDeploy with OctopusDeploy with Spinnaker
Publish evidence items
IntroductionHelm chart installHelm chart packageHelm chart publishHelm chart uninstall
IntroductionCreate a Kubernetes namespaceCreate/update a Kubernetes resourceDeploy to a Kubernetes cluster
IntroductionVerify with NewRelic
Execute remote commands via SSH
IntroductionAnchoreAquasecJFrog XraySnyk ContainerSonatype (Nexus) ContainerTrivy
IntroductionStackhawkZAP
IntroductionCheckmarxFind Security BugsGitHub Security ScannerGosecMendNexus IQSnykSonarQube bundledSonarQube
IntroductionMendSnyk
IntroductionTruffleHog ContainerTruffleHog CodeTruffleHog S3
Publish test results

Onboard

3 minute read

Welcome to the CloudBees platform!

Sign up using Google social or GitHub OAuth credentials, or sign up by entering an email and password. Refer to Users for detailed information on setting up an account.

Once you have created an account, go to your email, open the invitation email with subject line CloudBees Email Verification, and select Verify. Alternatively, you can copy and paste the available link into your browser.

For more information on all types of CloudBees platform accounts, refer to Teams and Users.

Choose a pathway

Once you are signed in to the CloudBees platform, choose one of the following:

  1. Run a sample workflow.

  2. Use CI Insights for Jenkins®.

  3. Skip onboarding.

Onboarding choices
Figure 1. Select a pathway to onboard.

Run a sample workflow

Choose Run a sample workflow to connect a repository of your choice and set up a workflow that includes a security scan on the source code. For further examples, refer to:

To run a sample workflow:

  1. Select a source code management provider from the options.

  2. Select an integration type. Refer to create an SCM integration for more information.

  3. Follow the instructions at the provider to connect your repository to the CloudBees platform.

    Install GitHub App
    Figure 2. Completing GitHub App installation.

  4. Create a component by:

    1. Select a connected repository from the options.

    2. (Optional) Update the component name from the default, which is the repository name with any symbols converted to underscores (_).

    3. (Optional) Enter a description.

    4. Select CREATE COMPONENT.

  5. Select OPEN WORKFLOW to display the proposed workflow, which includes:

    1. A step to check out the repository.

    2. A SonarQube SAST scan of the repository code, with automatic language detection.

      Proposed Go workflow
      Figure 3. A sample Go app workflow with scan.

  6. (Optional) Make any desired updates, either in the workflow composer code editor, or by using the visual tool. By default, the workflow trigger is set to push.

    Refer to Managing workflows to learn more about:

    • Using the workflow composer, both the code editor and the visual tool.

    • Using different trigger options.

    • Adding and updating workflow steps and jobs.

  7. Save and run the workflow:

    1. Select COMMIT.

    2. Enter a commit message.

    3. Select to commit to either:

      • The current branch.

      • A new branch (and enter a new branch name).

    4. Select FINISH.

      Select menu items on the left pane to display:

      Select Arrow up/down icon or Arrow down icon to display nested functionality.

      Main navigation
      Figure 4. Main menu with Runs selected.

  8. Select Runs on the left pane to display your run.

Run details
Figure 5. Example run with details annotated.

Perform any of the following options in the run details:

  1. Note the run number and status. Run status is displayed as follows:

    • Processing run: Spinner

    • Successful run: Green checkmark icon

    • Failed run: Red exclamation mark icon

  2. Note the run start and end dates, and duration.

  3. Manually rerun a workflow without a commit (within 7 days of the original run) by selecting RERUN WORKFLOW. Select STOP RUN while a run is executing to cancel the run.

  4. Enter text to Search within the log. Select Select up icon and Select down icon to step through the log and highlight found instances. Select to clear the search.

  5. Select EXPAND ALL to display logs for all steps.

  6. Select the Vertical ellipsis, and then:

    • Select Show timestamps or Hide timestamps to display or hide, respectively, the timestamp next to each log line number.

    • Select Download log to download a compressed archive file of the log.

  7. Select the Arrow down icon next to any run step to display its log.

  8. Select GO TO END to scroll down to the end of a step log or the list of steps.

The Run a sample workflow path is completed accordingly.

Use CI Insights for Jenkins

Choose CI insights for Jenkins to manage all of your automation in a single dashboard.

To use CI insights for Jenkins:

  1. Select a CI tool from the options.

    Three CI tools
    Figure 6. Integrate three different kinds of CI tools.

  2. Connect your CI tool to the platform using the instructions. Refer to CI tools integration for more information.

    1. Install the required plugin(s).

    2. Copy and paste the authentication code into your CI tool.

      Copy the code
      Figure 7. Select the highlighted icon to copy the authentication code.

Once you have copied and saved the authentication code into your CI tool, you are redirected to the CI insights for Jenkins dashboard.

You may not immediately see ingested data displayed.

To learn more about the dashboard details, refer to the Analytics documentation.

Skip onboarding

To dive immediately into working with the CloudBees platform, select SKIP ONBOARDING at any time.