vania-janet/multiturn-rag-retrieval-data huggingface dataset:
Creating apps with the Node-RED Starter 

IBM® Cloud Foundry is deprecated and no longer supported as of 1 June 2023. For more information, see the [deprecation details](https://cloud.ibm.com/docs/cloud-foundry-public?topic=cloud-foundry-public-deprecationdep_details).

Node-RED provides a browser-based flow editor that makes it easy to connect devices, APIs, and online services by using the wide range of nodes in the palette. You can deploy the flows to the Node.js runtime environment with a single click. This starter app provides a version of Node-RED that is customized to run in IBM Cloud®.

Use the editor to create flows right away. You can also customize Node-RED itself. For more information, see the [Node-RED site](http://nodered.org/).



 Using Node-RED 

Complete the following steps to use the Node-RED starter app from the IBM Cloud console.



1. Create a Node-RED starter app and [download the starter code](https://github.com/IBM/node-red-app):



1. Click Create App to deploy a Node-RED starter app.
2. Provide the app name and host in the prompt.



2. After your app starts, click Routes URL or enter the following URL in a browser to display the Node-RED landing page.

http://<varname><yourhost></varname>.mybluemix.net
3. Click Go to your Node-RED flow editor to open the browser-based flow editor. The editor makes it easy to connect devices, APIs, and online services by using the wide range of nodes that are included in the palette.







 Customizing your Node-RED instance 

You can customize your Node-RED instance for your needs. For example, you can replace the landing page with your own page, add HTTP authentication to the flow editor, or add new nodes to the palette.



1. Download the app code by clicking Start Coding > Download Starter Code on the app's overview page.
[Navigation Menu icon](https://cloud.ibm.com/docs-content/v1/content/ff5860bfede49db3197c4bbba7f7123769bdc068/icons/icon_hamburger.svg) > Partner Center > Sell > Get started.
2. Enter the name of your company as you want it to be displayed in the catalog, and click Save. For the purpose of this tutorial, enter Example Corp as the company name.







 Step 2: Create your test environment 

You, or a member of your team, uses the test environment to onboard the Operator and validate that it can be deployed to a Red Hat OpenShift cluster. Your test environment includes a private catalog in which you import the Operator from an external repository.



1. Click Create in the Create your test environment section.
2. Enter Example Corp Catalog as the name of the private catalog, and click Create.







 Step 3: Set up access for your team 

You can enlist team members to help with the onboarding process by assigning them specific levels of IBM Cloud Identity and Access Management (IAM) access. Create an access group to streamline the process of assigning access.



1. Click Assign in the Assign access section.
2. Enter Example Corp Operator as the name of the access group, and click Assign. The following roles are assigned to the access group by default:



* Administrator on the Catalog Management service
* Editor on the Partner Center - Sell service
* Editor on the User Management service
* Editor on the IAM Access Groups service
* Viewer on all account management services





For more information about the actions associated with each role, see [Actions and roles for account management services](https://cloud.ibm.com/docs/account?topic=account-account-servicesaccount-management-actions-roles).





 Step 4: Add team members to your account 

After you create the Example Corp Operator access group, you're ready to add team members to your account and access group. Team members are granted the following editor permissions by default:
Product guide 

 Satellite 

--------------------



* Get started



* [Getting started with IBM Cloud Satellite ](https://cloud.ibm.com/docs/satellite?topic=satellite-getting-started)
* Understanding Satellite use cases



* [Satellite use cases](https://cloud.ibm.com/docs/satellite?topic=satellite-use-case)
* [Satellite for resellers](https://cloud.ibm.com/docs/satellite?topic=satellite-tenancy-model)
* [Edge environments for AI, IoT, and machine learning](https://cloud.ibm.com/docs/satellite?topic=satellite-edge-usecase)



* [Understanding Satellite location and hosts ](https://cloud.ibm.com/docs/satellite?topic=satellite-location-host)
* Understanding Satellite Connector



* [Satellite Connector overview](https://cloud.ibm.com/docs/satellite?topic=satellite-understand-connectors)
* [Satellite Connector and Secure Gateway](https://cloud.ibm.com/docs/satellite?topic=satellite-connector-and-secure-gateway)
* [Satellite Connector FAQ](https://cloud.ibm.com/docs/satellite?topic=satellite-connector-faq)



* [Supported Satellite-enabled IBM Cloud services](https://cloud.ibm.com/docs/satellite?topic=satellite-managed-services)
* [Release notes](https://cloud.ibm.com/docs/satellite?topic=satellite-satellite-relnotes)



* Tutorials



* [Tutorial library for Satellite](https://cloud.ibm.com/docs?tab=tutorials&page=1&pageSize=20&tags=satellite)
* [Deploying apps to clusters with Continuous Delivery and Satellite Config](https://cloud.ibm.com/docs/satellite?topic=satellite-sat_toolchain_tutorial)
In the Summary pane, review your order summary and then click Create.



The worker node can take a few minutes to provision, but you can see the progress in the Worker nodes tab. When the status reaches Ready, you can start working with your cluster by [deploying your first app](https://cloud.ibm.com/docs/containers?topic=containers-getting-starteddeploy-app)!





 Creating classic clusters in the IBM Cloud Kubernetes Service CLI 

Review the sample commands for creating classic clusters in the CLI. For more detailed steps and information about creating clusters, see [Creating classic clusters](https://cloud.ibm.com/docs/containers?topic=containers-cluster-create-classic&interface=cli). For information about planning your cluster set up, see [Preparing to create clusters](https://cloud.ibm.com/docs/containers?topic=containers-clusters&interface=cli).

Create a classic cluster on a shared virtual machine.

ibmcloud ks cluster create classic --name my_cluster --zone dal10 --flavor b3c.4x16 --hardware shared --workers 3 --public-vlan <public_VLAN_ID> --private-vlan <private_VLAN_ID>

Create a classic cluster with bare metal architecture.

ibmcloud ks cluster create classic --name my_cluster --zone dal10 --flavor mb2c.4x32 --hardware dedicated --workers 3 --public-vlan <public_VLAN_ID> --private-vlan <private_VLAN_ID>

Create a classic cluster that uses private VLANs and the private cloud service endpoint only.

ibmcloud ks cluster create classic --name my_cluster --zone dal10 --flavor b3c.4x16 --hardware shared --workers 3 --private-vlan <private_VLAN_ID> --private-only --private-service-endpoint
After you log in with your user ID and password, the IBM Cloud dashboard opens.
2. Click the Menu icon ![Menu icon](https://cloud.ibm.com/docs-content/v1/content/220cdcbf6f4421bd7fee83fd1028048dba3f16c8/icons/icon_hamburger.svg) > Resource list.
3. Look for the Event Streams instance that you plan to use, and select it.
4. In the Event Streams instance console, click Manage > Launch Dashboard.
5. Click Create a topic.

Zoom

![Create a topic](https://cloud.ibm.com/docs-content/v1/content/220cdcbf6f4421bd7fee83fd1028048dba3f16c8/monitoring/images/streaming-topic.png)

Create a topic
6. Enter a topic name and click Next.

Zoom

![Create a topic part 2.](https://cloud.ibm.com/docs-content/v1/content/220cdcbf6f4421bd7fee83fd1028048dba3f16c8/monitoring/images/streaming-topic-1.png)

Enter topic name
7. Enter the number of partitions and click Next.

One or more partitions make up a topic. A partition is an ordered list of messages. Partitions are distributed across the brokers in order to increase the scalability of your topic. You can also use them to distribute messages across the members of a consumer group.

Zoom

![Create a topic part 3.](https://cloud.ibm.com/docs-content/v1/content/220cdcbf6f4421bd7fee83fd1028048dba3f16c8/monitoring/images/streaming-topic-2.png)

Enter number of partitions
8. Select a Message retention and click Create Topic.
See [Getting started with the IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-getting-started) for the instructions to download and install the CLI.



Now you can start using the Analytics Engine V3 CLI. You must follow the instructions in steps 1 and 2 to install the required services before you start with step 3 to upload and submit Spark applications. Step 4 shows you how to create a logging instance and enable logging. Step 5 shows you how to delete an Analytics Engine instance, although this step is optional.





 Step 1: Create a Cloud Object Storage instance and retrieve credentials 

Create an IBM Cloud Object Storage instance and retrieve the Cloud Object Storage credentials (service keys) by using the Analytics Engine Serverless CLI.

The Cloud Object Storage instance that you create is required by the IBM Analytics Engine instance as its instance home storage for Spark history events and any custom libraries or packages that you want to use in your applications. See [Instance home](https://cloud.ibm.com/docs/AnalyticsEngine?topic=AnalyticsEngine-serverless-architecture-conceptsinstance-home).

For more information on how you can create a library set with custom packages that is stored in Cloud Object Storage and referenced from your application, see [Using a library set](https://cloud.ibm.com/docs/AnalyticsEngine?topic=AnalyticsEngine-use-lib-set).



1. Log in to IBM Cloud® using your IBM Cloud® account.

Action
: Enter:

ibmcloud api <URL>
ibmcloud login

Example
: Enter:

ibmcloud api https://cloud.ibm.com
ibmcloud login
2. Select the resource group. Get the list of the resource groups for your account and select one in which to create the IBM Analytics Engine serverless instance:

Action
: Enter:

ibmcloud target -g RESOURCE_GROUP_NAME

Parameter values:



* RESOURCE_GROUP_NAME: The name of resource group in which the serverless instance is to reside



Example
: Enter:

ibmcloud resource groups
IBM Cloud Shell docs 

IBM Cloud Shell is a workspace that you can access through your browser. Cloud Shell is preconfigured with the full IBM Cloud CLI, plug-ins, and tools that you can use to manage apps, resources, and infrastructure.

 Developer tools 

[API & SDK reference](https://cloud.ibm.com/apidocs/cloudshell)[CLI reference](https://cloud.ibm.com/docs/cli?topic=cli-ibmcloud_cli)[Terraform reference](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/cloud_shell_account_settings)

 Recommended content 

[Getting started with IBM Cloud Shell IBM Cloud Shell is a cloud-based shell workspace that's preconfigured with the full IBM Cloud CLI and several plug-ins and tools.](https://cloud.ibm.com/docs/cloud-shell?topic=cloud-shell-getting-started)[Troubleshooting for IBM Cloud Shell Use the tips in this section to help troubleshoot problems that you might run into when you use IBM Cloud Shell.](https://cloud.ibm.com/docs/cloud-shell?topic=cloud-shell-troubleshooting)[Working in Cloud Shell IBM Cloud Shell contains a personal workspace and sessions where you can run commands.](https://cloud.ibm.com/docs/cloud-shell?topic=cloud-shell-shell-ui)

 Learn more 

[IBM Developer<br><br>Visit IBM Developer for technical articles, code patterns, tutorials, and more.<br><br>![112-Developer-tools.svg](https://cloud.ibm.com/media/docs/images/homepage/112-Developer-tools.svg)](https://developer.ibm.com/depmodels/cloud/)[Architecture Center<br><br>Discover the architecture references available for this product.<br><br>!
[Read about IBM Cloud Monitoring](https://cloud.ibm.com/docs/monitoring?topic=monitoring-getting-started).

Work in a supported region, for example the US South region.

Use a user ID that is a member or an owner of an IBM Cloud account. To get an IBM Cloud IBMID, go to [Create an account](https://cloud.ibm.com/login).

Your IBMID must have assigned IAM policies for each of the following resources:



Table 1. List of IAM policies required to complete the tutorial

 Resource Scope of the access policy Role Region Information 

 Resource group default Resource group Viewer US South This policy is required to allow the user to see service instances in the default resource group. 
 IBM Cloud Monitoring service Resource group Editor US South This policy is required to allow the user to provision and administer the IBM Cloud Monitoring service in the default resource group. 



The IBM Cloud CLI must be installed. For more information, see [Installing the IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli).





 Step 1: Provision an Ubuntu Linux VPC server instance 

If you have an existing Ubuntu Linux virtual server instance you want to monitor, you can skip this step.



1. If you don't have a virtual private cloud, [use the IBM Cloud console to create VPC resources](https://cloud.ibm.com/docs/vpc?topic=vpc-creating-a-vpc-using-the-ibm-cloud-console).
2. If you don't have an Ubuntu Linux virtual server instance, [create an Umbuntu Linux virtual server instance by using the UI and selecting Ubuntu Linux as the Operating System](https://cloud.ibm.com/docs/vpc?topic=vpc-creating-virtual-servers).







 Step 2: Provision an IBM Cloud Monitoring instance 

To provision an instance of IBM Cloud Monitoring through the IBM Cloud UI, complete the following steps:



1.
* cloudant.tf creates a standard Cloudant DB and some credentials that we will use later to access it.
* redis.tf creates the Redis instance and some credentials that we will use later to access it.
* eventstreams.tf creates the Event Streams instance and some credentials that we will use later to access it.
* registry.tf creates the Container Registry that will hold your container images.
* iam.tf creates the access key that is needed to interact with the Container Registry.
* vpc.tf creates the VPC (Virtual Private Cloud) infrastructure that will be needed to deploy an OpenShift cluster. This includes a VPC, subnets and public gateways in three different availability zones.
* cos.tf create a single Cloud Object Storage instance that is needed by OpenShift to manage the cluster.
* openshift.tf creates a cluster of virtual machines inside your VPC, where you will deploy your applications.



It will take several minutes for the databases and other resources to be ready, but you should now have some VPC resources, a cluster of virtual machines, an IBM Cloud® Databases for Redis instance, a Cloudant database and an Event Streams instance in your account, as well as a Container Registry namespace for your container images. You can check by visiting the [Resources section](https://cloud.ibm.com/resources) of your IBM Cloud account.





 Step 4: Create container images and deploy to OpenShift 

At this point, all your infrastructure is ready to receive data. Now we have to build and deploy the different modules that will produce and consume the data, as well as the application that will display the truck position on a map.

Run the build script — but before you do, are you logged into the IBM Cloud CLI and Docker?

Go into the root of the project and type the following:

./build.sh





 Step 5: Watch your trucks truckin' 

The end of the script will output a URL — something like https:// some.thing.eu-gb.appdomain.cloud.
* An IBM Cloud [billable account](https://cloud.ibm.com/docs/account?topic=account-accounts),
* Follow the steps outlined under the VMware Solutions documentation for [Setting up your environment for your first order](https://cloud.ibm.com/docs/vmwaresolutions?topic=vmwaresolutions-completing_checklist).



A GitHub account is optional and only required if you plan on modifying the provided Terraform template beyond the steps outlined in this tutorial.





 Step 1: Create services 

Login to IBM Cloud via a web browser to create the IBM Cloud for VMware Solutions Shared virtual data center instance with the desired vCPU and RAM configuration.



 IBM Cloud for VMware Solutions Shared 



1. Navigate to [IBM Cloud for VMware Solutions](https://cloud.ibm.com/infrastructure/vmware-solutions/console).
2. In the Platforms section, click the VMware Shared card.
3. For Pricing Plans, select On-Demand.
4. Enter the virtual data center name, for example vmware-tutorial.
5. Select the Resource group where to create the service instance.
6. In the Deployment topology section, click the Single-zone Vmware virtual data center card.
7. Select the IBM Cloud geography to host the instance.
8. Scroll to Virtual data center capacity and set the vCPU Limit to 4 vCPU and the RAM Limit to 16 GB. You may increase or reduce the capacity as needed later on.
9. From the Summary pane on the right side of the screen, verify the configuration and estimated cost.
10. After having read and agreed to the third-party service agreements, click on Create.



While waiting for the instance to create, proceed to review the Terraform template section of this tutorial and come back to perform access steps below once the instance is available.





 Access the IBM Cloud for VMware Solutions Shared Instance 



1.
Onboard a broker 

This tutorial walks you through how to onboard a broker that you use to connect a pricing plan to your third-party service. When users create instances of your service from the IBM Cloud® catalog, the broker manages the lifecycle of those instances, and connects the service to the applications that developers are building.

This tutorial is one of five in a series that demonstrates how to onboard and publish a third-party service to IBM Cloud. As you complete the tutorial, adjust each step to fit your product's needs.



 Before you begin 



1. For an example of how to build your broker, see [IBM Cloud reference broker](https://github.com/IBM-Cloud/onboarding-osb).
2. Make sure you have the following API keys:



* An onboarding API key for access to the Global Catalog API.
* An IBM Cloud API key for access to your deployment target.





For more information, see [Managing API keys](https://cloud.ibm.com/docs/account?topic=account-userapikey).





 Add your broker 



1. Click Navigation Menu > Partner Center > Sell > My products, and select your service from the table.
2. From the Brokers tab, click Add broker.
3. Enter the name, URL, username, and password for your broker, and click Done.







 Set up IBM Cloud SSO 

You can enable IBM Cloud single sign-on for your service and add any redirect URLs that can handle authentication and authorization.



1. Click Navigation Menu > Partner Center > Sell > My products, and select your service from the table.
2. From the Brokers tab, click Set up IBM Cloud SSO.
3. Add team members as owners of the Client ID. Owners can view and edit the Client ID. You can't remove yourself from the list of owners.
4. Click Add to add a redirect URL.
5. Enter the redirect URL that can handle the authentication and authorization of your service.
6. Click Save.
7.
See [Assigning access to account management services](https://cloud.ibm.com/docs/account?topic=account-account-services) and [Managing access to resources](https://cloud.ibm.com/docs/account?topic=account-assign-access-resources).
* Review the list of supported software:



* Helm charts on Kubernetes and Red Hat OpenShift on IBM Cloud clusters
* Terraform templates
* OVA images deployed on VMware Solutions Dedicated - vCenter Server
* Virtual server images with Terraform deployed on VPC infrastructure
* Custom virtual server images deployed on VPC infrastructure
* Operators with a TGZ file from GitHub or GitLab repositories
* Operator bundles from Red Hat OpenShift registries









 Step 1: Provide your company name 



1. In the IBM Cloud console, click the Navigation Menu icon ![Navigation Menu icon](https://cloud.ibm.com/docs-content/v1/content/ff5860bfede49db3197c4bbba7f7123769bdc068/icons/icon_hamburger.svg) > Partner Center > Sell > Get started.
2. Enter the name of your company as you want it to be displayed in the IBM Cloud catalog.

The company name doesn't need to be finalized. You can update it later from the My company page in Partner Center if necessary.







 Step 2: Create a test environment 

You, or a member of your team, uses the test environment to onboard your product, and validate that it's ready to be published in the IBM Cloud catalog. Your test environment includes a private catalog in which you import your product from an external repository.



1. Click Create in the "Create your test environment" section on the Before you begin page.
2. Enter the name of your private catalog, and click Create. The private catalog and its contents are visible only to the users you choose.







 Step 3: Set up team access 

If you want to enlist team members to help with the onboarding process, you need to assign them specific levels of IBM Cloud Identity and Access Management (IAM) access.
Getting started with Cloud Foundry Public 

IBM® Cloud Foundry is deprecated and no longer supported as of 1 June 2023. For more information, see the [deprecation details](https://cloud.ibm.com/docs/cloud-foundry-public?topic=cloud-foundry-public-deprecationdep_details).



 Before you begin 



* Review the [IBM® Cloud Foundry terms and conditions](https://www-03.ibm.com/software/sla/sladb.nsf/sla/bm-8884-01).
* Review the [Swift buildpack deprecation statement](http://ibm.biz/cf-buildpack-swift-deprecation).
* Review the [Node.js buildpack change](http://ibm.biz/cf-buildpack-node-change).







 Developing your app 

There are three ways to develop your app:



* With the Continuous Delivery service
* In the IBM Cloud® console
* At the Cloud Foundry command line







 Developing and deploying your apps by using toolchains and the Continuous Delivery service 

[Add a toolchain](https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-toolchains_getting_startedcreating_a_toolchain_from_an_app) that includes the IBM Cloud® Continuous Delivery service to your app. Then, [use the toolchain](https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-toolchains-using) to develop and deploy your app.

Try the [Develop a Cloud Foundry app](https://www.ibm.com/cloud/architecture/tutorials/introduce-develop-cloud-foundry-app-toolchain) tutorial to learn about using toolchains to modify and continuously deliver a simple "Hello World" sample Cloud Foundry app.





 Creating your web app with the IBM Cloud console 

After signing up, start to build your first app by using the IBM Cloud catalog and console.

In IBM Cloud apps are associated with IBM Cloud organizations and spaces.