You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If you have not downloaded the {{site.data.keyword.semver}} bundle, use the following commands with your [Entitled Registry Key](https://myibm.ibm.com/products-services/containerlibrary):
24
28
25
29
```
@@ -77,7 +81,7 @@ If you are using your own remote databases, ensure that those databases are back
**Note**: The backup script automatically detects the type of databases that are used during installation.
82
86
83
87
* If you run the following example with no options, it generates a folder where the script ran. The folder follows this naming pattern **ibm-edge-backup/$DATE/**:
@@ -86,7 +90,7 @@ If you are using your own remote databases, ensure that those databases are back
If a **local database** installation was detected, your backup contains a **customresource** directory, a **databaseresources** directory, and two yaml files:
91
95
92
96
```
@@ -97,9 +101,9 @@ If you are using your own remote databases, ensure that those databases are back
97
101
-rw-r--r-- 1 staff staff 3689 Oct 26 21:51 ibm-edge-config.yaml
98
102
```
99
103
{: codeblock}
100
-
104
+
101
105
If a **remote database** installation was detected, you see the same directories that are listed previously, but three yaml files instead of 2.
102
-
106
+
103
107
```
104
108
$ ls -l ibm-edge-backup/20201026_215518/
105
109
drwxr-xr-x 3 staff staff 96 Oct 26 21:55 customresource
@@ -118,14 +122,14 @@ To restore backups, an identical {{site.data.keyword.mgmt_hub}} must be installe
118
122
119
123
This situation occurs when the edge node recognizes that it no longer exists in the exchange because the database is now empty. Enable **ieam\_maintenance\_mode** to avoid this by starting the database resources only for the {{site.data.keyword.mgmt_hub}}. This allows restoration to complete before the remaining {{site.data.keyword.mgmt_hub}} resources (which use those databases) are started.
120
124
121
-
**Notes**:
125
+
**Notes**:
122
126
123
127
* Restore backups to the same {{site.data.keyword.ieam}} version where the backup was taken; for example, a 4.2 {{site.data.keyword.ieam}} backup can only be restored to a 4.2 {{site.data.keyword.ieam}} installation.
124
128
125
129
* When your **Custom Resource** file was backed up, it was automatically modified to enter **ieam\_maintenance\_mode** immediately upon reapplication to the cluster.
126
130
127
131
* The restore scripts examine the **\[path/to/backup\]/customresource/eamhub-cr.yaml** file to determine what type of database was used previously.
128
-
132
+
129
133
130
134
1. As a cluster administrator, ensure that you are connected to your cluster with **cloudctl login** or **oc login** and that a valid backup was created. On the cluster where the backup was made, run the following command to delete the **eamhub** custom resource (this assumes the default name of **ibm-edge** was used for the custom resource):
131
135
```
@@ -164,7 +168,7 @@ This situation occurs when the edge node recognizes that it no longer exists in
164
168
{: codeblock}
165
169
166
170
Wait until all the database, SDO, and vault pods are running before proceeding. It is possible that vault may continually restart, the vault bootstrap may reach an `Error` state, and/or SDO will likely be in a `0/1 Running` state and may reach a `CrashLoopBackOff` state. These are expected, and it is ok to proceed with those pods in those states.
167
-
171
+
168
172
6. Scale down the **eamhub** operator deployment to pause the operator and end the current control loop:
Copy file name to clipboardExpand all lines: docs/admin/multi_tenancy.md
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
---
2
2
3
3
copyright:
4
-
years: 2021
5
-
lastupdated: "2021-02-20"
4
+
years: 2020 - 2022
5
+
lastupdated: "2022-03-17"
6
6
title: Multitenacy
7
7
description: Software architecture in which a single instance of software runs on server and server multiplies tenants.
8
8
@@ -28,10 +28,10 @@ description: Software architecture in which a single instance of software runs o
28
28
29
29
Two broad use cases are used to leverage multi-tenancy in {{site.data.keyword.ieam}}:
30
30
31
-
* An enterprise has multiple business units, where each business unit is a separate organization in the same {{site.data.keyword.ieam}} management hub. Consider the legal, business, or technical reasons why each business unit ought to be a separate organization with its own set of {{site.data.keyword.ieam}} resources which are by default not accessible by the other business units. Note that even with separate organizations, the enterprise still has the option to use a common group of organization administrators to manage all of the organizations.
32
-
* An enterprise hosts {{site.data.keyword.ieam}} as a service for its customers, where each of their customers has one or more organizations in the management hub. In this case, the organization administrators are unique to each customer.
31
+
* An enterprise has multiple business units, where each business unit is a separate organization in the same {{site.data.keyword.ieam}} management hub. Consider the legal, business, or technical reasons why each business unit ought to be a separate organization with its own set of {{site.data.keyword.ieam}} resources, which are by default not accessible by the other business units. Even with separate organizations, the enterprise has the option to use a common group of organization administrators to manage all of the organizations.
32
+
* An enterprise hosts {{site.data.keyword.ieam}} as a service for its clients, where each of their clients has one or more organizations in the management hub. In this case, the organization administrators are unique to each client.
33
33
34
-
The use case you choose determines how you configure {{site.data.keyword.ieam}} and Identity and Access Manager ([IAM](https://www.ibm.com/support/knowledgecenter/SSHKN6/iam/landing_iam.html)).
34
+
The use case that you choose determines how you configure {{site.data.keyword.ieam}} and Identity and Access Manager ([IAM](https://www.ibm.com/support/knowledgecenter/SSHKN6/iam/landing_iam.html)).
35
35
36
36
### Types of {{site.data.keyword.ieam}} users
37
37
{: #user-types}
@@ -52,9 +52,9 @@ See [Role-based access control](../user_management/rbac.md) for a description of
52
52
53
53
The IAM (Identity and Access Manager) service manages users for all Cloud Pak based products, including {{site.data.keyword.ieam}}. IAM in turn uses LDAP to store the users. Each IAM user can be a member of one or more IAM teams. Because each IAM team is associated with an IAM account, an IAM user can indirectly be a member of one or more IAM accounts. See [IAM multi-tenancy](https://www.ibm.com/support/knowledgecenter/SSHKN6/iam/3.x.x/multitenancy/multitenancy.html) for details.
54
54
55
-
The {{site.data.keyword.ieam}} exchange provides authentication and authorization services for the other {{site.data.keyword.ieam}} components. The exchange delegates the authentication of users to IAM, which means IAM user credentials are passed to the exchange and it relies on IAM to determine if they are valid. Each user role (hub admin, organization admin, or regular user) is defined in the exchange, and that determines the actions that users are allowed to perform in {{site.data.keyword.ieam}}.
55
+
The {{site.data.keyword.ieam}} exchange provides authentication and authorization services for the other {{site.data.keyword.ieam}} components. The exchange delegates the authentication of users to IAM, which means IAM user credentials are passed to the exchange and it relies on IAM to determine whether they are valid. Each user role (hub admin, organization admin, or regular user) is defined in the exchange, and that determines the actions that users are allowed to perform in {{site.data.keyword.ieam}}.
56
56
57
-
Each organization in the {{site.data.keyword.ieam}} exchange is associated with an IAM account. Therefore IAM users in an IAM account are automatically members of the corresponding {{site.data.keyword.ieam}} organization. The one exception to this rule is that the {{site.data.keyword.ieam}} hub admin role is considered to be outside of any specific organization; therefore, it does not matter what IAM account the hub admin IAM user is in.
57
+
Each organization in the {{site.data.keyword.ieam}} exchange is associated with an IAM account. Therefore, IAM users in an IAM account are automatically members of the corresponding {{site.data.keyword.ieam}} organization. The one exception to this rule is that the {{site.data.keyword.ieam}} hub admin role is considered to be outside of any specific organization; therefore, it does not matter what IAM account the hub admin IAM user is in.
58
58
59
59
To summarize the mapping between IAM and {{site.data.keyword.ieam}}:
60
60
@@ -77,7 +77,7 @@ By default, an organization was created during {{site.data.keyword.ieam}} instal
77
77
78
78
The IBM organization is a unique organization that provides predefined services and patterns that are intended to be technology examples that are usable by any user in any organization. The IBM organization is automatically created when the {{site.data.keyword.ieam}} management hub is installed.
79
79
80
-
**Note:** Although the resources in the IBM organization are public, the IBM organization is not intended to hold all public content in the {{site.data.keyword.ieam}} management hub.
80
+
**Note**: Although the resources in the IBM organization are public, the IBM organization is not intended to hold all public content in the {{site.data.keyword.ieam}} management hub.
81
81
82
82
## Organization Configuration
83
83
{: #org-config}
@@ -89,7 +89,7 @@ Every {{site.data.keyword.ieam}} organization has the following settings. The de
89
89
|`description`| A description of the organization. |
90
90
|`label`| The name of the organization. This value is used to display the organization name in the {{site.data.keyword.ieam}} management console. |
91
91
|`heartbeatIntervals`| How often edge node agents in the organization poll the management hub for instructions. See the following section for details. |
92
-
|`limits`| Limits for this organization. Currently the only limit is `maxNodes`, which is the maximum number of edge nodes allowed in this organization. There is a practical limit to the total number of edge nodes that a single {{site.data.keyword.ieam}} management hub can support. This setting enables the hub admin user to limit the number of nodes that each organization can have, which prevents one organization from using all of the capacity. A value of `0` means no limit. |
92
+
|`limits`| Limits for this organization. Currently, the only limit is `maxNodes`, which is the maximum number of edge nodes that are allowed in this organization. There is a practical limit to the total number of edge nodes that a single {{site.data.keyword.ieam}} management hub can support. This setting enables the hub admin user to limit the number of nodes that each organization can have, which prevents one organization from using all of the capacity. A value of `0` means no limit. |
Follow these steps to install the command line tools that are needed to manage aspects of the IBM Edge Application Manager (IEAM) management hub and edge clusters:
21
+
Follow these steps to install the command line tools that are needed to manage aspects of the {{site.data.keyword.edge_notm}} ({{site.data.keyword.ieam}}) management hub and edge clusters:
21
22
22
-
###cloudctl
23
+
## cloudctl
23
24
24
-
1. Browse your IEAM web UI at: https://<CLUSTER_URL>/common-nav/cli
25
-
2. Expand the __IBM Cloud Pak CLI__ section and select your __OS__.
26
-
3. Copy the displayed __curl__ command and run it to download the __cloudctl__ binary.
27
-
4. Make the file executable and move it to __/usr/local/bin__:
25
+
1. Browse your {{site.data.keyword.ieam}} web UI at: `https://<CLUSTER_URL>/common-nav/cli`
28
26
29
-
```sh
30
-
chmod 755 cloudctl-*
31
-
sudo mv cloudctl-* /usr/local/bin/cloudctl
32
-
```
33
-
5. Ensure __/usr/local/bin__ is in your PATH and then verify that cloudctl is working:
27
+
2. Expand the **IBM Cloud Pak CLI** section and select your **OS**.
34
28
35
-
```sh
36
-
cloudctl --help
37
-
```
29
+
3. Copy the displayed **curl** command and run it to download the **cloudctl** binary.
38
30
31
+
4. Make the file executable and move it to **/usr/local/bin**:
32
+
33
+
```bash
34
+
chmod 755 cloudctl-*
35
+
sudo mv cloudctl-* /usr/local/bin/cloudctl
36
+
```
37
+
{: codeblock}
38
+
39
+
5. Ensure **/usr/local/bin** is in your PATH and then verify that **cloudctl** is working:
40
+
41
+
```bash
42
+
cloudctl --help
43
+
```
44
+
{: codeblock}
45
+
46
+
## oc
39
47
40
-
### OC
48
+
1. Download the {{site.data.keyword.open_shift_cp}} CLI tar file from [OpenShift client CLI (oc)](https://mirror.openshift.com/pub/openshift-v4/clients/ocp/latest/). Select the file **openshift-client-\*-\*.tar.gz** for your operating system.
41
49
42
-
1. Download the OpenShift Container Platform CLI tar file from OpenShift client CLI (oc). Select the file __openshift-client-*-*.tar.gz__ for your operating system.
43
50
2. Find the downloaded tar file and unpack it:
44
-
45
-
```sh
51
+
52
+
```bash
46
53
tar -zxvf openshift-client-*-*.tar.gz
47
54
```
48
-
3. Move the oc command to __/usr/local/bin__:
49
-
50
-
```sh
55
+
{: codeblock}
56
+
57
+
3. Move the **oc** command to **/usr/local/bin**:
58
+
59
+
```bash
51
60
sudo mv oc /usr/local/bin/
52
61
```
53
-
4. Ensure /usr/local/bin is in your PATH and verify that oc is working:
54
-
55
-
```sh
56
-
oc --help
57
-
```
62
+
{: codeblock}
58
63
59
-
Alternatively, use [homebrew](https://www.ibm.com/links?url=https%3A%2F%2Fbrew.sh%2F) to install __oc__ on macOS:
64
+
4. Ensure **/usr/local/bin** is in your PATH and verify that **oc** is working:
65
+
66
+
```bash
67
+
oc --help
68
+
```
69
+
{: codeblock}
60
70
61
-
```sh
62
-
brew install openshift-cli
63
-
```
71
+
Alternatively, use [homebrew](https://brew.sh/) to install **oc** on {{site.data.keyword.macOS_notm}}:
72
+
73
+
```bash
74
+
brew install openshift-cli
75
+
```
76
+
{: codeblock}
64
77
65
-
### Kubectl
78
+
## Kubectl
66
79
67
-
Follow the instructions in [Install and Set Up kubectl](https://www.ibm.com/links?url=https%3A%2F%2Fkubernetes.io%2Fdocs%2Ftasks%2Ftools%2Finstall-kubectl%2F).
80
+
Follow the instructions in [Install and Set Up kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/).
Copy file name to clipboardExpand all lines: docs/cli/exploring_hzn.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
---
2
2
3
3
copyright:
4
-
years: 2021
5
-
lastupdated: "2021-02-20"
4
+
yyears: 2020 - 2022
5
+
lastupdated: "2022-03-17"
6
6
title: hzn Command
7
7
description: ""
8
8
---
@@ -15,7 +15,7 @@ description: ""
15
15
{:child: .link .ulchildlink}
16
16
{:childlinks: .ullinks}
17
17
18
-
# Exploring the hzn command
18
+
# Exploring the hzn CLI
19
19
{: #exploring-hzn}
20
20
21
21
On {{site.data.keyword.horizon}} edge nodes, use the `hzn` command to inspect many aspects of the state of the local system and of the larger {{site.data.keyword.edge_notm}} ecosystem outside your edge node. Use the `hzn` command to interact with the system and change the state of resources you own.
0 commit comments