vania-janet/multiturn-rag-retrieval-data huggingface dataset:
This tutorial guides you through the steps to automatically grant federated users access to your account based on external identity provider specifications. By completing this tutorial, you learn how to create a trusted profile, establish trust with federated users based on attributes that are defined in your corporate user directory, and define a policy to assign access to resources.

Kubernetes service Managing your account, resources, and access



* 20 minutes
* 2022-05-27



[Deploy a Java Liberty app by using IBM Cloud Schematics](https://cloud.ibm.com/docs/apps?topic=apps-tutorial-liberty-webapp)Deploy a Java Liberty app by using IBM Cloud Schematics

In this tutorial, you learn how to create and deploy a scalable Java Liberty application. This scalable web app offers a one-click option to create an IBM Cloud® Schematics workspace with your choice of preconfigured Terraform templates. The Terraform templates deploy your app to IBM Cloud with options for the deployment target (Kubernetes or Red Hat® OpenShift®) and the DevOps toolchain pipeline structure.

Schematics Red Hat OpenShift on IBM Cloud

+4

Red Hat OpenShift on IBM Cloud,Kubernetes service,Continuous Delivery,Creating apps



* 45 minutes
* 2023-03-09



[Deploy a Node.js Express app by using IBM Cloud Schematics](https://cloud.ibm.com/docs/apps?topic=apps-tutorial-node-webapp)Deploy a Node.js Express app by using IBM Cloud Schematics

In this tutorial, you learn how to create and deploy a scalable Node.js Express application. This scalable web app offers a one-click option to create an IBM Cloud® Schematics workspace with your choice of preconfigured Terraform templates. The Terraform templates deploy your app to IBM Cloud with options for the deployment target (Kubernetes or Red Hat® OpenShift®) and the DevOps toolchain pipeline structure.

Schematics Red Hat OpenShift on IBM Cloud

+4
Your responsibilities when using Schematics 

Learn about the management responsibilities and terms and conditions that you have when you use IBM Cloud® Schematics. For a high-level view of the service types in IBM Cloud and the breakdown of responsibilities between you as the client and IBM for each type, see [Shared responsibilities for IBM Cloud offerings](https://cloud.ibm.com/docs/overview?topic=overview-shared-responsibilities).

Review the following sections for the specific responsibilities for you and for IBM when you use IBM Cloud Schematics. For the overall terms of use, see [IBM Cloud Terms and Notices](https://cloud.ibm.com/docs/overview/terms-of-use?topic=overview-terms). For responsibilities that you have for other IBM Cloud services that you use with Schematics, refer to the documentation of those services, such as [Red Hat OpenShift on IBM Cloud responsibilities](https://cloud.ibm.com/docs/openshift?topic=openshift-responsibilities_iks).



Shared responsibilities for the managed products

 Resource Description Schematics service Schematics Agents 

 Data Customer-owned content that includes all data that is managed and controlled by the customer. Examples include information that are stored into volumes, files, and databases hosted on IBM Cloud resources and data processed, stored, and logged by the client applications hosted on IBM Cloud. It doesn't include client metadata, the information that is used by IBM to provide services to the client support and operate the client account, services, and resources that are always considered to be shared responsibility between client and IBM. Customer-owned such as Templates, Git repository URL, input data, Terraform logs, state file. <br>Client metadata such as Client email ID, workspace, action names. Customer-owned content such as Agent data, Agent policies. <br>Client metadata such as Agent location, Agent name. 
 Applications Customer-owned software components, such as executables, web applications, middleware, frameworks, libraries, and other software packages that the client developed or acquired by third parties and deployed in IBM Cloud. None Customer-owned software components installed in Agents runtime.
* Check whether your repository uses Terratest framework to validate your Terraform resources and data source to provision, see [sample validated Terraform repository](https://github.com/terraform-ibm-modules/terraform-ibm-iam/blob/main/.github/workflows/validate_terraform.yml) to run Terratest.
* Check whether your repository contains gitignore for any files that are not tracked by Git remain untracked.
* Add the license file for your template.
* Do not set your sensitive variable as default in the configuration files.
* Check your secured variables or output as sensitive.
* Check that your script executions do not take more than 60 minutes, when your template is using null resources to provision or configure your resources.
* Do use only [allowed list file extensions](https://cloud.ibm.com/docs/schematics?topic=schematics-workspaces-faqclone-file-extension) in your repository.







 Can you create tfvars files with the IBM Cloud® provider templates? 

tfvars file is a local variables file that you can use to store sensitive information, such as your IBM Cloud API key or classic infrastructure username when your use Terraform. However, to secure your variable data, you cannot provide tfvars file in Schematics.





 How can the Terraform developers ensure that the sensitive data is not leaked in the log files? 

Developers need to check whether the variable or output parameter as a sensitive to ensure that the data is not leaked in the log files.







 Best practices of managing Schematics Workspaces 



 What are the best practices that you must follow in creating a workspace for the Terraform template? 

Follow these practices in creating a workspace for the Terraform template.



* Check whether you have the [right permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access) to create a workspace.
* Check whether the location and the url endpoint are pointing to the same region when you create or update the Schematics Workspace.
* UI
* CLI
* API







 OpenShift Data Foundation using local disks 

Set up OpenShift Data Foundation for IBM Cloud Satellite® clusters. You can use Satellite storage templates to create storage configurations. When you assign a storage configuration to your clusters, the storage drivers of the selected storage provider are installed in your cluster. Be aware that charges occur when you use the OpenShift Data Foundation service. Use the Cost Estimator to generate a cost estimate based on your projected usage.

OpenShift Data Foundation is available in only internal mode, which means that your apps run in the same cluster as your storage. External mode, or storage heavy configurations, where your storage is located in a separate cluster from your apps is not supported.

Before you can deploy storage templates to clusters in your location, make sure you set up Satellite Config by selecting the Enable cluster admin access for Satellite Config option in the console or including the --enable-config-admin option when you create your cluster.



 Understanding which ODF storage template to use 

You have two options when deploying OpenShift Data Foundation to your Satellite clusters, which are the odf-local and odf-remote storage templates.



* [odf-local](https://cloud.ibm.com/docs/satellite?topic=satellite-storage-odf-local): Choose this template when you have local storage available to your worker nodes. If your storage volumes are visible when running lsblk, you can use these disks when deploying ODF if they are raw and unformatted.
* [odf-remote](https://cloud.ibm.com/docs/satellite?topic=satellite-storage-odf-remote): Choose this template if you have a CSI driver installed in your cluster. For example, the azuredisk-csi-driver driver. You can use the CSI driver to dynamically provision storage volumes when deploying ODF.







 Prerequisites for ODF 

To use the ODF storage with the local storage operator and local storage devices, complete the following tasks:



1. Make sure you have the following permissions.



* Editor for the Billing service.
Correct the Terraform config error at source and push a new release to its Git source repository.

If explicit version of the blueprint modules is used on specific branches. The blueprint template requires updating in its Git repository to specify the new release tag or branch for the module statement.



* Update the blueprint module statements to specify the new module version.
* Push the new release of the blueprint template to its Git source repository. With an updated release tag for the template if needed.



For modules, when no Git release is specified on the blueprint module statements and relaxed module version are used. No update to the blueprint template is needed. The current change to the module repository is pulled automatically by Schematics.

Run the ibmcloud schematics blueprint update command to refresh the blueprint configuration that is stored by Schematics with the update to the blueprint template. With latest release, Schematics identifies the updated module Git repository and run the Pull-Latest to update any modules with the modified Terraform configurations.

ibmcloud schematics blueprint update -id <blueprint_ID> 

If explicit version is used with release tags for each blueprint template release, the blueprint configuration must be updated in Schematics with the new release tag.

ibmcloud schematics blueprint update --id <blueprint_ID> --bp-git-release x.y.z  

Finally, run the ibmcloud schematics blueprint apply command to rerun the failed Terraform Apply operation and to complete all operations against all modules.

ibmcloud schematics blueprint apply -id <blueprint_ID> 





 Blueprint apply failure due to Terraform timeouts or transient failures 

 What’s happening 

When you run the blueprint apply command, it fails with message that the install of module fails.

 Why it’s happening 

Analysis of the logs indicates that the modules Terraform apply operation that is timed out or a transient failure occurs.

 How to fix it 

No user action must be necessary to recover and the apply operation can be retried.

Run the ibmcloud schematics blueprint apply command to rerun the failed Terraform Apply operation and complete all operations against all modules.
Creating a Satellite location 

The first step to getting started with Satellite is to create a Satellite location. A Satellite location is a representation of an environment in your infrastructure provider, such as an on-prem data center or cloud. Locations can be made up of communications endpoints such as a Docker container, or of compute resources called hosts, which are used to form separate availability zones out of a given x86 infrastructure.

The type of location that you create dictates the type of operating systems that can run on your hosts. If your location is RHCOS enabled, then you can attach hosts that are running either RHEL and RHCOS. If your location isn't RHCOS enabled, then you can attach only hosts that are running RHEL. You can check whether your [location is RHCOS enabled](https://cloud.ibm.com/docs/satellite?topic=satellite-locationsverify-coreos-location).



 Create location overview 

Before you create your location, check out the following topics.



* [Find out more about locations and hosts](https://cloud.ibm.com/docs/satellite?topic=satellite-location-host).
* [Plan your infrastructure](https://cloud.ibm.com/docs/satellite?topic=satellite-infrastructure-plan).
* [Verify your host setup](https://cloud.ibm.com/docs/satellite?topic=satellite-host-network-check).







 Automating your location setup with a Schematics template 

Automate your setup with templates that use [IBM Cloud® Schematics](https://cloud.ibm.com/docs/schematics?topic=schematics-getting-started) to create a Satellite location, provision hosts in a cloud provider, and set up the Satellite location control plane for you.

To create a location that is enabled for Red Hat CoreOS, you must create your location [manually](https://cloud.ibm.com/docs/satellite?topic=satellite-locationslocation-create-manual).

Do not reuse the same name for multiple locations, even after the other location is deleted.
* UI
* CLI
* API







 OpenShift Data Foundation for remote devices 

Set up OpenShift Data Foundation for IBM Cloud Satellite® clusters. You can use Satellite storage templates to create storage configurations. When you assign a storage configuration to your clusters, the storage drivers of the selected storage provider are installed in your cluster. Be aware that charges occur when you use the OpenShift Data Foundation service. Use the Cost Estimator to generate a cost estimate based on your projected usage.

OpenShift Data Foundation is available in only internal mode, which means that your apps run in the same cluster as your storage. External mode, or storage heavy configurations, where your storage is located in a separate cluster from your apps is not supported.

Before you can deploy storage templates to clusters in your location, make sure you set up Satellite Config by selecting the Enable cluster admin access for Satellite Config option in the console or including the --enable-config-admin option when you create your cluster.



 Understanding which ODF storage template to use 

You have two options when deploying OpenShift Data Foundation to your Satellite clusters, which are the odf-local and odf-remote storage templates.



* [odf-local](https://cloud.ibm.com/docs/satellite?topic=satellite-storage-odf-local): Choose this template when you have local storage available to your worker nodes. If your storage volumes are visible when running lsblk, you can use these disks when deploying ODF if they are raw and unformatted.
* [odf-remote](https://cloud.ibm.com/docs/satellite?topic=satellite-storage-odf-remote): Choose this template if you have a CSI driver installed in your cluster. For example, the azuredisk-csi-driver driver. You can use the CSI driver to dynamically provision storage volumes when deploying ODF.







 Prerequisites for using ODF for remote devices 



1. Make sure you have the following permissions.



* Editor for the Billing service.
* Manager and Editor for Kubernetes service.
* Satellite Link Administrator and Reader for the Satellite service.
* The scope defines the data that is valid for aggregation.
* Only the data that is in scope is displayed.







 Teams 

You can use global attributes to define the data that is visible and available for analysis in a team.







 Monitoring platform metrics through dashboards 

Each IBM Cloud provides 1 or more dashboard templates that you can use to monitor that service.



* Dashboard templates are available in the Dashboards section of the monitoring UI.

Zoom

![IBM Cloud services default dashboards](https://cloud.ibm.com/docs-content/v1/content/220cdcbf6f4421bd7fee83fd1028048dba3f16c8/monitoring/platform/images/sysdig-platform-1.png)

Default dashboard
* Dashboard templates are only visible in the monitoring UI if you have an instance of the service running in that region.
* Dashboard templates cannot be customized.



You can create a copy of a dashboard template. You can customize the copy of the dashboard.



 Creating a custom dashboard 

Complete the following steps to create a custom dashboard:



1. [Launch the monitoring UI](https://cloud.ibm.com/docs/monitoring?topic=monitoring-launch).
2. Navigate to the Dashboards section (![dashboard section](https://cloud.ibm.com/docs-content/v1/content/220cdcbf6f4421bd7fee83fd1028048dba3f16c8/monitoring/images/dashboards.png)) in the Web UI.
3. In the DASHBOARD TEMPLATES section, expand the IBM section, and select a dashboard template for a service that you want to monitor.
4. Select Create Custom Dashboard. The window Create Dashboard from Template opens.
5. Enter a name for your dashboard, and click Create and Open. The dashboard opens.



You can locate the dashboard that you have copied in the section Dashboards > My Dashboads.

Next, customize the scope and panels in the dashboard.





 Defining the scope of a dashboard
(https://cloud.ibm.com/docs/schematics?topic=schematics-secure-datapi-location)







 June 2020 

Review the release notes for June 2020.



 26 June 2020 

Ansible provisioner support
: You can now use the Ansible provisioner with IBM Cloud Schematics to deploy software on IBM Cloud resources or perform actions against your resources, such as shutting down a virtual server instance. For more information about how to use the Ansible provisioner, see [Discover best practice VPC configuration for application deployment](https://developer.ibm.com/articles/secure-vpc-access-with-a-bastion-host-and-terraform/), and [Learn about repeatable and reliable end-to-end app provisioning and configuration](https://developer.ibm.com/articles/application-deployment-with-redhat-ansible-and-ibm-cloud-schematics/).





 25 June 2020 

Version 1.8.0 of the IBM Cloud Provider plug-in available
: The IBM Cloud Provider Plug-in for Terraform version 1.8.0 is now enabled in IBM Cloud Schematics. For more information about the version, see the [release notes](https://github.com/IBM-Cloud/terraform-provider-ibm/releases/tag/v1.8.0). For an overview of supported IBM Cloud resources and data sources, see the [IBM Cloud Provider plug-in reference](https://cloud.ibm.com/docs/ibm-cloud-provider-for-terraform?topic=ibm-cloud-provider-for-terraform-resources-datasource-list).





 22 June 2020 

Upload Terraform templates as TAR files
: You can now provide your Terraform template by uploading a tap archive file from your local machine. This feature is supported from the command-line or API.
If you edited the AWS EC2 instances, you might want to click the Edit pencil icon to change details such as the description, API key, or IBM Cloud multizone region that the location is managed from.
7. In the Summary pane, review the cost estimate.
8. Click Create location. Your location might take about 30 minutes to finish provisioning.
9. Optional: To review the provisioning progress, review the logs in the Schematics workspace that is automatically created for you.



1. Click Manage in Schematics. If you see an error, navigate to the [Schematics workspaces console](https://cloud.ibm.com/schematics/workspaces) and click the name of your workspace, such as us.east.cartOrder....
2. From the Activity tab, find the current activity row and click View log to review the log details.
3. Wait for the Schematics action to finish and the workspace to enter an Active state.





Well done, your Satellite location is creating! You can review the [Satellite console](https://cloud.ibm.com/satellite/locations) to see when your location is in a Normal state and ready to use.

The following resources are created by the template in your AWS cloud account.



* 1 virtual private cloud (VPC).
* 1 subnet for each of the 3 zones in the region.
* 1 security group to meet the host networking requirements for Satellite.
* 6 RHEL 8 EC2 instances, spread evenly across zones, or the number of hosts that you specified.



The following resources are created by the template in your IBM Cloud account.



* 1 Satellite location.
* 3 Satellite hosts that represent the EC2 instances in AWS, attached to the location and assigned to the Satellite location control plane.
* 3 Satellite hosts that represent the EC2 instances in AWS, attached to the location, unassigned, and available to use for services such as a Red Hat OpenShift cluster. If you added more than 6 hosts, If you added more than 6 hosts, the additional hosts are unassigned and available for use in the control plane or by services.
Email or Account GUIDs are acceptable.

--restrict
: Changing the restriction of the visibility object to 'Private'.

--unrestrict
: Changing the restriction of the visibility object to 'Public'.

-c
: Valid JSON object that contains catalog-specific configuration parameters, provided either inline or in a file. For a list of supported configuration parameters, see documentation for the particular catalog entry.

--global
: Operate in global scope





 Examples 

Set visibility of resource j402-dnf1i from JSON file:

ibmcloud catalog entry-visibility-set 'j402-dnf1i' -c @visibility.json







 ibmcloud catalog service-marketplace 

List service offerings in the marketplace:

ibmcloud catalog service-marketplace [--rc] [--global]



 Command options 

--rc
: Show RC compatible services only

--global
: Operate in global scope





 Examples 

Show service offerings in global scope:

ibmcloud catalog service-marketplace --global







 ibmcloud catalog service 

View details of a service in the catalog, including a description, tags, compatibility information, and available plans.

ibmcloud catalog service NAME_OR_ID [--global]



 Command options 

--global
: Operate in a global scope





 Examples 

Show details of the container-kubernetes service:

ibmcloud catalog service container-kubernetes







 ibmcloud catalog templates 

View the boilerplate templates on IBM Cloud.

ibmcloud catalog templates [-d]



 Command options 

-d (optional)
: If the -d option is specified, the description of each template is also displayed. Otherwise, only the ID and name of each template is shown.







 ibmcloud catalog template 

View the detailed information of a specified boilerplate template.

ibmcloud catalog template TEMPLATE_ID



 Command options 

TEMPLATE_ID (required)
: The ID of the boilerplate template. Use ibmcloud templates to view all templates' IDs.





 Examples 

View details of the template mobileBackendStarter:
Workspace operational states 



 Workspace state overview 

Review the states that a workspace can have in the following table. You might not see all states in the IBM Cloud console. Some states are only visible when using the command-line or API.



Workspace state overview

 State Description 

 Active After you successfully ran your infrastructure code with IBM Cloud Schematics by applying your Terraform execution plan, the state of your workspace changes to Active. 
 Connecting Schematics tries to connect to the template in your source repo. If successfully connected, the template is downloaded and metadata, such as input parameters, is extracted. After the template is downloaded, the state of the workspace changes to Scanning. 
 Draft The workspace is created without a reference to a GitHub, GitLab, or Bitbucket repository. 
 Failed If errors occur during the execution of your infrastructure code in IBM Cloud Schematics, your workspace state is set to Failed. To troubleshoot errors, open the logs on the workspace Activity page. 
 Inactive The Schematics template was scanned successfully and the workspace creation is complete. You can now start running Schematics plan and apply job to provision the IBM Cloud resources that you specified in your template. If you have an Active workspace and decide to remove all your resources, your workspace is set to Inactive after all your resources are removed. 
 Inprogress When you instruct IBM Cloud Schematics to run your infrastructure code by applying your Terraform execution plan, the state of your workspace changes to Inprogress. 
 Scanning The download of the Schematics template is complete and vulnerability scanning started. If the scan is successful, the workspace state changes to Inactive. If errors in your template are found, the state changes to Template Error. 
 Stopped The Schematics plan, apply, or destroy job are stopped manually. 
 Template_Error The Schematics template contains errors and cannot be processed. 







 Workspace state diagram and manipulative job 

The state of a workspace indicates if you have successfully created a Terraform execution plan and applied to provision your resources in the IBM Cloud account. The table represents the state and the workspace job.



Workspace state diagram

 workspace State diagram Description 

 Create workspace !