blob: 50cdd5c03bac8a4ac72e515415668e97ea3745ed [file] [log] [blame]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="">
<meta name="keywords" content="organizations, organizations, user management, permissions">
<title>Organizations | Eclipse Che Documentation</title>
<link rel="stylesheet" href="css/syntax.css">
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" crossorigin="anonymous">
<!--<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">-->
<link rel="stylesheet" href="css/modern-business.css">
<!-- Latest compiled and minified CSS -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<link rel="stylesheet" href="css/customstyles.css">
<link rel="stylesheet" href="css/boxshadowproperties.css">
<!-- most color styles are extracted out to here -->
<link rel="stylesheet" href="css/theme-che.css">
<link rel="stylesheet" href="/css/coderay.css" media="screen" type="text/css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js" crossorigin="anonymous"></script>
<script src="js/jquery.navgoco.min.js"></script>
<!-- Latest compiled and minified JavaScript -->
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
<!-- Anchor.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/2.0.0/anchor.min.js" crossorigin="anonymous"></script>
<script src="js/toc.js"></script>
<script src="js/customscripts.js"></script>
<link rel="shortcut icon" href="che/docs/images/favicon.ico">
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->
<link rel="alternate" type="application/rss+xml" title="che" href="http://0.0.0.0:4000/feed.xml">
<script>
$(document).ready(function() {
// Initialize navgoco with default options
$("#mysidebar").navgoco({
caretHtml: '',
accordion: true,
openClass: 'active', // open
save: false, // leave false or nav highlighting doesn't work right
cookie: {
name: 'navgoco',
expires: false,
path: '/'
},
slide: {
duration: 400,
easing: 'swing'
}
});
$("#collapseAll").click(function(e) {
e.preventDefault();
$("#mysidebar").navgoco('toggle', false);
});
$("#expandAll").click(function(e) {
e.preventDefault();
$("#mysidebar").navgoco('toggle', true);
});
});
</script>
<script>
$(function () {
$('[data-toggle="tooltip"]').tooltip()
})
</script>
<script>
$(document).ready(function() {
$("#tg-sb-link").click(function() {
$("#tg-sb-sidebar").toggle();
$("#tg-sb-content").toggleClass('col-md-9');
$("#tg-sb-content").toggleClass('col-md-12');
$("#tg-sb-icon").toggleClass('fa-toggle-on');
$("#tg-sb-icon").toggleClass('fa-toggle-off');
});
});
</script>
</head>
<body>
<!-- Navigation -->
<nav class="navbar navbar-inverse navbar-static-top">
<div class="container topnavlinks">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="fa fa-home fa-lg navbar-brand" href="index.html">&nbsp;<span class="projectTitle"> Eclipse Che Documentation</span></a>
</div>
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav navbar-right">
<!-- toggle sidebar button -->
<li><a id="tg-sb-link" href="#"><i id="tg-sb-icon" class="fa fa-toggle-on"></i> Nav</a></li>
<!-- entries without drop-downs appear here -->
<li><a href="https://medium.com/eclipse-che-blog/" target="_blank">Blog</a></li>
<li><a href="https://github.com/eclipse/che" target="_blank">Source Code</a></li>
<!-- entries with drop-downs appear here -->
<!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Get Support<b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="https://github.com/eclipse/che/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Akind%2Fbug" target="_blank">Known Bugs</a></li>
<li><a href="https://github.com/eclipse/che/issues/new" target="_blank">File an Issue</a></li>
<li><a href="https://stackoverflow.com/questions/tagged/eclipse-che" target="_blank">Che on StackOverflow</a></li>
</ul>
</li>
<!--
<li>
<a class="email" title="Submit feedback" href="#" onclick="javascript:window.location='mailto:?subject= feedback&body=I have some feedback about the Organizations page: ' + window.location.href;"><i class="fa fa-envelope-o"></i> Feedback</a>
</li>
-->
<!--comment out this block if you want to hide search-->
<li>
<!--start search-->
<div id="search-demo-container">
<input type="text" id="search-input" placeholder="search...">
<ul id="results-container"></ul>
</div>
<script src="js/jekyll-search.js" type="text/javascript"></script>
<script type="text/javascript">
SimpleJekyllSearch.init({
searchInput: document.getElementById('search-input'),
resultsContainer: document.getElementById('results-container'),
dataSource: 'search.json',
searchResultTemplate: '<li><a href="{url}" title="Organizations">{title}</a></li>',
noResultsText: 'No results found.',
limit: 10,
fuzzy: true,
})
</script>
<!--end search-->
</li>
</ul>
</div>
</div>
<!-- /.container -->
</nav>
<!-- Page Content -->
<div class="container">
<div id="main">
<!-- Content Row -->
<div class="row">
<!-- Sidebar Column -->
<div class="col-md-3" id="tg-sb-sidebar">
<ul id="mysidebar" class="nav">
<li class="sidebarTitle"> </li>
<li>
<a href="#">Overview</a>
<ul>
<li><a href="index.html">Introduction</a></li>
<li><a href="quick-start.html">Getting Started</a></li>
<li><a href="single-multi-user.html">Single and Multi-User Flavors</a></li>
<li><a href="infra-support.html">Supported Infrastructures</a></li>
</ul>
</li>
<li>
<a href="#">Che on Docker</a>
<ul>
<li><a href="docker-single-user.html">Docker - Single User</a></li>
<li><a href="docker-multi-user.html">Docker - Multi User</a></li>
<li><a href="docker-config.html">Docker - Configuration</a></li>
<li><a href="docker-cli.html">Docker - CLI Reference</a></li>
</ul>
</li>
<li>
<a href="#">Che on Kubernetes</a>
<ul>
<li><a href="kubernetes-single-user.html">Kubernetes - Single User</a></li>
<li><a href="kubernetes-multi-user.html">Kubernetes - Multi User</a></li>
<li><a href="kubernetes-config.html">Kubernetes - Configuration</a></li>
<li><a href="kubernetes-admin-guide.html">Kubernetes - Admin Guide</a></li>
</ul>
</li>
<li>
<a href="#">Che on OpenShift</a>
<ul>
<li><a href="openshift-single-user.html">OpenShift - Single User</a></li>
<li><a href="openshift-multi-user.html">OpenShift - Multi User</a></li>
<li><a href="openshift-config.html">OpenShift - Configuration</a></li>
<li><a href="openshift-admin-guide.html">OpenShift - Admin Guide</a></li>
</ul>
</li>
<li>
<a href="#">User Management</a>
<ul>
<li><a href="user-management.html">Authentication and Authorization</a></li>
<li><a href="authentication.html">Security Model</a></li>
<li><a href="permissions.html">Permissions</a></li>
<li class="active"><a href="organizations.html">Organizations in UD</a></li>
<li><a href="resource-management.html">Resource Management</a></li>
</ul>
</li>
<li>
<a href="#">User Guides</a>
<ul>
<li><a href="creating-starting-workspaces.html">Creating and starting Workspaces</a></li>
<li><a href="ide-projects.html">Projects</a></li>
<li><a href="editor-code-assistance.html">Editor and Code-Assistance</a></li>
<li><a href="dependency-management.html">Dependency Management</a></li>
<li><a href="commands-ide-macro.html">Commands and IDE Macros</a></li>
<li><a href="version-control.html">Version Control</a></li>
<li><a href="debug.html">Debug</a></li>
</ul>
</li>
<li>
<a href="#">Workspace Administration</a>
<ul>
<li><a href="what-are-workspaces.html">Workspace Overview</a></li>
<li><a href="stacks.html">Workspace - Stacks</a></li>
<li><a href="recipes.html">Workspace - Recipes</a></li>
<li><a href="servers.html">Workspace - Servers</a></li>
<li><a href="installers.html">Workspace - Installers</a></li>
<li><a href="volumes.html">Workspace - Volumes Mount</a></li>
<li><a href="env-variables.html">Workspace - Environment Variables</a></li>
<li><a href="projects.html">Workspace - Projects</a></li>
<li><a href="workspaces-troubleshooting.html">Workspace - Troubleshooting</a></li>
<li><a href="workspace-data-model.html">Workspace Data Model</a></li>
</ul>
</li>
<li>
<a href="#">Portable Workspaces</a>
<ul>
<li><a href="chedir-getting-started.html">Chedir - Getting Started</a></li>
<li><a href="why-chedir.html">Chedir - Why Chedir?</a></li>
<li><a href="chedir-installation.html">Chedir - Installation</a></li>
<li><a href="chedir-project-setup.html">Chedir - Project Setup</a></li>
<li><a href="chedir-up-and-down.html">Chedir - Up and Down</a></li>
<li><a href="chefile.html">Chedir - Chefile</a></li>
<li><a href="chedir-ssh.html">Chedir - SSH</a></li>
<li><a href="factories-getting-started.html">Factory - Getting Started</a></li>
<li><a href="creating-factories.html">Factory - Creating</a></li>
<li><a href="factories_json_reference.html">Factory - JSON Reference</a></li>
</ul>
</li>
<li>
<a href="#">Developer Guides</a>
<ul>
<li><a href="framework-overview.html">Overview</a></li>
<li><a href="rest-api.html">SDK - REST API</a></li>
<li><a href="che-in-che-quickstart.html">SDK - Your First Plugin</a></li>
<li><a href="build-reqs.html">SDK - Building Che</a></li>
<li><a href="assemblies.html">SDK - Assemblies</a></li>
<li><a href="logging.html">SDK - Logging</a></li>
<li><a href="ide-extensions-gwt.html">SDK - GWT IDE Extensions</a></li>
<li><a href="server-side-extensions.html">SDK - Server Side Extensions</a></li>
<li><a href="custom-installers.html">SDK - Installers</a></li>
<li><a href="project-types.html">SDK - Project Types</a></li>
<li><a href="language-servers.html">SDK - Language Support</a></li>
<li><a href="parts.html">IDE UI&#58 Parts</a></li>
<li><a href="actions.html">IDE UI&#58 Actions</a></li>
</ul>
</li>
<li>
<a href="#">Dev Essentials</a>
<ul>
<li><a href="guice.html">Dependency Injection</a></li>
<li><a href="dto.html">Transport&#58 DTO</a></li>
<li><a href="json-rpc.html">Communication&#58 JSON-RPC</a></li>
<li><a href="handling-projects-in-plugins.html">Handling Projects in Plugins</a></li>
<li><a href="dao.html">Persistence, DAO</a></li>
<li><a href="properties.html">Properties</a></li>
</ul>
</li>
<li>
<a href="#">Infrastructure and SPI</a>
<ul>
<li><a href="spi_overview.html">Overview</a></li>
<li><a href="spi-implementation.html">Implementation Notes</a></li>
</ul>
</li>
<!-- if you aren't using the accordion, uncomment this block:
<p class="external">
<a href="#" id="collapseAll">Collapse All</a> | <a href="#" id="expandAll">Expand All</a>
</p>
-->
</ul>
<!-- this highlights the active parent class in the navgoco sidebar. this is critical so that the parent expands when you're viewing a page. This must appear below the sidebar code above. Otherwise, if placed inside customscripts.js, the script runs before the sidebar code runs and the class never gets inserted.-->
<script>$("li.active").parents('li').toggleClass("active");</script>
</div>
<!-- Content Column -->
<div class="col-md-9" id="tg-sb-content">
<div class="post-header">
<h1 class="post-title-main">Organizations</h1>
</div>
<div class="post-content">
<!-- this handles the automatic toc. use ## for subheads to auto-generate the on-page minitoc. if you use html tags, you must supply an ID for the heading element in order for it to appear in the minitoc. -->
<script>
$( document ).ready(function() {
// Handler for .ready() called.
$('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2' });
/* this offset helps account for the space taken up by the floating toolbar. */
$('#toc').on('click', 'a', function() {
var target = $(this.getAttribute('href'))
, scroll_target = target.offset().top
$(window).scrollTop(scroll_target - 10);
return false
})
});
</script>
<div id="toc"></div>
<!--
-->
<div class="sect1">
<h2 id="organizations-in-eclipse-che">Organizations in Eclipse Che</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Organizations allow admins to group Eclipse Che users and allocate resources. Resources and permissions are controlled and allocated within the admin dashboard by a system administrator.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="roles">Roles</h2>
<div class="sectionbody">
<div class="paragraph">
<p>There are two different roles in an organization:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><strong>Admin</strong>: Organization admins are able to manage the organization. Admins can edit settings, manage members, resources and sub-organization.<br></p>
</li>
<li>
<p><strong>Members</strong>: Organization members are able create workspaces, manage their own workspaces and use any workspaces they have permissions for.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>There is also a <strong>System Admin</strong> role which sits above the organization construct. System Admins are able to create root organizations, as well as manage all resources, members and sub-organizations.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="organization-structure">Organization Structure</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Top level organizations are called "root organizations." Any organization can 0..n sub-organizations. Multiple root organizations are allowed and can be created only be the System Admin. Management of root organizations’ resources can only be done by the System Admin.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="creating-an-organization">Creating an Organization</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Only the System Admin is able to create root organizations. Organization Admins can create sub-organizations. To create an organization, use the menu in the left sidebar, which leads to the list of organizations. A new page is displayed with all organizations in your system. Click on the top-left button to create a new organization.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="organization-list">Organization List</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The list of all organizations are displayed on organizations page. The list contains the general information for each organization: number of members, total and available RAM and number of sub-organizations.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="adding-organization-members">Adding Organization Members</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Adding organization members by clicking the "Add" button will display a new popup. You can change an organization member’s role or remove them from the organization at any time.</p>
</div>
<div class="paragraph">
<p>Note: Users with the green checkmark beside their name already have an account on your Eclipse Chesystem and will be added to the organization. Users without a checkmark do not have an account and will not be added into the organization.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="workspaces-in-organization">Workspaces in Organization</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Workspace is created inside of an organization and uses the resources of this very organization. Workspace creator has to choose the organization on workspace creation page.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="email-notifications">Email Notifications</h2>
<div class="sectionbody">
<div class="paragraph">
<p>When a user joins or leaves an organization, Che server can send a notification in case SMTP is properly configured in <code>che.env</code> (or by adding envs to deployment in case fo OpenShift). By default, Che does not offer any built-in SMTP server. You may use any mail server you want. Below is an example on how to use own Gmail to send notification emails:</p>
</div>
<div class="listingblock">
<div class="content">
<pre>CHE_MAIL_PORT=465
CHE_MAIL_HOST=smtp.gmail.com
CHE_MAIL_SMTP_STARTTLS_ENABLE=true
CHE_MAIL_SMTP_AUTH=true
CHE_MAIL_SMTP_AUTH_USERNAME=no-reply@gmail.com
CHE_MAIL_SMTP_AUTH_PASSWORD=password</pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="create-sub-organization">Create Sub-Organization</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The creation of sub-organization can be done from organization details page by selecting Sub-Organizations tab and clicking "Add Sub-Organization" button.</p>
</div>
<div class="paragraph">
<p>The flow of sub-organization creation is the same as for organization.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="add-members-to-sub-organization">Add members to Sub-Organization</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The sub-organization members can be added only from the list of parent organization’s members:</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="organization-and-sub-organization-administration">Organization and Sub-Organization Administration</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Organization settings are visible to all members of the organization, but only the Eclipse Che system administrator is able to modify the settings.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="rename-an-organization-or-sub-organization">Rename an Organization or Sub-Organization</h2>
<div class="sectionbody">
<div class="paragraph">
<p><strong>Action restricted to</strong>: Eclipse Che system administrator and admins of the organization.</p>
</div>
<div class="paragraph">
<p>To rename an Organization, click in the "Name" textfield and start editing the name of the organization. Once edited, the save mode will appear - click on "Save" button to update the name.</p>
</div>
<div class="paragraph">
<p>The name of the organization is restricted to the following rules:<br>
- Only alphanumeric characters or a single "-" can be used<br>
- Spaces cannot be used in organization names<br>
- Each organization name must be unique within the Eclipse Che install - Each sub-organization name must be unique within an organization</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="leave-an-organization-or-sub-organization">Leave an Organization or Sub-Organization</h2>
<div class="sectionbody">
<div class="paragraph">
<p>This action is not possible for members of an organization. Users have to contact organization’s admin or Eclipse Che system admin.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="delete-an-organization-or-sub-organization">Delete an Organization or Sub-Organization</h2>
<div class="sectionbody">
<div class="paragraph">
<p><strong>Action restricted to</strong>: Eclipse Che system administrator and admins of the organization.</p>
</div>
<div class="paragraph">
<p>To delete an organization or a sub-organization, click on "Delete" button. This action can’t be reverted and all workspaces created under the organization will be deleted.</p>
</div>
<div class="paragraph">
<p>All members of the organization will receive an email notification to inform about organization deletion.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="organization-resources">Organization Resources</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Workspaces created in an organization use the resources allocated by the system administrator to that organization. Resources for sub-organizations are taken from the parent organization. Admins can control whether all, or a portion of the parent’s resources are available to the sub-organization.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="managing-limits">Managing Limits</h2>
<div class="sectionbody">
<div class="paragraph">
<p><strong>Action restricted to</strong>: Eclipse Che system administrator and admins of the organization.</p>
</div>
<div class="paragraph">
<p>The organization default caps are taken from the system configuration. The admin of the organization can manage only the limits of it’s sub-organizations. By default, there are no resource limits applied to the organization so all members can benefit from all the allocated resources. If an organization admin wishes to set limits they have three options:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><strong>Workspace Cap</strong>: The maximum number of workspaces that can exist in the organization.<br></p>
</li>
<li>
<p><strong>Running Workspace Cap</strong>: The maximum number of workspaces which can run simultaneously in the organization.<br></p>
</li>
<li>
<p><strong>Workspace RAM Cap</strong>: The maximum total RAM organization workspaces can use in GB.</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="update-organization-and-sub-organization-member-roles">Update Organization and Sub-Organization Member Roles</h2>
<div class="sectionbody">
<div class="paragraph">
<p><strong>Action restricted to</strong>: Eclipse Che system administrator and admins of the organization.</p>
</div>
<div class="paragraph">
<p>To edit the role of a organization member click on the "Edit" button in the "Actions" column. You’ll get a pop-up where you can update the role of the selected member. Click "Save" to confirm the update.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="remove-organization-and-sub-organization-members">Remove Organization and Sub-Organization Members</h2>
<div class="sectionbody">
<div class="paragraph">
<p><strong>Action restricted to</strong>: Eclipse Che system administrator and admins of the organization.</p>
</div>
<div class="paragraph">
<p>To remove a member from the organization, you can click on the "Delete" button in the "Actions" column. You’ll get a confirmation pop-up, where you can confirm or cancel your action.</p>
</div>
<div class="paragraph">
<p>You can also select multiple members from the organization, using the checkboxes. A delete button will appear in the header of the table. The members that are removed from the organization will receive an email notification.</p>
</div>
</div>
</div>
<div class="tags">
<b>Tags: </b>
<a href="tag_organizations.html" class="btn btn-default navbar-btn cursorNorm" role="button">organizations</a>
</div>
<!--
-->
</div>
<hr class="shaded"/>
<footer>
<div class="row">
<div class="col-lg-12 footer">
Eclipse Che - Documentation <br/>
Site last generated: Sep 13, 2018 <br/>
<hr>
<a href="http://www.eclipse.org" target="_blank">Eclipse Foundation</a><br/>
<a href="http://www.eclipse.org/legal/privacy.php" target="_blank">Privacy Policy</a><br/>
<a href="http://www.eclipse.org/legal/termsofuse.php" target="_blank">Terms of Use</a><br/>
<a href="https://www.eclipse.org/legal/epl-2.0/" target="_blank">Eclipse Public License</a><br/>
<a href="http://www.eclipse.org/legal" target="_blank">Legal Resources</a><br/>
</div>
</div>
</footer>
<!-- /.row -->
</div>
<!-- /.container -->
</div>
<!-- /#main -->
</div>
</body>
</html>