forked from xchapter7x/docs-pivotalcf-console
-
Notifications
You must be signed in to change notification settings - Fork 0
/
manage-spaces.html.md.erb
219 lines (120 loc) · 10.9 KB
/
manage-spaces.html.md.erb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
---
title: Managing Orgs and Spaces Using Apps Manager
owner: Apps Manager
---
This topic explains how to view and manage orgs and spaces in Apps Manager.
<p class="note"><strong>Note:</strong> To manage a space, you must have Space Manager permissions in that space.</p>
## <a id='overview'></a> Overview
You can use Apps Manager to manage orgs and spaces. This includes creating and deleting orgs, domains, and spaces, managing member permissions, adding metadata, and more.
For information about managing apps and service instances, see [Managing Apps and Service Instances Using Apps Manager](manage-apps.html).
<% unless vars.book_title == "Pivotal Web Services Documentation" %>
<!-- This ensures that the paragraph below only appears in the PCF docs, not in the PWS docs. -->
You can manage orgs and spaces across multiple foundations. For more information, see [Configuring Multi-Foundation Support in Apps Manager](../opsguide/configure-multi-foundation.html).
<% end %>
## <a id='prerequisite'></a> Prerequisite
To do the following, you must first log in to Apps Manager with an account that has adequate permissions.
For more information, see [About Permissions](dev-console.html#permissions) in _Getting Started with Apps Manager_.
## <a id='view-org'></a> Manage an Org
You can manage org resources, including the spaces, domains, and members associated with the selected space, in Apps Manager. You can also manage org settings.
You can manage an org by navigating to the org in Apps Manager.
To navigate to an org, do one of the following:
* On the Apps Manager home page, under **Orgs**, click the name of the org that you want to manage.
* Search for the org by entering its name in the search bar.
By default, the landing page for an org in Apps Manager is the org **Spaces** page. You can use the panel on the left side of the screen to navigate to other pages for resources in the org, such as domains and members.
The following image shows an example of the landing page for an org in Apps Manager.
![A panel on the left side of the screen has the following main sections: Org and Marketplace. The following links are under the Org section: Spaces, Domains, Members, and Settings. In the main content of the page, a page title of "test-org" appears at the top of the page under a smaller "Org" heading. To the right of the "test-space" title is a horizontal bar with the label "Quota". Below this header content is a table labeled "Spaces". The table has the following columns: Name, Apps, App Status, Services, and Org Quota Usage.](org-spaces-page.png)
You can manage the following resources in an org using Apps Manager:
* Spaces. See [Manage Spaces](#spaces).
* Domains. See [Manage Domains](#domains).
* Members. See [Manage Members](#members).
* Org settings. See [Manage Settings](#org-settings).
### <a id="spaces"></a> Manage Spaces
In the org **Spaces** tab, you can do the following:
* See the following information for each space:
* Name
* Number of apps
* Number of apps in running, stopped, and crashed states
* Number of services
* Memory quota usage
* Create a new space.
### <a id="domains"></a> Manage Domains
In the org **Domains** page, you can do the following:
* See each **Domain** in your org.
* See the **Type** associated with each domain. A type is either **Globally Shared** or **Privately Shared**. For more information about globally and locally shared domains, see [Shared Domains](https://docs.pivotal.io/platform/devguide/deploy-apps/routes-domains.html#shared-domains) and [Private Domains](https://docs.pivotal.io/platform/devguide/deploy-apps/routes-domains.html#private-domains).
* Delete a domain by clicking the vertical three-dot icon and selecting **Delete**. You must have permission to manage the domain to delete it.
* Create a new private domain by clicking **Add a Domain**. You must have Org Manager permissions to create a private domain.
<p class="note"><strong>Note:</strong> To create globally shared domains, you must have Admin permissions and use the Cloud Foundry Command Line Interface (cf CLI). For more information, see [Create a Shared Domain](https://docs.pivotal.io/platform/devguide/deploy-apps/routes-domains.html#create-a-shared-domain).</p>
### <a id="members"></a> Manage Members
In the org **Members** page, you can do the following:
* See member email addresses
* Toggle member permissions
* Remove member from org
* Invite a new member
### <a id="org-settings"></a> Manage Settings
In the org **Settings** page, you can do the following:
* Change the org name
* See spaces assigned to isolation segments. For more information, see [Isolation Segments](../concepts/security.html#isolation-segments) in _<%= vars.app_runtime_abbr %> Security_.
* Delete the org. You must have admin permissions to delete an org.
### <a id="metadata-org"></a> Add Metadata
You can add metadata, including labels and annotations, to orgs using Apps Manager.
<% if vars.platform_code.include? "CF" %>
For more information about adding metadata to objects in <%= vars.app_runtime_full %> (<%= vars.app_runtime_abbr %>), see [Using Metadata](../adminguide/metadata.html).
<% else %>
For more information about adding metadata to objects in <%= vars.app_runtime_full %> (<%= vars.app_runtime_abbr %>), see [Using Metadata](https://docs.pivotal.io/platform/adminguide/metadata.html).
<% end %>
To add labels or annotations to an org using Apps Manager:
1. Click the **Settings** tab of the desired org and navigate to the **Metadata** section.
![The Metadata section of the Apps Manager Settings page includes fields for labels and annotations. Each field includes two text boxes for entering name and value pairs, a toggle labeled "Enter JSON" that allows you to enter metadata in JSON format, and aplus-sign button that allows you to add more name and value pairs. There are also "Cancel" and "Update Metadata" buttons to save or abandon your changes.](metadata.png)
1. For **Labels**, complete the **Name** and **Value** fields. Or, select **Enter JSON** to enter the label in JSON.
1. For **Annotations**, complete the **Name** and **Value** fields. Or, select **Enter JSON** to enter the annotation in JSON.
1. To add more labels or annotations, click **+** next to the **Labels** or **Annotations** field.
1. Click **Update Metadata**.
## <a id='manage-space'></a> Manage a Space
You can manage space resources, including the apps, service instances, routes, and members associated with the selected space, in Apps Manager. You can also manage space settings.
You can manage a space by navigating to the space in Apps Manager.
To navigate to the space, do one of the following:
* On the org page, click the name of the space you want to manage.
* Search for a space by entering its name in the search bar.
By default, the landing page for a space in Apps Manager is the space **Apps** page. You can use the panel on the left side of the screen to navigate to other pages for resources in the space, such as services and members.
The following image shows an example of the landing page for a space in Apps Manager.
![A panel on the left side of the screen has the following main sections: Space, Networking, Marketplace. The following links are under the Space section: Apps, Services, Members, Settings. A Routes link is under the Networking section. In the main content of the page, a page title of "test-space" appears at the top of the page under a smaller "Space" heading. To the right of the "test-space" title are the headings: Running, Stopped, and Crashed. Under each of these headings is a number that signifies the number of apps in the space that are running, stopped, or crashed. Below this header content is a table labeled "Apps". The table has the following columns: Status, Name, Instances, Memory, Last Push, and Route.](space-apps-view.png)
You can manage the following resources in a space using Apps Manager:
* Apps. See [Manage Apps](#manage-apps).
* Services. See [Manage Services](#manage-services).
* Members. See [Manage Members](#manage-members).
* Routes. See [Manage Routes](#manage-routes).
* Space settings. See [Manage Settings](#manage-settings).
### <a id='manage-apps'></a> Manage Apps
The **Apps** page lists information about all apps in the space. For each app, it shows the **Status**, **Name**, number of **Instances**, amount of **Memory** available, time since the **Last Push**, and associated **Route**.
### <a id='manage-services'></a> Manage Services
The **Services** page shows the **Service**, **Name**, number of **Bound Apps**, and **Plan** for each service instance in the space.
For more information about configuring services, see the [Services Overview](../devguide/services/) topic.
### <a id='manage-members'></a> Manage Members
The **Members** page lists all members of the space. For each member, the page also lists the associated user roles.
The following user roles can be assigned to space members on the **Members** page:
* **Space Manager**: Space Managers can invite and manage users in the space.
* **Space Developer**: Space Developers can create, manage, and delete apps and services in a space.
* **Space Auditor**: Space Auditors have read-only access to space details, app logs, and reports.
### <a id='manage-routes'></a> Manage Routes
The **Routes** page lists the routes associated with the space.
For each **Route**, the page shows the **Route Service** and **Bound Apps**. For more information about route services, see [Route Services](../services/route-services.html).
### <a id='manage-settings'></a> Manage Settings
From the space **Settings** page, you can do the following:
* Modify the space name.
* View the Application Security Groups (ASGs) associated with the space.
* View the space's isolation segment assignment. For more information, see [Isolation Segments](../concepts/security.html#isolation-segments) in _<%= vars.app_runtime_abbr %> Security_.
* Add metadata to the space. For more information, see [Add Metadata](#metadata).
* Delete the space.
### <a id="metadata-space"></a> Add Metadata
You can add metadata, including labels and annotations spaces using Apps Manager.
<% if vars.platform_code.include? "CF" %>
For more information about adding metadata to objects in <%= vars.app_runtime_abbr %>, see [Using Metadata](../adminguide/metadata.html).
<% else %>
For more information about adding metadata to objects in <%= vars.app_runtime_abbr %>, see [Using Metadata](https://docs.pivotal.io/platform/adminguide/metadata.html).
<% end %>
To add labels or annotations to a space using Apps Manager:
1. Click the **Settings** tab of the desired space and navigate to the **Metadata** section.
1. For **Labels**, complete the **Name** and **Value** fields. Or, select **Enter JSON** to enter the label in JSON.
1. For **Annotations**, complete the **Name** and **Value** fields. Or, select **Enter JSON** to enter the annotation in JSON.
1. To add more labels or annotations, click **+** next to the **Labels** or **Annotations** field.
1. Click **Update Metadata**.