copyright

lastupdated

keywords

subcollection

years
2021

2021-09-01

api reference, api, Kubernetes configuration and code engine, CRD for code engine, CRD, custom resource definition, guid, kubernetes, authenticate, code engine api

codeengine

{:DomainName: data-hd-keyref="APPDomain"} {:DomainName: data-hd-keyref="DomainName"} {:android: data-hd-operatingsystem="android"} {:api: .ph data-hd-interface='api'} {:apikey: data-credential-placeholder='apikey'} {:app_key: data-hd-keyref="app_key"} {:app_name: data-hd-keyref="app_name"} {:app_secret: data-hd-keyref="app_secret"} {:app_url: data-hd-keyref="app_url"} {:audio: .audio} {:authenticated-content: .authenticated-content} {:beta: .beta} {:c#: .ph data-hd-programlang='c#'} {:c#: data-hd-programlang="c#"} {:cli: .ph data-hd-interface='cli'} {:codeblock: .codeblock} {:curl: #curl .ph data-hd-programlang='curl'} {:curl: .ph data-hd-programlang='curl'} {:deprecated: .deprecated} {:dotnet-standard: .ph data-hd-programlang='dotnet-standard'} {:download: .download} {:external: .external target="_blank"} {:external: target="_blank" .external} {:faq: data-hd-content-type='faq'} {:fuzzybunny: .ph data-hd-programlang='fuzzybunny'} {:generic: data-hd-operatingsystem="generic"} {:generic: data-hd-programlang="generic"} {:gif: data-image-type='gif'} {:go: .ph data-hd-programlang='go'} {:help: data-hd-content-type='help'} {:hide-dashboard: .hide-dashboard} {:hide-in-docs: .hide-in-docs} {:important: .important} {:ios: data-hd-operatingsystem="ios"} {:java: #java .ph data-hd-programlang='java'} {:java: .ph data-hd-programlang='java'} {:java: data-hd-programlang="java"} {:javascript: .ph data-hd-programlang='javascript'} {:javascript: data-hd-programlang="javascript"} {:middle: .ph data-hd-position='middle'} {:navgroup: .navgroup} {:new_window: target="_blank"} {:node: .ph data-hd-programlang='node'} {:note: .note} {:objectc: .ph data-hd-programlang='Objective C'} {:objectc: data-hd-programlang="objectc"} {:org_name: data-hd-keyref="org_name"} {:php: .ph data-hd-programlang='PHP'} {:php: data-hd-programlang="php"} {:pre: .pre} {:preview: .preview} {:python: .ph data-hd-programlang='python'} {:python: data-hd-programlang="python"} {:release-note: data-hd-content-type='release-note'} {:right: .ph data-hd-position='right'} {:route: data-hd-keyref="route"} {:row-headers: .row-headers} {:ruby: .ph data-hd-programlang='ruby'} {:ruby: data-hd-programlang="ruby"} {:runtime: architecture="runtime"} {:runtimeIcon: .runtimeIcon} {:runtimeIconList: .runtimeIconList} {:runtimeLink: .runtimeLink} {:runtimeTitle: .runtimeTitle} {:screen: .screen} {:script: data-hd-video='script'} {:service: architecture="service"} {:service_instance_name: data-hd-keyref="service_instance_name"} {:service_name: data-hd-keyref="service_name"} {:shortdesc: .shortdesc} {:space_name: data-hd-keyref="space_name"} {:step: data-tutorial-type='step'} {:step: data-tutorial-type='step'} {:subsection: outputclass="subsection"} {:support: data-reuse='support'} {:swift: #swift .ph data-hd-programlang='swift'} {:swift: .ph data-hd-programlang='swift'} {:swift: data-hd-programlang="swift"} {:table: .aria-labeledby="caption"} {:term: .term} {:terraform: .ph data-hd-interface='terraform'} {:tip: .tip} {:tooling-url: data-tooling-url-placeholder='tooling-url'} {:topicgroup: .topicgroup} {:troubleshoot: data-hd-content-type='troubleshoot'} {:tsCauses: .tsCauses} {:tsResolve: .tsResolve} {:tsSymptoms: .tsSymptoms} {:tutorial: data-hd-content-type='tutorial'} {:ui: .ph data-hd-interface='ui'} {:unity: .ph data-hd-programlang='unity'} {:url: data-credential-placeholder='url'} {:user_ID: data-hd-keyref="user_ID"} {:vbnet: .ph data-hd-programlang='vb.net'} {:video: .video}

API reference

{: #api}

You can use the {{site.data.keyword.codeenginefull}} API to create and manage your {{site.data.keyword.codeengineshort}} entities. To use the CLI, see Setting up the CLI. {: shortdesc}

Retrieve your Kubernetes configuration with REST API

{: #api-rest}

To retrieve your Kubernetes configuration with REST API,

Authenticate with {{site.data.keyword.iamlong}} (IAM) to receive an IAM access token.
Query the {{site.data.keyword.cloud_notm}} catalog and the {{site.data.keyword.cloud_notm}} Resource controller to receive a GUID for your project.
Use the {{site.data.keyword.codeenginefull_notm}} API to receive a Kubernetes configuration.

Authenticate with {{site.data.keyword.iamshort}}

{: #api-iam}

Create your {{site.data.keyword.cloud_notm}} IAM access token{: external} by making a POST request to https://iam.cloud.ibm.com/identity/token.

Determine the GUID of your {{site.data.keyword.codeengineshort}} project

{: #api-guid}

Determine the GUID of your {{site.data.keyword.codeengineshort}} project by querying the {{site.data.keyword.cloud_notm}} catalog and the {{site.data.keyword.cloud_notm}}. As this GUID does not change, you need to do this step only one time. If you already know your {{site.data.keyword.codeengineshort}} project GUID, you can skip this step.

CLI

Log in into {{site.data.keyword.cloud_notm}} and target a region, account, and resource group.
```
ibmcloud login target -r REGION -c ACCOUNT_ID -g RESOURCE_GROUP
```
{: pre}

Run the ibmcloud resource command.

ibmcloud resource service-instances --service-name codeengine --long

{: pre}

Identify the service instance that represents your {{site.data.keyword.codeengineshort}} project and determine the GUID from the output.

REST API

Before you begin, you must have the access_token from the previous step.

Use following {{site.data.keyword.cloud_notm}} catalog API method: Returns parent catalog entries{: external}.

Example
```
curl -X GET \
  'https://globalcatalog.cloud.ibm.com/api/v1?include=*&q=name:codeengine+active:true" \
  -H 'Authorization: Bearer ACCESS_TOKEN'
```
{: pre}

Identify the unique resource ID in the resources list. The field name is ID and the JSON path is resources[].id.
Query the {{site.data.keyword.cloud_notm}} Resource controller with the {{site.data.keyword.cloud_notm}} Resource controller API method Get a list of all resource instances{: external}. You must have the {{site.data.keyword.codeengineshort}} project name, the region that your project resides, and the unique resource ID of {{site.data.keyword.codeengineshort}} in the global catalog. Use the name of your {{site.data.keyword.codeengineshort}} project as the query parameter.

Example
```
curl -X GET \
    'https://resource-controller.cloud.ibm.com/v2/resource_instances?name=MY_PROJECT&resource_id=RESOURCE_ID' \
    -H 'Authorization: Bearer ACCESS_TOKEN'
```
{: pre}

Identify the {{site.data.keyword.codeengineshort}} project from your region in the result list. Find the guid output to use in the next steps.

Query the IBM {{site.data.keyword.codeengineshort}} API

{: #api-query-api}

Before you begin, you must have the following information.

The access_token and refresh_token from previous steps.
The guid of your {{site.data.keyword.codeengineshort}} project.
The region in which your {{site.data.keyword.codeengineshort}} project is located.

Use the get kubeconfig for the specified project{: external} {{site.data.keyword.codeengineshort}} API method to get the Kubernetes configuration.

Example

curl -X GET \
    'https://resource-controller.cloud.ibm.com/v2/resource_instances?name=MY_PROJECT&resource_id=RESOURCE_ID' \
    -H 'Authorization: Bearer ACCESS_TOKEN'

{: pre}

Retrieving your Kubernetes configuration with the {{site.data.keyword.codeengineshort}} CLI

{: #api-cli}

Log in into {{site.data.keyword.cloud_notm}} and target a region, account, and resource group.
```
ibmcloud login target -r REGION -c ACCOUNT_ID -g RESOURCE_GROUP
```
{: pre}
Create your {{site.data.keyword.codeengineshort}} project:
```
ibmcloud ce project create --name PROJECT 
```
{: pre}
Select your {{site.data.keyword.codeengineshort}} project as the current context and append the project to the default Kubernetes configuration file.
```
ibmcloud ce project select --name PROJECT --kubecfg
```
{: pre}

Now you are ready to use kubectl commands with your project.

For more information about using {{site.data.keyword.codeengineshort}} APIs, Kubernetes API, and kubectl, see the following topics,

{{site.data.keyword.codeengineshort}} API{: external}
Kubernetes REST API{: external}
Kubernetes API concepts{: external}
API client libraries{: external}
kubectl command{: external}

Custom resource definition (CRD)

{: #api-crd}

The following sections list the custom resource definition methods to use with {{site.data.keyword.codeengineshort}}.

Batch CRD methods

{: #api-crd-batch}

Group	Version	Kind
`codeengine.cloud.ibm.com`	v1beta1	`JobDefinition`
`codeengine.cloud.ibm.com`	v1beta1	`JobRun`
{: caption="Batch CRDs for {{site.data.keyword.codeengineshort}}" caption-side="top"}

After you retrieve the Kubernetes configuration, you can view Batch CRD details by using the following methods.

Use kubectl explain --api-version='codeengine.cloud.ibm.com/v1beta1' <Kind>.
Download Swagger or OpenAPI specification of CRDs{: external}.

Note that you cannot delete a job run without also deleting any associated pods. Any attempt to delete with the propagationPolicy=Orphan option is rejected.

Serving CRD methods

{: #api-crd-serving}

Group	Version	Kind
`serving.knative.dev`	v1	Configuration
`serving.knative.dev`	v1	Revision
`serving.knative.dev`	v1	Route
`serving.knative.dev`	v1	Service
{: caption="Serving CRDs for {{site.data.keyword.codeengineshort}}" caption-side="top"}

For more information about these CRDs, see Knative Serving API Specification{: external}.

Source-to-image CRD methods

{: #api-crd-s2i}

Group	Version	Kind
`shipwright.io`	v1alpha1	`Build`
`shipwright.io`	v1alpha1	`BuildRun`
{: caption="Source-to-image CRDs for {{site.data.keyword.codeengineshort}}" caption-side="top"}

After you retrieve the Kubernetes configuration, you can view the Source-to-image CRD details by using one of the following methods.

Use kubectl explain --api-version='shipwright.io/v1alpha1' <KIND>.
Download the Swagger or OpenAPI specification of CRDs{: external}.

Subscription CRD methods

{: #api-crd-subscription}

Group	Version	Kind
`sources.codeengine.cloud.ibm.com`	v1alpha1	`CosSource`
`sources.knative.dev`	v1	`PingSource`
{: caption="Subscription CRDs for {{site.data.keyword.codeengineshort}}" caption-side="top"}

After you retrieve the Kubernetes configuration, you can view the Subscription CRD details by using one of the following methods.

Use kubectl explain --api-version='sources.knative.dev/<VERSION>' <KIND>.
Download the Swagger or OpenAPI specification of CRDs{: external}.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

api.md

api.md

API reference

Retrieve your Kubernetes configuration with REST API

Authenticate with {{site.data.keyword.iamshort}}

Determine the GUID of your {{site.data.keyword.codeengineshort}} project

Query the IBM {{site.data.keyword.codeengineshort}} API

Retrieving your Kubernetes configuration with the {{site.data.keyword.codeengineshort}} CLI

Custom resource definition (CRD)

Batch CRD methods

Serving CRD methods

Source-to-image CRD methods

Subscription CRD methods

Files

api.md

Latest commit

History

api.md

File metadata and controls

API reference

Retrieve your Kubernetes configuration with REST API

Authenticate with {{site.data.keyword.iamshort}}

Determine the GUID of your {{site.data.keyword.codeengineshort}} project

Query the IBM {{site.data.keyword.codeengineshort}} API

Retrieving your Kubernetes configuration with the {{site.data.keyword.codeengineshort}} CLI

Custom resource definition (CRD)

Batch CRD methods

Serving CRD methods

Source-to-image CRD methods

Subscription CRD methods