Skip to content

Commit f079360

Browse files
foverbyGitHub Enterprise
authored and
GitHub Enterprise
committed
Merge pull request #183 from cloud-docs/next-prod-push
Next publish push
2 parents 36203e8 + f56ba1c commit f079360

File tree

96 files changed

+923
-989
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

96 files changed

+923
-989
lines changed

Diff for: about.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22

33
copyright:
4-
years: 2020, 2021
5-
lastupdated: "2021-12-21"
4+
years: 2020, 2022
5+
lastupdated: "2022-01-31"
66

77
keywords: benefits, terminology, developers, capabilities, code engine
88

@@ -31,7 +31,7 @@ Review the capabilities that {{site.data.keyword.codeengineshort}} provides to r
3131
| Private workloads | Store your source code in private repositories and push your images to private registries and {{site.data.keyword.codeengineshort}} can access them. |
3232
| Fully integrated | {{site.data.keyword.codeengineshort}} is fully integrated into IBM Cloud so that you can take advantage of the full catalog of IBM Cloud services. |
3333
| Event-driven workloads | Extend the functionality of your applications with messages (events) from event producers. Your application can then react to those events and perform actions based on them. |
34-
| Auto-scales - even to zero | {{site.data.keyword.codeengineshort}} automatically scales your workloads up and down, and even down to zero when no requests are active. You pay for only the resources that you consume. |
34+
| Autoscales - even to zero | {{site.data.keyword.codeengineshort}} automatically scales your workloads up and down, and even down to zero when no requests are active. You pay for only the resources that you consume. |
3535
| Control access | Assign platform and services access permissions to your projects in IBM Cloud Identity and Access Management to control who can provision and manage resources in your IBM Cloud account. |
3636
| Based on open source | {{site.data.keyword.codeengineshort}} is built on a set of open source technologies such as Kubernetes, Knative, Istio, and Tekton, keeping your apps and jobs portable. |
3737
{: caption="Table 1. {{site.data.keyword.codeengineshort}} benefits" caption-side="bottom"}

Diff for: add-registry.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22

33
copyright:
4-
years: 2020, 2021
5-
lastupdated: "2021-12-15"
4+
years: 2020, 2022
5+
lastupdated: "2022-02-02"
66

77
keywords: registries, container registry, image registry, apikey, API key, access token, images, registry access, service id
88

@@ -42,7 +42,7 @@ Public registries, such as public Docker Hub, can be used to get started with Do
4242
## Setting up authorities for image registries
4343
{: #authorities-registry}
4444

45-
if your registry is public, you do not have to set up authorities in order to pull images. Note that pulling images from a public registry while you are getting started with {{site.data.keyword.codeengineshort}} is acceptable, use a private registry when it comes to your enterprise workloads.
45+
If your registry is public, you do not have to set up authorities to pull images. Note that pulling images from a public registry while you are getting started with {{site.data.keyword.codeengineshort}} is acceptable. Use a private registry when it comes to your enterprise workloads.
4646

4747
**What authorities do I need?**
4848

@@ -52,7 +52,7 @@ When you deploy apps or run jobs from the console, {{site.data.keyword.codeengin
5252
|--------|-----------|---------------------|
5353
| Pull images | `Read` access | When you deploy an image as an application or job, you must pull the image from a registry. To pull images, you need `read` access. Note that if the repository is public, you already have `read` access to the images. |
5454
| Push images | `Read` and `write` access | When you build source code, you must push the image to a registry. To push images, you need `write` access to {{site.data.keyword.registryfull_notm}}. You cannot push images to a registry other than {{site.data.keyword.registryfull_notm}}. |
55-
| Create a namespace | `Read`, `write`, and `Manager` access | To create a namespace in {{site.data.keyword.registrylong_notm}}, you must have `manager` access. In order to pull and push images, you must have `read` and `write` access. |
55+
| Create a namespace | `Read`, `write`, and `Manager` access | To create a namespace in {{site.data.keyword.registrylong_notm}}, you must have `manager` access. To pull and push images, you must have `read` and `write` access. |
5656
{: caption="Access authorities for image registry" caption-side="top"}
5757

5858
**Can I use a service ID?**
@@ -111,7 +111,7 @@ Now that you created your API key, [save it as registry access](#add-registry-ac
111111

112112
To create an {{site.data.keyword.cloud_notm}} IAM API key with the CLI, run the [**`iam api-key-create`**](/docs/account?topic=cli-ibmcloud_commands_iam#ibmcloud_iam_api_key_create) command. For example, to create an API key called `cliapikey` with a description of "My CLI APIkey" and save it to a file called `key_file`, run the following command:
113113

114-
```sh
114+
```txt
115115
ibmcloud iam api-key-create cliapikey -d "My CLI APIkey" --file key_file
116116
```
117117
{: pre}
@@ -124,7 +124,7 @@ Now that you created your API key, [save it as registry access](#add-registry-ac
124124
## Accessing images in a shared account
125125
{: #images-shared-account}
126126

127-
In order to access images from {{site.data.keyword.registryfull_notm}} in a shared account, you must be assigned the [proper authority](#authorities-registry).
127+
To access images from {{site.data.keyword.registryfull_notm}} in a shared account, you must be assigned the [proper authority](#authorities-registry).
128128

129129
If you are planning to deploy apps and run jobs from the shared account, {{site.data.keyword.codeengineshort}} can pull or push images for you when you deploy your application or create your job.
130130

@@ -177,14 +177,14 @@ To add {{site.data.keyword.registryfull_notm}} or Docker Hub access with the CLI
177177

178178
For example, the following **`registry create`** command creates registry access to an {{site.data.keyword.registryfull_notm}} instance called `myregistry` that is on the `us.icr.io` registry server:
179179

180-
```sh
180+
```txt
181181
ibmcloud ce registry create --name myregistry --server us.icr.io --username iamapikey --password API_KEY
182182
```
183183
{: pre}
184184

185185
**Example output**
186186

187-
```sh
187+
```txt
188188
Creating image registry access secret 'myregistry'...
189189
OK
190190
```
@@ -210,7 +210,7 @@ When you create a service ID, you can restrict access to a regional {{site.data.
210210
### Authorizing access to {{site.data.keyword.registryshort}} with service ID from the console
211211
{: #authorize-console-service-id}
212212

213-
In order to pull or push images from or to {{site.data.keyword.registryfull_notm}}, you must create a service ID, create an access policy for the service ID, and then create an API key to store the credentials.
213+
To pull or push images from or to {{site.data.keyword.registryfull_notm}}, you must create a service ID, create an access policy for the service ID, and then create an API key to store the credentials.
214214

215215
#### Step 1 Create the service ID and authorize it to the {{site.data.keyword.registryfull_notm}} service
216216
{: #create-service-id}
@@ -252,19 +252,19 @@ Now that our service ID is created and is granting access to {{site.data.keyword
252252
5. Click **Add** and then **Assign**.
253253

254254

255-
Now that you have your access policies in place for your service ID and your API key created, you can [add access to {{site.data.keyword.codeengineshort}}](#add-registry-access-ce) in order to pull images from your container registry.
255+
Now that you have your access policies in place for your service ID and your API key created, you can [add access to {{site.data.keyword.codeengineshort}}](#add-registry-access-ce) to pull images from your container registry.
256256

257257
### Authorizing access to {{site.data.keyword.registryshort}} with the CLI
258258
{: #authorize-cr-cli}
259259

260-
In order to pull images from {{site.data.keyword.registryfull_notm}} in a different account, you must create a service ID, create access policies for the service ID, and then create an API key to store your credentials.
260+
To pull images from {{site.data.keyword.registryfull_notm}} in a different account, you must create a service ID, create access policies for the service ID, and then create an API key to store your credentials.
261261
{: shortdesc}
262262

263263
1. Create an {{site.data.keyword.cloud_notm}} IAM service ID for your project that is used for the IAM policies and API key credentials in the image pull secret with the **`iam service-id-create`** command. Be sure to give the service ID a description that helps you retrieve the service ID later, such as including the project name. For a complete listing of the **`iam service-id-create`** command and its options, see the [**`ibmcloud iam service-id-create`**](/docs/account?topic=cli-ibmcloud_commands_iam#ibmcloud_iam_service_id_create) command.
264264

265265
For example, the following command creates a service ID called `codeengine-myproject-id` with the description `Service ID for IBM Cloud Container Registry in {{site.data.keyword.codeengineshort}} project myproject`:
266266

267-
```sh
267+
```txt
268268
ibmcloud iam service-id-create codeengine-myproject-id --description "Service ID for IBM Cloud Container Registry in {{site.data.keyword.codeengineshort}} project my proj"
269269
```
270270
{: pre}
@@ -273,7 +273,7 @@ In order to pull images from {{site.data.keyword.registryfull_notm}} in a differ
273273
274274
For example, the following command creates a policy for `codeengine-myproject-id` service ID with the role of `Reader`:
275275
276-
```sh
276+
```txt
277277
ibmcloud iam service-policy-create codeengine-myproject-id --roles Reader --service-name container-registry
278278
```
279279
{: pre}
@@ -292,7 +292,7 @@ In order to pull images from {{site.data.keyword.registryfull_notm}} in a differ
292292
293293
For example, create a policy for `codeengine-myproject-id` service ID with the role of `Operator`:
294294
295-
```sh
295+
```txt
296296
ibmcloud iam service-policy-create codeengine-myproject-id --roles Operator --service-name iam-identity
297297
```
298298
{: pre}
@@ -311,14 +311,14 @@ In order to pull images from {{site.data.keyword.registryfull_notm}} in a differ
311311
312312
For example, the following command creates a key called `codeengine-myproject-key` for the `codeengine-myproject-id` service ID with a description of `API key for service ID codeengine-myproject-id for {{site.data.keyword.codeengineshort}} myproject`:
313313
314-
```sh
314+
```txt
315315
ibmcloud iam service-api-key-create codeengine-myproject-key codeengine-myproject-id --description "API key for service ID codeengine-myproject-id for {{site.data.keyword.codeengineshort}} myproject"
316316
```
317317
{: pre}
318318
319319
**Example output**
320320
321-
```sh
321+
```txt
322322
Please preserve the API key! It cannot be retrieved after it's created.
323323
324324
Name codeengine-myproject-key
@@ -334,4 +334,4 @@ In order to pull images from {{site.data.keyword.registryfull_notm}} in a differ
334334
You won’t be able to see this API key again, so be sure to record it in a safe place.
335335
{: important}
336336
337-
Now that you have your access policies in place for your service ID and your API key created, you can [add access to {{site.data.keyword.codeengineshort}}](#add-registry-access-ce) in order to pull images from your container registry.
337+
Now that you have your access policies in place for your service ID and your API key created, you can [add access to {{site.data.keyword.codeengineshort}}](#add-registry-access-ce) to pull images from your container registry.

Diff for: api.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22

33
copyright:
4-
years: 2021
5-
lastupdated: "2021-12-15"
4+
years: 2022
5+
lastupdated: "2022-02-02"
66

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

@@ -42,14 +42,14 @@ Determine the GUID of your {{site.data.keyword.codeengineshort}} project by quer
4242

4343
1. Log in into {{site.data.keyword.cloud_notm}} and target a region, account, and resource group.
4444

45-
```sh
45+
```txt
4646
ibmcloud login target -r REGION -c ACCOUNT_ID -g RESOURCE_GROUP
4747
```
4848
{: pre}
4949
5050
2. Run the **`ibmcloud resource`** command.
5151
52-
```sh
52+
```txt
5353
ibmcloud resource service-instances --service-name codeengine --long
5454
```
5555
{: pre}
@@ -66,7 +66,7 @@ Before you begin, you must have the `access_token` from the previous step.
6666
6767
**Example output**
6868
69-
```sh
69+
```txt
7070
curl -X GET \
7171
'https://globalcatalog.cloud.ibm.com/api/v1?include=*&q=name:codeengine+active:true' \
7272
-H 'Authorization: Bearer ACCESS_TOKEN'
@@ -79,7 +79,7 @@ Before you begin, you must have the `access_token` from the previous step.
7979
8080
**Example output**
8181
82-
```sh
82+
```txt
8383
curl -X GET \
8484
'https://resource-controller.cloud.ibm.com/v2/resource_instances?name=MY_PROJECT&resource_id=RESOURCE_ID' \
8585
-H 'Authorization: Bearer ACCESS_TOKEN'
@@ -102,7 +102,7 @@ Use the [`get kubeconfig for the specified project`](https://cloud.ibm.com/apido
102102
#### Example output
103103
{: #api-query-example}
104104
105-
```sh
105+
```txt
106106
curl -X GET \
107107
'https://resource-controller.cloud.ibm.com/v2/resource_instances?name=MY_PROJECT&resource_id=RESOURCE_ID' \
108108
-H 'Authorization: Bearer ACCESS_TOKEN'
@@ -114,21 +114,21 @@ curl -X GET \
114114

115115
1. Log in into {{site.data.keyword.cloud_notm}} and target a region, account, and resource group.
116116

117-
```sh
117+
```txt
118118
ibmcloud login target -r REGION -c ACCOUNT_ID -g RESOURCE_GROUP
119119
```
120120
{: pre}
121121
122122
2. Create your {{site.data.keyword.codeengineshort}} project:
123123
124-
```sh
124+
```txt
125125
ibmcloud ce project create --name PROJECT
126126
```
127127
{: pre}
128128
129129
3. Select your {{site.data.keyword.codeengineshort}} project as the current context and append the project to the default Kubernetes configuration file.
130130
131-
```sh
131+
```txt
132132
ibmcloud ce project select --name PROJECT --kubecfg
133133
```
134134
{: pre}

0 commit comments

Comments
 (0)