Skip to content

Grant server read/write permissions on shared data path "path.shared_data". #131680

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

Merged
merged 3 commits into from
Jul 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/changelog/131680.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
pr: 131680
summary: Grant server module read/write entitlements for deprecated path setting "path.shared_data"
area: Infra/Core
type: bug
issues: []
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ public class EntitlementBootstrap {
* @param scopeResolver a functor to map a Java Class to the component and module it belongs to.
* @param settingResolver a functor to resolve a setting name pattern for one or more Elasticsearch settings.
* @param dataDirs data directories for Elasticsearch
* @param sharedDataDir shared data directory for Elasticsearch (deprecated)
* @param sharedRepoDirs shared repository directories for Elasticsearch
* @param configDir the config directory for Elasticsearch
* @param libDir the lib directory for Elasticsearch
Expand All @@ -63,6 +64,7 @@ public static void bootstrap(
Function<Class<?>, PolicyManager.PolicyScope> scopeResolver,
Function<String, Stream<String>> settingResolver,
Path[] dataDirs,
Path sharedDataDir,
Path[] sharedRepoDirs,
Path configDir,
Path libDir,
Expand All @@ -82,6 +84,7 @@ public static void bootstrap(
getUserHome(),
configDir,
dataDirs,
sharedDataDir,
sharedRepoDirs,
libDir,
modulesDir,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
import static org.elasticsearch.entitlement.runtime.policy.PathLookup.BaseDir.LOGS;
import static org.elasticsearch.entitlement.runtime.policy.PathLookup.BaseDir.MODULES;
import static org.elasticsearch.entitlement.runtime.policy.PathLookup.BaseDir.PLUGINS;
import static org.elasticsearch.entitlement.runtime.policy.PathLookup.BaseDir.SHARED_DATA;
import static org.elasticsearch.entitlement.runtime.policy.PathLookup.BaseDir.SHARED_REPO;
import static org.elasticsearch.entitlement.runtime.policy.Platform.LINUX;
import static org.elasticsearch.entitlement.runtime.policy.entitlements.FilesEntitlement.Mode.READ;
Expand All @@ -57,6 +58,7 @@ private static List<Scope> createServerEntitlements(Path pidFile) {
FilesEntitlement.FileData.ofBaseDirPath(LOGS, READ_WRITE),
FilesEntitlement.FileData.ofBaseDirPath(LIB, READ),
FilesEntitlement.FileData.ofBaseDirPath(DATA, READ_WRITE),
FilesEntitlement.FileData.ofBaseDirPath(SHARED_DATA, READ_WRITE),
FilesEntitlement.FileData.ofBaseDirPath(SHARED_REPO, READ_WRITE),
// exclusive settings file
FilesEntitlement.FileData.ofRelativePath(Path.of("operator/settings.json"), CONFIG, READ_WRITE).withExclusive(true),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ enum BaseDir {
USER_HOME,
CONFIG,
DATA,
SHARED_DATA,
SHARED_REPO,
LIB,
MODULES,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ public record PathLookupImpl(
Path homeDir,
Path configDir,
Path[] dataDirs,
Path sharedDataDir,
Path[] sharedRepoDirs,
Path libDir,
Path modulesDir,
Expand Down Expand Up @@ -56,6 +57,7 @@ public Stream<Path> getBaseDirPaths(BaseDir baseDir) {
return switch (baseDir) {
case USER_HOME -> Stream.of(homeDir);
case DATA -> Arrays.stream(dataDirs);
case SHARED_DATA -> Stream.ofNullable(sharedDataDir);
case SHARED_REPO -> Arrays.stream(sharedRepoDirs);
case CONFIG -> Stream.of(configDir);
case LIB -> Stream.of(libDir);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ public static void beforeClass() {
testBaseDir.resolve("user/home"),
TEST_CONFIG_DIR,
new Path[] { testBaseDir.resolve("data1"), testBaseDir.resolve("data2") },
Path.of("/shareddata"),
new Path[] { testBaseDir.resolve("shared1"), testBaseDir.resolve("shared2") },
TEST_LIBS_DIR,
testBaseDir.resolve("modules"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ private static Path path(String s) {
Path.of("/home"),
Path.of("/config"),
new Path[] { Path.of("/data1"), Path.of("/data2") },
Path.of("/shareddata"),
new Path[] { Path.of("/shared1"), Path.of("/shared2") },
Path.of("/lib"),
Path.of("/modules"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ public static void beforeClass() {
baseDir.resolve("/user/home"),
baseDir.resolve("/config"),
new Path[] { baseDir.resolve("/data1/"), baseDir.resolve("/data2") },
Path.of("/shareddata"),
new Path[] { baseDir.resolve("/shared1"), baseDir.resolve("/shared2") },
baseDir.resolve("/lib"),
baseDir.resolve("/modules"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ public static void setupRoot() {
Path.of("/home"),
Path.of("/config"),
new Path[] { Path.of("/data1"), Path.of("/data2") },
Path.of("/shareddata"),
new Path[] { Path.of("/shared1"), Path.of("/shared2") },
Path.of("/lib"),
Path.of("/modules"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,7 @@ private static void initPhase2(Bootstrap bootstrap) throws IOException {
scopeResolver::resolveClassToScope,
nodeEnv.settings()::getValues,
nodeEnv.dataDirs(),
nodeEnv.sharedDataDir(),
nodeEnv.repoDirs(),
nodeEnv.configDir(),
nodeEnv.libDir(),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@
import org.elasticsearch.bootstrap.TestBuildInfo;
import org.elasticsearch.bootstrap.TestBuildInfoParser;
import org.elasticsearch.bootstrap.TestScopeResolver;
import org.elasticsearch.common.Strings;
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.core.Booleans;
import org.elasticsearch.core.Nullable;
import org.elasticsearch.core.PathUtils;
import org.elasticsearch.core.Strings;
import org.elasticsearch.core.SuppressForbidden;
import org.elasticsearch.entitlement.initialization.EntitlementInitialization;
import org.elasticsearch.entitlement.runtime.policy.PathLookup;
Expand Down Expand Up @@ -54,6 +54,7 @@
import static org.elasticsearch.env.Environment.PATH_DATA_SETTING;
import static org.elasticsearch.env.Environment.PATH_HOME_SETTING;
import static org.elasticsearch.env.Environment.PATH_REPO_SETTING;
import static org.elasticsearch.env.Environment.PATH_SHARED_DATA_SETTING;

public class TestEntitlementBootstrap {

Expand Down Expand Up @@ -85,10 +86,12 @@ public static void registerNodeBaseDirs(Settings settings, Path configPath) {
Path homeDir = absolutePath(PATH_HOME_SETTING.get(settings));
Path configDir = configPath != null ? configPath : homeDir.resolve("config");
Collection<Path> dataDirs = dataDirs(settings, homeDir);
Collection<Path> sharedDataDir = sharedDataDir(settings);
Collection<Path> repoDirs = repoDirs(settings);
logger.debug("Registering node dirs: config [{}], dataDirs [{}], repoDirs [{}]", configDir, dataDirs, repoDirs);
baseDirPaths.compute(BaseDir.CONFIG, baseDirModifier(paths -> paths.add(configDir)));
baseDirPaths.compute(BaseDir.DATA, baseDirModifier(paths -> paths.addAll(dataDirs)));
baseDirPaths.compute(BaseDir.SHARED_DATA, baseDirModifier(paths -> paths.addAll(sharedDataDir)));
baseDirPaths.compute(BaseDir.SHARED_REPO, baseDirModifier(paths -> paths.addAll(repoDirs)));
policyManager.reset();
}
Expand All @@ -100,10 +103,12 @@ public static void unregisterNodeBaseDirs(Settings settings, Path configPath) {
Path homeDir = absolutePath(PATH_HOME_SETTING.get(settings));
Path configDir = configPath != null ? configPath : homeDir.resolve("config");
Collection<Path> dataDirs = dataDirs(settings, homeDir);
Collection<Path> sharedDataDir = sharedDataDir(settings);
Collection<Path> repoDirs = repoDirs(settings);
logger.debug("Unregistering node dirs: config [{}], dataDirs [{}], repoDirs [{}]", configDir, dataDirs, repoDirs);
baseDirPaths.compute(BaseDir.CONFIG, baseDirModifier(paths -> paths.remove(configDir)));
baseDirPaths.compute(BaseDir.DATA, baseDirModifier(paths -> paths.removeAll(dataDirs)));
baseDirPaths.compute(BaseDir.SHARED_DATA, baseDirModifier(paths -> paths.removeAll(sharedDataDir)));
baseDirPaths.compute(BaseDir.SHARED_REPO, baseDirModifier(paths -> paths.removeAll(repoDirs)));
policyManager.reset();
}
Expand All @@ -115,6 +120,11 @@ private static Collection<Path> dataDirs(Settings settings, Path homeDir) {
: dataDirs.stream().map(TestEntitlementBootstrap::absolutePath).toList();
}

private static Collection<Path> sharedDataDir(Settings settings) {
String sharedDataDir = PATH_SHARED_DATA_SETTING.get(settings);
return Strings.hasText(sharedDataDir) ? List.of(absolutePath(sharedDataDir)) : List.of();
}

private static Collection<Path> repoDirs(Settings settings) {
return PATH_REPO_SETTING.get(settings).stream().map(TestEntitlementBootstrap::absolutePath).toList();
}
Expand Down
Loading