vania-janet/multiturn-rag-retrieval-data huggingface dataset:
The default value is Dockerfile.

--build-git-repo-secret, --git-repo-secret, --bgrs, --grs, --repo
: The name of the SSH secret, which contains the credentials to access the private repository that contains the source code to build your container image. To create this SSH secret, use the secret create --format SSH command. An SSH secret is also used as a Git repository access secret. This option is allowed only if the --build-source option is set to the URL of a Git repository. This value is optional.

--build-size, --size, --bsz, --sz
: The size for the build, which determines the amount of resources used. Valid values are small, medium, large, xlarge. For details, see [Determining the size of the build](https://cloud.ibm.com/docs/codeengine?topic=codeengine-plan-buildbuild-size). The build size option is allowed only if the --build-source option is set. This value is optional. The default value is medium.

--build-source, --source, --bsrc, --src
: The URL of the Git repository or the path to local source that contains your source code; for example https://github.com/IBM/CodeEngine or .. This value is optional.

--build-strategy, --strategy, --bstr, --str
: The strategy to use for building the image. Valid values are dockerfile and buildpacks. The build strategy option is allowed only if the --build-source option is set. If not specified, the build strategy is determined by Code Engine if --build-source is specified and the source is on your local machine. This value is optional. The default value is dockerfile.

--build-timeout, --bto
: The amount of time, in seconds, that can pass before the build must succeed or fail.
--source-protocol <source-protocol> Enter the protocol that the source must use to connect to the destination resource. Supported protocols include tcp, tls, http, https, and http-tunnel. For more information, see [Endpoint protocols](https://cloud.ibm.com/docs/satellite?topic=satellite-link-location-cloudlink-protocols). 
 --sni <sni> Optional. If you specify a tls or https source protocol and want a separate hostname to be added to the TLS handshake, include the server name indicator. 



3. Wait a few minutes for the Satellite Link connector component to assign a port to your endpoint.
4. Verify that your endpoint is created. In the output, copy the host name for your Satellite Link tunnel server and the port for your endpoint in the Address field.

ibmcloud sat endpoint ls --location <location_ID>

Example output

ID Name Destination Type Address
c0mnbnkw0jl8si22djkg_cEomQ openshift-api-c0mpnn4w0bv28oq2dks0 location TCP c-02.us-east.link.satellite.cloud.ibm.com:32823
c0mnbnkw0jl8si22djkg_6UTZd satellite-healthcheck-c0mnbnkw0jl8si22djkg location HTTP c-02.us-east.link.satellite.cloud.ibm.com:32822
5. From your source client in the IBM Cloud private network, test the connection to your Satellite endpoint by using the address. For example, depending on your source client, you might send a curl request to the endpoint.

curl http://<linkserver_hostname>:<port>







 Setting up source lists to limit access to endpoints 

Control which clients can access destination resources by creating a source list for an endpoint.

If no sources are configured, any client can use an endpoint to connect to the destination resource.
"srchostname" : "example.ibm.com",
"srcport" : "1433",
"srctype" : "MSSQLServer",
"status" : "string",
"usr" : "DV-user",
"uri" : "example.ibm.com:1433/"
} ]
} ]
}







 ibmcloud watson-query datasource-connection-add 

Adds a data source connection to the watson query service.

ibmcloud watson-query datasource-connection-add --datasource-type DATASOURCE-TYPE --name NAME --origin-country ORIGIN-COUNTRY --properties PROPERTIES [--asset-category ASSET-CATEGORY]



 Command options 

--datasource-type (string)
: The type of data source that you want to add. Required.

--name (string)
: The name of data source. Required.

--origin-country (string)
: The country of data source that you want to add which data originated from ISO 3166 Country Codes. Required.

--properties ([PostDatasourceConnectionParametersProperties](https://cloud.ibm.com/docs/cli?topic=cli-CLI-namecli-post-datasource-connection-parameters-properties-example-schema))
: Database information. Example: "{"database":"db1","host":"databases.example.com", "password":"adminpassword", "port":"31365", "ssl":"true", "username":"admin"}". Required.

--asset-category (string)
: The asset category. Allowable values: [user,system].





 Examples 

Add datasource connections
The default value is name.





 Example 

ibmcloud ce subscription cron list





 Example output 

Listing cron sources...
OK

Name Age Ready Destination Schedule Data
mycronevent 96m true http://myapp.cd4200a7-5037.svc.cluster.local /2 * * * 







 ibmcloud ce subscription cron update 

Update a cron event subscription.

ibmcloud ce subscription cron update --name CRON_SOURCE_NAME [--content-type CONTENT_TYPE] [--data DATA] [--data-base64 DATA_BASE64] [--destination DESTINATION] [--destination-type DESTINATION_TYPE] [--extension EXTENSION] [--extension-rm EXTENSION_RM] [--output OUTPUT] [--path PATH] [--quiet] [--schedule SCHEDULE] [--time-zone TIME_ZONE]



 Command Options 

--name, -n
: The name of the cron event subscription. This value is required.

--content-type, --ct
: The media type of the --data or --data-base64 option. Examples include application/json, application/x-www-form-urlencoded, text/html, and text/plain. This value is optional.

--da, --data
: The data to send to the destination; for example, '{ "message": "Hello world!" }'. If you specify the --data option, do not use the --data-base64 option.

This value is optional.

--data-base64, --db
: The base64-encoded data to send to the destination; for example, Q29kZSBFbmdpbmU=. If you specify the --data-base64 option, do not use the --data option. This value is optional.

--destination, -d
: The name of the application or job resource that you want to receive events; for example, myapp. If needed, use the --path option to further qualify an app destination. This value is optional.
This option is allowed only if the --build-source option is set to the URL of a Git repository on this job update command, or your job currently has an associated build from a Git repository source. This value is optional.

--build-git-repo-secret-clear, --git-repo-secret-clear, --bgrsc, --grsc
: Clear the SSH secret. This option is allowed if your job currently has an associated build. This value is optional. The default value is false.

--build-size, --size, --bsz, --sz
: The size for the build, which determines the amount of resources used. Valid values are small, medium, large, xlarge. For details, see [Determining the size of the build](https://cloud.ibm.com/docs/codeengine?topic=codeengine-plan-buildbuild-size). The build size option is allowed only if the --build-source option is set on this job update command, or your job currently has an associated build. This value is optional. The default value is medium.

--build-source, --source, --bsrc, --src
: The URL of the Git repository or the path to local source that contains your source code; for example https://github.com/IBM/CodeEngine or .. This value is optional.

--build-strategy, --strategy, --bstr, --str
: The strategy to use for building the image. Valid values are dockerfile and buildpacks. The build strategy option is allowed only if the --build-source option is set on this job update command, or your job currently has an associated build. If not specified, the build strategy is determined by Code Engine if --build-source is specified and the source is on your local machine. This value is optional. The default value is dockerfile.

--build-timeout, --bto
Working with data sources 

Note: If the database that you use is case-sensitive, then make sure to use the correct casing in IBM® Cognos Dashboard Embedded.



 Adding new data sources with the addSource() method 

You can add a new data source to a dashboard in Cognos Dashboard Embedded, by calling the addSources() method:

dashboardAPI.addSources([{
module: sampleModule,
name: 'Test Source',
id: 'myUniqueId123'
}])



The name is how the data source appears in the metadata tree, in the dashboard source pane.

The id can be anything that you want. Use the ID to reference the data source in other method calls. For example, in the updateModuleDefinitions() method.

The module is where the data source location, credentials, and format are described. The module is passed as a JavaScript object that conforms to the following schema:

<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed Materials - Property of IBM

(C) Copyright IBM Corp. 2018

US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
-->
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified" version="1.0">
<xsd:element name="module">
<xsd:annotation>
<xsd:documentation>The single table module.</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="xsd" type="xsd:string">
<xsd:annotation>
* [Create and work with a project](https://cloud.ibm.com/docs/codeengine?topic=codeengine-manage-project).
* [Create an SSH secret to access your source](https://cloud.ibm.com/docs/codeengine?topic=codeengine-code-repositories).
* [Create a registry secret so you can save your image](https://cloud.ibm.com/docs/codeengine?topic=codeengine-add-registry).





1. Run a build to build an image from a private repo and specify the location of the image registry for the build output with a registry secret. The following example buildrun submit command runs a build run that is called helloworld-buildrun-private2 that builds from the private Git repo https://github.com/myprivaterepo/builds, and stores the image to us.icr.io/mynamespace/codeengine-helloworld by using the myregistry registry secret to access this registry.

ibmcloud ce buildrun submit --name helloworld-buildrun-private2 --image us.icr.io/mynamespace/codeengine-helloworld --registry-secret myregistry --source git@github.com:myprivaterepo/builds.git --context-dir /hello --strategy buildpacks --git-repo-secret myrepossh



* This example command uses the buildpacks strategy and the default medium build size.
* Because the Git repo provided is private, access requires an SSH secret. An SSH secret is also used as a Git repository access secret. As a result, the --source that you specify must use the SSH protocol, such as git@github.com:myprivaterepo/builds.git. The value for --source must not use the http or https format.
* Because the branch name of the repository is not specified with the --commit option, Code Engine automatically uses the default branch of the specified repository.
"srchostname" : "example.ibm.com",
"srcport" : "1433",
"srctype" : "MSSQLServer",
"status" : "string",
"usr" : "DV-user",
"uri" : "example.ibm.com:1433/"
} ]
} ]
}







 ibmcloud watson-query datasource-connection-add 

Adds a data source connection to the watson query service.

ibmcloud watson-query datasource-connection-add --datasource-type DATASOURCE-TYPE --name NAME --origin-country ORIGIN-COUNTRY --properties PROPERTIES [--asset-category ASSET-CATEGORY]



 Command options 

--datasource-type (string)
: The type of data source that you want to add. Required.

--name (string)
: The name of data source. Required.

--origin-country (string)
: The country of data source that you want to add which data originated from ISO 3166 Country Codes. Required.

--properties ([PostDatasourceConnectionParametersProperties](https://cloud.ibm.com/docs/watson-query-cli-plugincli-post-datasource-connection-parameters-properties-example-schema))
: Database information. Example: "{"database":"db1","host":"databases.example.com", "password":"adminpassword", "port":"31365", "ssl":"true", "username":"admin"}". Required.

--asset-category (string)
: The asset category. Allowable values: [user,system].





 Examples 

Add datasource connections
After editing the template push it back to the Git repo to make it available to be deployed by Schematics.

Within VSCode, click on the “Source Control” button in the Activity Bar. It’s located on the side of VS Code’s client. Alternatively, you can use the keyboard shortcut Ctrl+Shift+G or Ctrl+Shift+G on MacOS to open the Source Control screen.



* Enter a commit message
* Click Commit
* Click Sync changes



In this example it is assumed that both the template and input file are in the same Git repo.

The blueprint template and inputs are now ready for deploying in Schematics.







 Next steps 

After pushing your initial template or update, a Git release of the template and input file can be created to enforce version control of changes. See the [Github](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) or [Gitlab](https://docs.gitlab.com/ee/user/project/releases/) documentation for creating versioned blueprints releases.

Review the section Blueprint versioning{/docs/schematics?topic=schematics-blueprint-versioning} to understand more about versioning blueprint environments.

The next stage of working with your blueprint is [deploying blueprints](https://cloud.ibm.com/docs/schematics?topic=schematics-deploy-blueprints).
While migrating your code to use the new [Key Policies](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/data-sources/kms_key_policies), please refrain from using the existing resource unless setting the [Lifecycle "ignore" policies block](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/kms_keylifecycle-ignore-block-example). As part of continued migration and improvement, the algorithmBitSize, algorithmMode, algorithmType and algorithmMetadata fields will no longer be operational within the Key Protect [API](https://cloud.ibm.com/apidocs/key-protect).





 08 September 2021 

Announcing Key Protect support for IBM Cloud® Provider Plug-in for Terraform enhancements
: [IBM Cloud® Provider Plug-in for Terraform](https://cloud.ibm.com/docs/schematics) now supports creating and retrieving [Key Policies](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/data-sources/kms_key_policies) when creating and retrieving keys through IBM Cloud Provider Plug-in for Terraform as a separate resource.





 04 September 2021 

Announcing Key Protect CLI plug-in v.0.6.5
: The [release of Key Protect CLI version 0.6.5](https://cloud.ibm.com/docs/key-protect?topic=key-protect-cli-changelog) introduces new structures for empty results when querying. Learn more at [the CLI reference](https://cloud.ibm.com/docs/key-protect?topic=key-protect-key-protect-cli-reference).







 August 2021 



 05 August 2021 

Announcing Key Protect support for key purge enhancements
: The ability to purge keys that have been deleted after four hours using the UI has been added.
extension The name of your extension. For this use case, the extension is named premfa. 
 device_type The type of device with which your user is accessing your application. Options include: web and mobile. 
 source_ip The IP address of the device that makes the request to your app. For example, 127.0.0.1. 
 headers The information that is returned by the browser when a user attempts to sign in to your app. The header looks similar to: {"user-agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0"}. 
 tenant_id Your application's tenant ID. 
 client_id Your application's client ID. 
 user_id The ID of the user that makes the authentication request. For example, 11112222-3333-4444-2222-555522226666. 
 username The username of the user that makes the authentication request. For example, testuser@email.com. 
 application_type The type of your application. For example, if your application is a single page JavaScript web app, browserapp is returned. Options include: browserapp, serverapp, and mobileapp. 
 first_name The users given name. 
 last_name The users surname. 
 last_successful_first_factor The date of the last time the user correctly entered their credentials. For example, 1660032586651. 
 last_successful_mfa The date of the last time the user completed the full MFA flow. For example, 1660032586651. 



To see an example extension, check out [the sample](https://github.com/ibm-cloud-security/appid-sample-code-snippets/blob/master/premfa-extension-point/index.js).
3. Register your extension with your instance of App ID by making a PUT request to config/cloud_directory/mfa/extensions/premfa. The configuration includes your extension's URL and any authorization information that is needed to access the endpoint.
modules.source options 

The version control source library where the Terraform config, or Ansible playbook are located.

source:
source_type: github
git:
git_repo_url: "https://github.com/Cloud-Schematics/blueprint-example-modules/tree/main/IBM-ResourceGroup"





 modules.source.source_type 

Type: string

Required: true

Type of Git source repository.

Options: git, catalog







 modules.source.git.git_repo_url 

Type: url string

Required: true

URL for the Terraform module or config in its content repository. This is the full path to the module, in the root folder of the repo or the path to a module in sub-folder in the repo. Multiple modules/configs can exist in sub-folders of the repo. "https://github.com/Cloud-Schematics/blueprint-example-modules/IBM-ResourceGroup"

Blueprints supports using the Git object path syntax to specifying the URL to your module, using the tree/<branch> syntax, including the branch and sub-folders. https://github.com/Cloud-Schematics/blueprint-example-modules/tree/main/IBM-ResourceGroup

Example

git:
git_repo_url: "https://github.com/Cloud-Schematics/blueprint-example-modules/tree/main/IBM-ResourceGroup"





 modules.source.git.git_branch 

Type: string

Default: main

git_release





 modules.source.git.git_release 

Type: string

Default: implicitly latest

If content type is git, the release tag of the version of the Terraform config or module to be used. This option is mutually exclusive with the git_branch option. If not specified, Schematics will default to always pulling the latest commit during a blueprint update operation.
Protocol Source Type Source Value 

 TCP Any <cidr_range> 3389 
 UDP Any <cidr_range> 3389 
 ICMP Any <cidr_range> Type: 8, Code: Any 



Then, configure outbound rules that allow all TCP traffic:



Table 2. Configuration information for outbound rules

 Protocol Destination Type Source Value 

 TCP Any <cidr_range> Any port 



4. Make sure that you reserve and associate a floating IP address to your Windows instance.







 Connecting to your Windows instance 

After you create your Windows instance and complete the prerequisites, complete the following steps to connect to your Windows instance.



1. Query the status of your instance by running the following command. INSTANCE is the ID or Name for the instance that you want to connect:

ibmcloud is instance INSTANCE

When the instance shows that it's running, you are ready to retrieve the initialization values to get your password.
2. Run the following command to initialize your instance and obtain your instance password. Specify your instance ID or Name for the INSTANCE variable and your private key for the KEY or KEY_FILE variable:

ibmcloud is instance-initialization-values INSTANCE [--private-key (KEY | @KEY_FILE)]

This command decodes and decrypts your password, which is automatically generated when you create an instance by using a Windows image. The password is decoded and decrypted based on the public SSH Key that you used at instance create time and the associated private SSH key that you specify in the instance-initialization-values command. For more information, see the [CLI command reference](https://cloud.ibm.com/docs/vpc?topic=vpc-infrastructure-cli-plugin-vpc-referenceinstance-initialization-values).

The following command shows example usage for the instance-initialization-values command where 0xx4e27x-33xx-4e7x-a08b-bexx2ac3xx0c is the instance ID and /.ssh/id_rsa is the location of the user's private key file:
The following output shows the result of the function get command for this example, including information about the build.

Example output

Getting function 'kerstenrepofunction'...
OK

Name: myfun
Project Name: sample
Project ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
Age: 27m
Created: 2023-06-27T21:07:26Z
URL: https://myfun.13c66hbi3rhz.us-south.codeengine.test.appdomain.cloud
Status: Ready

Resources:
CPU: 0.25
Memory: 500M
Max Execution Time: 60 seconds

Build Information:
Build Run Name: myfun-run-230111-111212718
Build Type: git
Build Strategy: codebundle-nodejs-18
Timeout: 600
Source: https://github.com/IBM/CodeEngine
Context Directory: /helloworld-samples/function-nodejs

Build Run Summary: Succeeded
Build Run Status: Succeeded
Build Run Reason: All Steps have completed executing
Run 'ibmcloud ce buildrun get -n myfun-run-230111-111212718' for details.

Function Code:
Runtime: nodejs-18 (managed)
Bundle Secret: ce-auto-icr-us-south
Code Bundle: cr://icr.io/ce--abcde-glxo4kabcde/function-myfun:230111-1532-vwo4o
Main: main()

Now that your function is created from repository source code, you can update the function to meet your needs by using the [ibmcloud ce function update](https://cloud.ibm.com/docs/codeengine?topic=codeengine-clicli-function-update) command. If you want to update your source to use with your function, you must provide the --build-source option on the function update command.
"srchostname" : "example.ibm.com",
"srcport" : "1433",
"srctype" : "MSSQLServer",
"status" : "string",
"usr" : "DV-user",
"uri" : "example.ibm.com:1433/"
} ]
} ]
}







 ibmcloud watson-query datasource-connection-add 

Adds a data source connection to the watson query service.

ibmcloud watson-query datasource-connection-add --datasource-type DATASOURCE-TYPE --name NAME --origin-country ORIGIN-COUNTRY --properties PROPERTIES [--asset-category ASSET-CATEGORY]



 Command options 

--datasource-type (string)
: The type of data source that you want to add. Required.

--name (string)
: The name of data source. Required.

--origin-country (string)
: The country of data source that you want to add which data originated from ISO 3166 Country Codes. Required.

--properties ([PostDatasourceConnectionParametersProperties](https://cloud.ibm.com/docs/watson-query-cli-plugin?topic=watson-query-cli-plugin-CLI-namecli-post-datasource-connection-parameters-properties-example-schema))
: Database information. Example: "{"database":"db1","host":"databases.example.com", "password":"adminpassword", "port":"31365", "ssl":"true", "username":"admin"}". Required.

--asset-category (string)
: The asset category. Allowable values: [user,system].





 Examples 

Add datasource connections