Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

YARN-9834. Allow using a pool of local users to run Yarn Secure Conta… #1446

Open
wants to merge 8 commits into
base: trunk
Choose a base branch
from
Original file line number Diff line number Diff line change
Expand Up @@ -2215,6 +2215,30 @@ public static boolean isAclEnabled(Configuration conf) {
public static final String DEFAULT_NM_NONSECURE_MODE_USER_PATTERN =
"^[_.A-Za-z0-9][-@_.A-Za-z0-9]{0,255}?[$]?$";

/**
* Whether or not to use precreated pool of local users in secure mode.
*/
public static final String NM_SECURE_MODE_USE_LOCAL_USER = NM_PREFIX +
"linux-container-executor.secure-mode.use-local-user";

public static final boolean DEFAULT_NM_SECURE_MODE_USE_LOCAL_USER = false;

/**
* The prefix of all the local users can be used by Yarn Secure Container.
* The number of local users to use is specified by:
* NM_PREFIX + "resource.cpu-vcores"
* For example, if prefix is "user" and cpu-vcores configured to 20,
* then local user names are:
* user0
* user1
* ...
* user19
*/
public static final String NM_SECURE_MODE_LOCAL_USER_PREFIX = NM_PREFIX +
"linux-container-executor.secure-mode.local-user-prefix";

public static final String DEFAULT_NM_SECURE_MODE_LOCAL_USER_PREFIX = "user";

/** The type of resource enforcement to use with the
* linux container executor.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ public class LinuxContainerExecutor extends ContainerExecutor {
private boolean containerSchedPriorityIsSet = false;
private int containerSchedPriorityAdjustment = 0;
private boolean containerLimitUsers;
private SecureModeLocalUserAllocator secureModeLocalUserAllocator;
private ResourceHandler resourceHandlerChain;
private LinuxContainerRuntime linuxContainerRuntime;
private Context nmContext;
Expand Down Expand Up @@ -214,6 +215,12 @@ public void setConf(Configuration conf) {
LOG.warn("{}: impersonation without authentication enabled",
YarnConfiguration.NM_NONSECURE_MODE_LIMIT_USERS);
}
boolean secureModeUseLocalUser = UserGroupInformation.isSecurityEnabled() &&
conf.getBoolean(YarnConfiguration.NM_SECURE_MODE_USE_LOCAL_USER,
YarnConfiguration.DEFAULT_NM_SECURE_MODE_USE_LOCAL_USER);
if (secureModeUseLocalUser) {
secureModeLocalUserAllocator = SecureModeLocalUserAllocator.getInstance(conf);
}
}

private LCEResourcesHandler getResourcesHandler(Configuration conf) {
Expand Down Expand Up @@ -242,8 +249,14 @@ void verifyUsernamePattern(String user) {
}

String getRunAsUser(String user) {
if (UserGroupInformation.isSecurityEnabled() ||
!containerLimitUsers) {
if (UserGroupInformation.isSecurityEnabled()) {
if (secureModeLocalUserAllocator != null) {
return secureModeLocalUserAllocator.getRunAsLocalUser(user);
}
else {
return user;
}
} else if (!containerLimitUsers) {
return user;
} else {
return nonsecureLocalUser;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,248 @@
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.apache.hadoop.yarn.server.nodemanager;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.yarn.conf.YarnConfiguration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

class LocalUserInfo {
String localUser;
int localUserIndex;
int appCount;
int fileOpCount;
int logHandlingCount;

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whitespace:end of line

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whitespace:end of line

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whitespace:end of line

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whitespace:end of line

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whitespace:end of line

public LocalUserInfo(String user, int userIndex) {
localUser = user;
localUserIndex = userIndex;
appCount = 0;
fileOpCount = 0;
logHandlingCount = 0;
}
}

/**
* Allocate local user to an appUser from a pool of precreated local users.
* Maintains the appUser to local user mapping, until:
* a) all applications of the appUser is finished;
* b) all FileDeletionTask for that appUser is executed;
* c) all log aggregation/handling requests for appUser's applications are done

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whitespace:end of line

* For now allocation is only maintained in memory so it does not support
* node manager recovery mode.
*/
public class SecureModeLocalUserAllocator {
private static final Logger LOG =
LoggerFactory.getLogger(SecureModeLocalUserAllocator.class);
private static SecureModeLocalUserAllocator instance;
private Map<String, LocalUserInfo> appUserToLocalUser;
private ArrayList<Boolean> allocated;
private int localUserCount;
private String localUserPrefix;

SecureModeLocalUserAllocator(Configuration conf) {
if (conf.getBoolean(YarnConfiguration.NM_RECOVERY_ENABLED,
YarnConfiguration.DEFAULT_NM_RECOVERY_ENABLED)) {
String errMsg = "Invalidate configuration combination: " +
YarnConfiguration.NM_RECOVERY_ENABLED + "=true, " +
YarnConfiguration.NM_SECURE_MODE_USE_LOCAL_USER + "=true";
throw new RuntimeException(errMsg);
}
localUserPrefix = conf.get(
YarnConfiguration.NM_SECURE_MODE_LOCAL_USER_PREFIX,
YarnConfiguration.DEFAULT_NM_SECURE_MODE_LOCAL_USER_PREFIX);
localUserCount = conf.getInt(YarnConfiguration.NM_VCORES,
YarnConfiguration.DEFAULT_NM_VCORES);
allocated = new ArrayList<Boolean>(localUserCount);
appUserToLocalUser = new HashMap<String, LocalUserInfo>(localUserCount);
for (int i=0; i<localUserCount; ++i) {
allocated.add(false);
}
}

public static SecureModeLocalUserAllocator getInstance(Configuration conf) {
if (instance == null) {
synchronized (SecureModeLocalUserAllocator.class) {
if (instance == null) {
instance = new SecureModeLocalUserAllocator(conf);
}
}
}
return instance;
}

/**
* Get allocated local user for the appUser.
*/
public String getRunAsLocalUser(String appUser) {
if (!appUserToLocalUser.containsKey(appUser)) {
LOG.error("Cannot find runas local user for appUser " + appUser);
return null;
}
return appUserToLocalUser.get(appUser).localUser;
}

/**
* Allocate a local user for appUser to run application appId
*/
synchronized public void allocate(String appUser, String appId) {
LOG.info("Allocating local user for " + appUser + " for " + appId);
checkAndAllocateAppUser(appUser);
LocalUserInfo localUserInfo = appUserToLocalUser.get(appUser);
localUserInfo.appCount++;
LOG.info("Incremented appCount for appUser " + appUser +
" to " + localUserInfo.appCount);
}

/**
* Deallocate local user for appUser for application appId.
*/
synchronized public void deallocate(String appUser, String appId) {
LOG.info("Deallocating local user for " + appUser + " for " + appId);
if (!appUserToLocalUser.containsKey(appUser)) {
// This should never happen
String errMsg = "deallocate: No local user allocation for appUser " +
appUser + ", appId " + appId;
LOG.error(errMsg);
return;
}

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whitespace:end of line

LocalUserInfo localUserInfo = appUserToLocalUser.get(appUser);
localUserInfo.appCount--;
LOG.info("Decremented appCount for appUser " + appUser +
" to " + localUserInfo.appCount);

checkAndDeallocateAppUser(appUser, localUserInfo);
}

/**
* Increment reference count for pending file operations
*/
synchronized public void incrementFileOpCount(String appUser) {
if (!appUserToLocalUser.containsKey(appUser)) {
String msg =
"incrementPendingFileOp: No local user allocation for appUser " +
appUser;
LOG.warn(msg);
return;
}
LocalUserInfo localUserInfo = appUserToLocalUser.get(appUser);
localUserInfo.fileOpCount++;
LOG.info("Incremented fileOpCount for appuser " + appUser +
" to " + localUserInfo.fileOpCount);
}

/**
* Decrement reference count for pending file operations
*/
synchronized public void decrementFileOpCount(String appUser) {
if (!appUserToLocalUser.containsKey(appUser)) {
String errMsg =
"decrementFileOpCount: No local user allocation for appUser " +
appUser;
LOG.warn(errMsg);
return;
}
LocalUserInfo localUserInfo = appUserToLocalUser.get(appUser);
localUserInfo.fileOpCount--;
LOG.info("Decremented fileOpCount for appUser " + appUser +
" to " + localUserInfo.fileOpCount);

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whitespace:end of line

checkAndDeallocateAppUser(appUser, localUserInfo);
}

/**
* Increment pending log handling (or aggregation) per application
*/
synchronized public void incrementLogHandlingCount(String appUser) {
if (!appUserToLocalUser.containsKey(appUser)) {
String errMsg =
"incrementLogHandlingCount: No local user allocation for appUser " +
appUser;
LOG.warn(errMsg);
return;
}
LocalUserInfo localUserInfo = appUserToLocalUser.get(appUser);
localUserInfo.logHandlingCount++;
LOG.info("Incremented logHandlingCount for appUser " + appUser +
" to " + localUserInfo.logHandlingCount);
}

/**
* Decrement pending log handling (or aggregation) per application
*/
synchronized public void decrementLogHandlingCount(String appUser) {
if (!appUserToLocalUser.containsKey(appUser)) {
String errMsg =
"decrementLogHandlingCount: No local user allocation for appUser " +
appUser;
LOG.warn(errMsg);
return;
}
LocalUserInfo localUserInfo = appUserToLocalUser.get(appUser);
localUserInfo.logHandlingCount--;
LOG.info("Decremented logHandlingCount for appUser " + appUser +
" to " + localUserInfo.logHandlingCount);

checkAndDeallocateAppUser(appUser, localUserInfo);
}

private void checkAndAllocateAppUser(String appUser) {
if (appUserToLocalUser.containsKey(appUser)) {
// If appUser exists, don't need to allocate again
return;
}

LOG.info("Allocating local user for appUser " + appUser);
// find the first empty slot in the pool of local users
int index = -1;
for (int i=0; i<localUserCount; ++i) {
if (!allocated.get(i)) {
index = i;
allocated.set(i, true);
break;
}
}
if (index == -1) {
String errMsg = "Cannot allocate local users from a pool of " +
localUserCount;

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whitespace:end of line

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whitespace:end of line

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whitespace:end of line

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whitespace:end of line

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whitespace:end of line

LOG.error(errMsg);
throw new RuntimeException(errMsg);
}
appUserToLocalUser.put(appUser,
new LocalUserInfo(localUserPrefix + index, index));
LOG.info("Allocated local user index " + index + " for appUser "
+ appUser);
}

private void checkAndDeallocateAppUser(String appUser, LocalUserInfo localUserInfo) {
if (localUserInfo.fileOpCount <= 0 &&
localUserInfo.appCount <= 0 &&
localUserInfo.logHandlingCount <= 0) {
appUserToLocalUser.remove(appUser);
allocated.set(localUserInfo.localUserIndex, false);
LOG.info("Deallocated local user index " + localUserInfo.localUserIndex +
" for appUser " + appUser);
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
import org.apache.hadoop.io.DataOutputBuffer;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.security.Credentials;
import org.apache.hadoop.security.UserGroupInformation;
import org.apache.hadoop.yarn.api.records.ApplicationAccessType;
import org.apache.hadoop.yarn.api.records.ApplicationId;
import org.apache.hadoop.yarn.api.records.ContainerExitStatus;
Expand All @@ -49,6 +50,7 @@
import org.apache.hadoop.yarn.proto.YarnServerNodemanagerRecoveryProtos.FlowContextProto;
import org.apache.hadoop.yarn.server.api.records.AppCollectorData;
import org.apache.hadoop.yarn.server.nodemanager.Context;
import org.apache.hadoop.yarn.server.nodemanager.SecureModeLocalUserAllocator;
import org.apache.hadoop.yarn.server.nodemanager.containermanager.AuxServicesEvent;
import org.apache.hadoop.yarn.server.nodemanager.containermanager.AuxServicesEventType;
import org.apache.hadoop.yarn.server.nodemanager.containermanager.container.Container;
Expand Down Expand Up @@ -86,6 +88,7 @@ public class ApplicationImpl implements Application {
private final ReadLock readLock;
private final WriteLock writeLock;
private final Context context;
private final SecureModeLocalUserAllocator secureModeLocalUserAllocator;

private static final Logger LOG =
LoggerFactory.getLogger(ApplicationImpl.class);
Expand Down Expand Up @@ -127,6 +130,15 @@ public ApplicationImpl(Dispatcher dispatcher, String user,
context.getNMTimelinePublisher().createTimelineClient(appId);
}
}
boolean secureModeUseLocalUser = UserGroupInformation.isSecurityEnabled() &&
conf.getBoolean(YarnConfiguration.NM_SECURE_MODE_USE_LOCAL_USER,
YarnConfiguration.DEFAULT_NM_SECURE_MODE_USE_LOCAL_USER);
if (secureModeUseLocalUser) {
secureModeLocalUserAllocator = SecureModeLocalUserAllocator.getInstance(conf);
}
else {
secureModeLocalUserAllocator = null;
}
this.context = context;
this.appStateStore = context.getNMStateStore();
ReentrantReadWriteLock lock = new ReentrantReadWriteLock();
Expand Down Expand Up @@ -336,6 +348,9 @@ static class AppInitTransition implements
SingleArcTransition<ApplicationImpl, ApplicationEvent> {
@Override
public void transition(ApplicationImpl app, ApplicationEvent event) {
if (app.secureModeLocalUserAllocator != null) {
app.secureModeLocalUserAllocator.allocate(app.user, app.appId.toString());
}
ApplicationInitEvent initEvent = (ApplicationInitEvent)event;
app.applicationACLs = initEvent.getApplicationACLs();
app.aclsManager.addApplication(app.getAppId(), app.applicationACLs);
Expand Down Expand Up @@ -607,13 +622,16 @@ private void updateCollectorStatus(ApplicationImpl app) {

@Override
public void transition(ApplicationImpl app, ApplicationEvent event) {

// Inform the logService
app.dispatcher.getEventHandler().handle(
new LogHandlerAppFinishedEvent(app.appId));

app.context.getNMTokenSecretManager().appFinished(app.getAppId());
updateCollectorStatus(app);

if (app.secureModeLocalUserAllocator != null) {
app.secureModeLocalUserAllocator.deallocate(app.user, app.appId.toString());
}
}
}

Expand Down
Loading