vania-janet/multiturn-rag-retrieval-data huggingface dataset:
Monitoring integration 

IBM Cloud® Schematics integrates to fully manage enterprise-grade IBM Cloud® Monitoring that provides visibility of the performance and health of your IBM Cloud powered resources application. This feature includes live logs, custom views, and alert of the Schematics Workspaces by connecting, configuring, and view through observability dashboards.



  Launching monitoring 

Use monitoring instance to monitor the health of the IBM Cloud Schematics Workspace. To set up Monitoring, create a Monitoring instance in a public cloud region and plan associated to the resource. The region defines where your metrics are centralized. The plan specifies the features and retention period for your metrics. Complete these steps to launch Monitoring.



1.  Log in to your [IBM Cloud](https://cloud.ibm.com/) account by using your credentials.
2.  From the IBM Cloud page, select Navigation menu > Schematics.
3.  Select Integration in the side navigation pane.
4.  Against your monitoring instance, click Configure and select your instance name based on your location.
5.  Click Select.
6.  Select your location and click Connect > Activity tracking. You are redirected to the IBM Cloud Activity Tracker service form to monitor your instance.
7.  Select your location and click Connect > Monitoring. You are redirected to the Monitoring service form to monitor your instance.

In case you are redirected to the [IBM Cloud catalog](https://cloud.ibm.com/catalog) page, search for Monitoring to view the Monitoring service form.
8.  Analyze the configuration and click Create.

If the create is successful you can view logs of your Schematics service instance in the IBM Cloud Monitoring that is configured to receive platform service logs. For more information about monitoring, see [Viewing logs](https://cloud.ibm.com/docs/log-analysis?topic=log-analysis-monitor_logs).
9.  In the list of instance name, click Configure to view Monitoring page to retrieve the instance summary details and click Open Dashboard to monitor the hosts and events of your services.
The CLI uses geographic specific API endpoints which direct job requests to the first available region within a geography. us.schematics.cloud.ibm.com is called irrespective of the target us-south or us-east region and similarly, eu.schematics.cloud.ibm.com is called irrespective of the target eu-gb or eu-de region. Schematics dynamically determines which region to send the request based on region availability. Config targeted to us-south during creation, will be automatically run on us-east if us-south is not available.

This behavior is similar in the UI. For example, in the Schematics Workspace creation page, you select North America region from the list.





 Is it possible to delete the Schematics service instance by using the Resource Controller API or CLI? 

You cannot delete the Schematics service instance. Instead you can destroy the cloud resources that are created by using Schematics Terraform and delete the Schematics objects such as workspace, or an action.

Schematics service is provisioned for the following reasons.



* Whenever Schematics service is used for the first time, you do not explicitly provision the Schematics.
* Schematics is a free service, not charged for the service instance.



There is no plan to add this feature to delete the Schematics service instance.
: Schematics announces its [beta release](https://cloud.ibm.com/docs/schematics?topic=schematics-agent-beta-limitations) of Schematics Agents to extend Schematics availability to reach your private, or on-premises infrastructure. Check the following content to learn about Schematics Agents beta releases.



* [Landing page](https://cloud.ibm.com/docs/schematics) to start your Schematics Agents engagement.
* [About Schematics Agents](https://cloud.ibm.com/docs/schematics?topic=schematics-agents-intro).
* Agents are supported through [CLI](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceagents-beta0-cmd), [UI](https://cloud.ibm.com/docs/schematics?topic=schematics-agents-setupagents-setup-infra-ui), APIs related to [Agents](https://cloud.ibm.com/apidocs/schematics/schematicslist-agent), and [Policy](https://cloud.ibm.com/apidocs/schematics/schematicslist-policy).
* Install [Schematics Agents](https://cloud.ibm.com/docs/schematics?topic=schematics-agents-setup) through UI.
* Connect the [Schematics Agent](https://cloud.ibm.com/docs/schematics?topic=schematics-register-agent) through UI to register the Agent to the Schematics service instance.
* Use the [Schematics Agent](https://cloud.ibm.com/docs/schematics?topic=schematics-using-agent) through UI to bind the Schematics Workspaces to the Agent.
* UI
* CLI
* API
* Terraform







 Running a workspace apply 

Schematics uses workspaces to deploy and manage resources in IBM Cloud® accounts.

IBM Cloud Schematics enables you to deploy and manage resources in any IBM Cloud location or region globally. The region where you create and work with your Schematics workspaces and actions is independent of the region where your IBM Cloud resources are deployed or configured.

IBM Cloud Schematics runs your jobs from the Schematics region hosting the workspace and remotely accesses services to provision resources in the target regions determined by your Terraform templates. Workspace operations in remote regions are unaffected by network latency between the management and target regions.

IBM Cloud Schematics deprecates older version of Terraform. For more information, see [Deprecating older version of Terraform process in IBM Cloud Schematics](https://cloud.ibm.com/docs/schematics?topic=schematics-deprecate-tf-version).



 Before you begin 



* [Create a Terraform configuration](https://cloud.ibm.com/docs/schematics?topic=schematics-create-tf-config), and store the configuration in a GitHub, GitLab, or Bitbucket repository. You can also upload a tape archive file (.tar) from your local workstation to provide your template to IBM Cloud Schematics. For more information, see the [ibmcloud schematics workspace upload](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-referenceschematics-workspace-upload) command and see the [upload a tar file to your workspace](https://cloud.ibm.com/apidocs/schematics/schematicsupload-template-tar) API.
* Make sure that you have the [permissions](https://cloud.ibm.com/docs/schematics?topic=schematics-access) to create a workspace.
* Replace your IBM Cloud API key to the authenticator = IAMAuthenticator('<ibm-api-key>') variable.
* Change the API endpoint to the endpoint mentioned in [API endpoints](https://cloud.ibm.com/apidocs/schematics?code=pythonapi-endpoints) according to the location that you want your Schematics workspace to reside, for example, schematics_service.set_service_url('https://us.schematics.cloud.ibm.com').
* Provide environment values that you want to have in the form of a key and value pair, such as [{ 'Environment': 'hpc-dev-cluster' }]
* Change the folder location variable template_source_data_request_model['folder'] to the folder name inside your GitHub repository where your Terraform files reside. If the Terraform files exist in the base location of your repository, then set this variable to template_source_data_request_model['folder'] = ' '; otherwise, mention the folder name in the template_source_data_request_model['folder'] variable.
* Change the template_source_data_request_model['type'] variable to the Terraform version that you are using to create IBM Cloud resources such as terraform_v0.14. Ensure that your Terraform templates are compatible with the version that you are mentioning in this field.
* Provide your GitHub or GitLab Repository HTTPS URL where your Terraform files reside in the template_repo_request_model['url'] variable. If you are using the [public repository](https://github.com/IBM-Cloud/hpc-cluster-symphony) that is provided by IBM Cloud, then set this variable as template_repo_request_model['url'] = 'https://github.com/IBM-Cloud/hpc-cluster-symphony'; otherwise, set it to the private repository you are using.



4. Inside the schematics_service.create_workspace function, provide the following parameters:



* Provide an optional description.
Schematics Blueprints is a [beta feature](https://cloud.ibm.com/docs/schematics?topic=schematics-bp-beta-limitations) that are available for evaluation and testing purposes. It is not intended for production usage. Refer to the list of [limitations](https://cloud.ibm.com/docs/schematics?topic=schematics-bp-beta-limitationssc-bp-beta-limitation) for the beta release.



 blueprint create fails in the create_init step 

 What’s happening 

When you create a blueprint config, it fails during initialization of the blueprint modules.

 Why it’s happening 

Blueprint environments are created in two steps. The first step retrieves, validates the blueprint template, and creates the configuration in Schematics. The second step creates the needed modules based on the module definitions in the template. This step clones the specified module source repos. An incorrectly specified repo URL results in a workspace initialization failure. Other possible causes are the repository is private and an access token is not specified, or the access token is invalid.

Sample error

Created Blueprint   blueprints-starter-example   eu-gb.BLUEPRINT.blueprints-starter-example.deee1f6f

Modules to be created
SNO   Type        Name   
1     Terraform   terraform_module2   
2     Terraform   terraform_module1   
      
Blueprint job running eu-gb.JOB.blueprints-starter-example.e44adbab

Waiting:2    Draft:0    Connecting:0    InProgress:0    Inactive:0    Active:0    Failed:0   

Type        Name                         Status                     Job ID   
Blueprint   blueprints-starter-example   CREATE_FAILED   eu-gb.JOB.blueprints-starter-example.e44adbab   
Terraform   terraform_module2            NA                 
Terraform   terraform_module1            NA                 
            
Blueprint create_failed at Tue Jun 14 13:21:49 BST 2022
OK

The job status shows as create_failed.
Click one of the following options for the cluster deployment target and toolchain pipeline type. This action takes you to the Deploy to IBM Cloud page where you create a Schematics workspace. Complete the required fields on that page, and then click Next.

The following options use the [simple-helm-toolchain template](https://github.com/open-toolchain/simple-helm-toolchain), which uses a Classic pipeline structure.

[![Deploy to Kubernetes on IBM Cloud](https://cloud.ibm.com/docs-content/v1/content/efbf7b33e3aca029f69f9244bced9dd4d8acb848/apps/images/Deploy_to_kube.svg)](https://cloud.ibm.com/schematics/workspaces/create?repository=https://github.com/IBM-Cloud/Scalable-web-app-node/tree/master/terraform/simple-kube&terraform_version=terraform_v1.3)[![Deploy to OpenShift on IBM Cloud](https://cloud.ibm.com/docs-content/v1/content/efbf7b33e3aca029f69f9244bced9dd4d8acb848/apps/images/Deploy_to_Openshift.svg)](https://cloud.ibm.com/schematics/workspaces/create?repository=https://github.com/IBM-Cloud/Scalable-web-app-node/tree/master/terraform/simple-openshift&terraform_version=terraform_v1.3)

The following options use the [secure-kube-toolchain template](https://github.com/open-toolchain/secure-kube-toolchain), which uses a Tekton pipeline structure.

[!
ibmcloud schematics workspace new --file FILE_NAME --state STATE_FILE_PATH [--agent-id AGENT_ID] [--github-token GITHUB_TOKEN] [--output OUTPUT] [--json]

For more information about the flags see [workspace new](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-reference&interface=clischematics-workspace-new) command.

Example

ibmcloud schematics workspace new --file FILE_NAME --state STATE_FILE_PATH





 ibmcloud schematics workspace get with Agent 

Retrieve the details of an existing workspace, including the values of all input variables and Schematics Agent.

Syntax

ibmcloud schematics workspace get --id WORKSPACE_ID [--output OUTPUT]

For more information about the flags see [workspace get](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-reference&interface=clischematics-workspace-get) command.







 Blueprint commands 

Schematics Blueprints is a [beta feature](https://cloud.ibm.com/docs/schematics?topic=schematics-bp-beta-limitations) that is available for evaluation and testing purposes. It is not intended for production usage. Refer to the list of [limitations](https://cloud.ibm.com/docs/schematics?topic=schematics-bp-beta-limitationssc-bp-beta-limitation) for the beta release.



 ibmcloud schematics blueprint create 

Create a blueprint config from the command line using the ibmcloud schematics blueprint create command. Creating a blueprint config is the first step to deploy a blueprint environment. The blueprint config is created from user provided parameters via the command line that specifies the source of the blueprint template in a Git repository, and input values sourced from Git hosted input files and locally sourced input values.
* UI
* API







 Protecting Schematics services with context-based restrictions 

Context-based restrictions give account owners and administrators the ability to define and enforce access restrictions for IBM Cloud® resources based on the context of access requests. Access to Schematics services can be controlled using [context-based restrictions (CBR)](https://cloud.ibm.com/context-based-restrictions/overview) and Identity and Access Management (IAM) policies.



 Managing CBR settings 

With [context-based restrictions](https://cloud.ibm.com/docs/account?topic=account-context-restrictions-whatis), you can define and enforce user and service access restrictions to Schematics based on specified criteria, for example IP address or IBM Cloud® resources or services.

To restrict access, you must be the account owner or have an access policy with the administrator role on all account management services.





 Overview 

To restrict access to Schematics, you create [network zones](https://cloud.ibm.com/docs/account?topic=account-context-restrictions-create&interface=uinetwork-zones-create) that contain the IP addresses and services that you desire to grant access. Then apply these using [rules](https://cloud.ibm.com/docs/account?topic=account-context-restrictions-create&interface=uicontext-restrictions-create-rules).

First, create a network zone containing the network IP addresses, VPCs, resources or services that you require to access Schematics. Then, attach that zone to Schematics to restrict access. You can create zones and rules by using a RESTful [API](https://cloud.ibm.com/apidocs/context-based-restrictionsintroduction) or with [context-based restrictions UI](https://cloud.ibm.com/context-based-restrictions/overview). After you create or update a zone or a rule, it might take a few minutes for the change to take effect.

You need to allowlist Schematics in the CBR rules for other services if you require Schematics to connect to the service to perform post-configuration of service resources, for instance IBM Cloud® PostgreSQL Database.
* [Accessing the IBM Cloud and GitHub](https://cloud.ibm.com/docs/schematics?topic=schematics-workspace-continuous-deploymentaccess-automate-template)
* [Creating your IBM Cloud Schematics Workspace](https://cloud.ibm.com/docs/schematics?topic=schematics-workspace-continuous-deploymentcreate-wkspace)
* [Configuring variables](https://cloud.ibm.com/docs/schematics?topic=schematics-workspace-continuous-deploymentconfigure-the-variables)
* [Automating the continuous deployment process](https://cloud.ibm.com/docs/schematics?topic=schematics-workspace-continuous-deploymentcontinuous-deployment)
* [Analyzing the pipeline execution process](https://cloud.ibm.com/docs/schematics?topic=schematics-workspace-continuous-deploymentanalyze-deployment)
* [Analyzing the Schematics Workspace](https://cloud.ibm.com/docs/schematics?topic=schematics-workspace-continuous-deploymentanalyze-workspace-process)
* [What's next?](https://cloud.ibm.com/docs/schematics?topic=schematics-workspace-continuous-deploymentautomate-what-next)







 Importing Schematics templates into the IBM Cloud catalog 

[Importing Schematics templates into the IBM Cloud catalog](https://cloud.ibm.com/docs/schematics?topic=schematics-private-catalogprivate-catalog)



* [Objectives](https://cloud.ibm.com/docs/schematics?topic=schematics-private-catalogprivate-tut-obj)
* [Time required](https://cloud.ibm.com/docs/schematics?topic=schematics-private-catalogprivate-timereq)
* UI
* CLI
* API







 Creating a workspace 

With IBM Cloud® Schematics workspaces, you can manage the Terraform-based templates to create and manage IBM Cloud resources. A workspace allows you to view and update configuration properties, view the list of resources that are provisioned through the workspace, and clean up resources if and when needed.



 Creating a workspace using the UI 



1. Log in to the [IBM Cloud catalog](https://cloud.ibm.com/catalog) by using your unique credentials.
2. In the Software section, select Compute and then select the IBM Spectrum Symphony tile.
3. In the Configure your workspace section:



* Specify the Name for your Schematics workspace
* Select a Resource group
* Define any Tags that you want to associate with the resources provisioned through the offering. The tags can later be used to query the resources in the IBM Cloud console.



4. In the Set the deployment values section, specify the values for the required properties: api_key, ssh_key_name, ibm_customer_number, and zone.
5. Expand the Optional deployment values section, and review it to determine whether you need to override any of the default values provided for the configuration properties.
6. Review and accept the IBM Spectrum Symphony license terms and conditions in the order summary.
7. Click Install. The Schematics workspace is created with the name you specified. You can see the list of workspaces in View the existing installations. If the workspace creation is successful, the Apply Plan action is started to trigger the deployment of the respective IBM Cloud VPC resources in your IBM Cloud account that are linked with the api_key.
8. You can also review the status of your deployment process by identifying the workspace name in the View the existing installations section. When you click a record in View the existing installations section, you are taken to the Schematics workspace view.







 Next steps
* [26 April 2022](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-relnotesschematics-apr2622)



* Release Schematics command-line plug-in



* [17 April 2022](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-relnotesschematics-apr2722)



* Release Schematics command-line plug-in



* [18 April 2022](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-relnotesschematics-apr1822)



* Support array of injectable Terraform blocks in create workspace API
* Release Schematics command-line plug-in



* [12 April 2022](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-relnotesschematics-apr3122)



* Schematics command-line supports private Schematics endpoint
* Support .JSON and .tfvars file extension for Schematics plan and apply commands
* Enhance resources tabular data view for resources.
* Deprecate and warning message when using ibmcloud terraform command.
* Release Schematics command-line plug-in





* [March 2022](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-relnotesschematics-mar22)



* Review the release notes for March 2022.
* [31 March 2022](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-relnotesschematics-mar3122)



* Support deleting Schematics data objects
* Fixes related to Schematics Actions and workspace
* Get job files API supports plan_json file type
Schematics Agents is a [beta feature](https://cloud.ibm.com/docs/schematics?topic=schematics-agent-beta-limitations) that are available for evaluation and testing purposes. It is not intended for production usage. Refer to the list of [limitations for Agents](https://cloud.ibm.com/docs/schematics?topic=schematics-agent-beta-limitations) in the beta release.



 Using Schematics Agent 

You have successfully connected the Agent to Schematics service instance. The next step is to bind your Schematics Workspaces to the Agent.

Once you bind the workspace to the Agent, then the corresponding workspace Jobs such as terraform plan, terraform apply, or terraform destroy is automated to route to the Agent.

In other words, the Terraform automation runs in your provisioned Agent infrastructure (cluster). Then the Schematics Workspace bounds to the Agent in the following ways:



* Bind an new workspace to the Agent When you bind the new workspace to the Agent, the Terraform templates are downloaded from the Git repositories by using Sandbox jobs that run in your Agent infrastructure (cluster). Further, the Terraform jobs are also run in your cluster.
* Bind the existing workspace to the Agent When you bind an existing workspace to the Agent, the Terraform templates may be downloaded by the shared Schematics service instance. However, the subsequent template operations such as, update the terraform template from the Git repositories will be done by using the Sandbox jobs that run in your Agent infrastructure (cluster). Further, the Terraform jobs are also run in your Cluster.





 Steps to Bind an existing workspace to the Agent 



1. Log in to your [IBM Cloud](https://cloud.ibm.com/) account by using your credentials.
2. Navigate to Schematics > Agents.
3. Select your Agent from the list, and use the ... dots to perform Bind Agent operation.
4. In the side navigation pane, select workspaces to be bound statically to the Agent.
5.
Modern web application using MEAN stack 

This tutorial may incur costs. Use the [Cost Estimator](https://cloud.ibm.com/estimator/review) to generate a cost estimate based on your projected usage.

This tutorial walks you through the creation of a web application using the popular MEAN stack. It is composed of a MongoDB, Express web framework, Angular front end framework and a Node.js runtime. You will learn how to run a MEAN sample app locally, create and use a managed database-as-a-service (DBasS), deploy the app to IBM Cloud and scale both the runtime and database resources.



 Objectives 



* Create and run a sample Node.js app locally.
* Create a managed Databases for MongoDB instance.
* Deploy the Node.js app to the cloud using Code Engine.
* Scale runtime CPU and memory resources.
* Scale database memory and disk resources.



Zoom

![Architecture diagram](https://cloud.ibm.com/docs-content/v1/content/f84e2238288b7f0355715a4c355609ce7ac48fb0/solution-tutorials/images/solution7/Architecture.svg)

Figure 1. Architecture diagram of the tutorial



1. The user accesses the application using a web browser.
2. The Node.js app running in Code Engine accesses the Databases for MongoDB database to fetch data.







 Before you begin 

This tutorial requires:



* IBM Cloud CLI - This CLI tool will enable you to interact with IBM Cloud.



* code-engine/ce plugin (code-engine/ce) v 1.29.1 or higher - Plugins extend the capabilities of the IBM Cloud CLI with commands specific to a service. The Code Engine plugin will give you access to Code Engine commands on IBM Cloud.
* Optional Container Registry plugin (container-registry)



* git to clone source code repository.