Skip to content

Ability to connect to Redis Sentinel for Cache, PageCache and Session #11222

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

Closed
Closed
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
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,26 @@ class Config implements \Cm\RedisSession\Handler\ConfigInterface
*/
const PARAM_BREAK_AFTER = 'session/redis/break_after';

/**
* Configuration path for number of seconds to wait before completely failing to break the lock
*/
const PARAM_FAIL_AFTER = 'session/redis/fail_after';

/**
* The name of master to reach via Sentinel servers.
*/
const PARAM_SENTINEL_MASTER = 'session/redis/sentinel_master';

/**
* Configuration path indicating if master status should be verified during connections.
*/
const PARAM_SENTINEL_VERIFY_MASTER = 'session/redis/sentinel_master_verify';

/**
* Configuration path indicating the number of connect retries for sentinel servers connection.
*/
const PARAM_SENTINEL_CONNECT_RETRIES = 'session/redis/sentinel_connect_retries';

/**
* Cookie lifetime config path
*/
Expand Down Expand Up @@ -300,10 +320,52 @@ public function getLifetime()
}

/**
* {@inheritdoc}
* Get number of seconds to wait before completely failing to break the lock
*
* @return int
*/
public function getFailAfter()
{
return self::DEFAULT_FAIL_AFTER;
return $this->deploymentConfig->get(self::PARAM_FAIL_AFTER . '_' . $this->appState->getAreaCode());
}

/**
* Get list of redis sentinels
*
* @return string
*/
public function getSentinelServers()
{
return $this->getHost();
}

/**
* Get sentinel master name
*
* @return string
*/
public function getSentinelMaster()
{
return $this->deploymentConfig->get(self::PARAM_SENTINEL_MASTER);
}

/**
* Verify master status flag
*
* @return string
*/
public function getSentinelVerifyMaster()
{
return $this->deploymentConfig->get(self::PARAM_SENTINEL_VERIFY_MASTER);
}

/**
* Connection retries for sentinels
*
* @return string
*/
public function getSentinelConnectRetries()
{
return $this->deploymentConfig->get(self::PARAM_SENTINEL_CONNECT_RETRIES);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,20 @@ public function testBreakAfter()
$this->assertEquals($this->config->getBreakAfter(), $breakAfter);
}

public function testFailAfter()
{
$areaCode = 'frontend';
$breakAfter = 5;
$this->deploymentConfigMock->expects($this->once())
->method('get')
->with(Config::PARAM_FAIL_AFTER . '_' . $areaCode)
->willReturn($breakAfter);
$this->appStateMock->expects($this->once())
->method('getAreaCode')
->willReturn($areaCode);
$this->assertEquals($this->config->getFailAfter(), $breakAfter);
}

public function testGetLifetimeAdmin()
{
$areaCode = 'adminhtml';
Expand Down Expand Up @@ -246,4 +260,44 @@ public function testGetLifetimeFrontend()
->willReturn($expectedLifetime);
$this->assertEquals($this->config->getLifetime(), $expectedLifetime);
}

public function testGetSentinelServers()
{
$expected = 'tcp://127.0.0.1:26379,tcp://127.0.0.2:26379';
$this->deploymentConfigMock->expects($this->once())
->method('get')
->with(Config::PARAM_HOST)
->willReturn($expected);
$this->assertEquals($this->config->getSentinelServers(), $expected);
}

public function testGetSentinelMaster()
{
$expected = 'redismaster';
$this->deploymentConfigMock->expects($this->once())
->method('get')
->with(Config::PARAM_SENTINEL_MASTER)
->willReturn($expected);
$this->assertEquals($this->config->getSentinelMaster(), $expected);
}

public function testGetSentinelVerifyMaster()
{
$expected = '1';
$this->deploymentConfigMock->expects($this->once())
->method('get')
->with(Config::PARAM_SENTINEL_VERIFY_MASTER)
->willReturn($expected);
$this->assertEquals($this->config->getSentinelVerifyMaster(), $expected);
}

public function testGetSentinelConnectRetries()
{
$expected = '3';
$this->deploymentConfigMock->expects($this->once())
->method('get')
->with(Config::PARAM_SENTINEL_CONNECT_RETRIES)
->willReturn($expected);
$this->assertEquals($this->config->getSentinelConnectRetries(), $expected);
}
}
55 changes: 52 additions & 3 deletions setup/src/Magento/Setup/Model/ConfigOptionsList/Cache.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,30 @@ class Cache implements ConfigOptionsListInterface
const INPUT_KEY_CACHE_BACKEND_REDIS_SERVER = 'cache-backend-redis-server';
const INPUT_KEY_CACHE_BACKEND_REDIS_DATABASE = 'cache-backend-redis-db';
const INPUT_KEY_CACHE_BACKEND_REDIS_PORT = 'cache-backend-redis-port';
const INPUT_KEY_CACHE_BACKEND_REDIS_SENTINEL_MASTER = 'cache-backend-redis-sentinel-master';
const INPUT_KEY_CACHE_BACKEND_REDIS_SENTINEL_MASTER_VERIFY = 'cache-backend-redis-sentinel-master-verify';
const INPUT_KEY_CACHE_BACKEND_REDIS_SENTINEL_LOAD_FROM_SLAVES= 'cache-backend-redis-sentinel-load-from-slaves';

const CONFIG_PATH_CACHE_BACKEND = 'cache/frontend/default/backend';
const CONFIG_PATH_CACHE_BACKEND_SERVER = 'cache/frontend/default/backend_options/server';
const CONFIG_PATH_CACHE_BACKEND_DATABASE = 'cache/frontend/default/backend_options/database';
const CONFIG_PATH_CACHE_BACKEND_PORT = 'cache/frontend/default/backend_options/port';
const CONFIG_PATH_CACHE_BACKEND_REDIS_SENTINEL_MASTER = 'cache/frontend/default/backend_options/sentinel_master';
const CONFIG_PATH_CACHE_BACKEND_REDIS_SENTINEL_MASTER_VERIFY =
'cache/frontend/default/backend_options/sentinel_master_verify';
const CONFIG_PATH_CACHE_BACKEND_REDIS_SENTINEL_LOAD_FROM_SLAVES =
'cache/frontend/default/backend_options/load_from_slaves';

/**
* @var array
*/
private $defaultConfigValues = [
self::INPUT_KEY_CACHE_BACKEND_REDIS_SERVER => '127.0.0.1',
self::INPUT_KEY_CACHE_BACKEND_REDIS_DATABASE => '0',
self::INPUT_KEY_CACHE_BACKEND_REDIS_PORT => '6379'
self::INPUT_KEY_CACHE_BACKEND_REDIS_PORT => '6379',
self::INPUT_KEY_CACHE_BACKEND_REDIS_SENTINEL_MASTER => null,
self::INPUT_KEY_CACHE_BACKEND_REDIS_SENTINEL_MASTER_VERIFY => null,
self::INPUT_KEY_CACHE_BACKEND_REDIS_SENTINEL_LOAD_FROM_SLAVES => null,
];

/**
Expand All @@ -55,6 +66,11 @@ class Cache implements ConfigOptionsListInterface
self::INPUT_KEY_CACHE_BACKEND_REDIS_SERVER => self::CONFIG_PATH_CACHE_BACKEND_SERVER,
self::INPUT_KEY_CACHE_BACKEND_REDIS_DATABASE => self::CONFIG_PATH_CACHE_BACKEND_DATABASE,
self::INPUT_KEY_CACHE_BACKEND_REDIS_PORT => self::CONFIG_PATH_CACHE_BACKEND_PORT,
self::INPUT_KEY_CACHE_BACKEND_REDIS_SENTINEL_MASTER => self::CONFIG_PATH_CACHE_BACKEND_REDIS_SENTINEL_MASTER,
self::INPUT_KEY_CACHE_BACKEND_REDIS_SENTINEL_MASTER_VERIFY =>
self::CONFIG_PATH_CACHE_BACKEND_REDIS_SENTINEL_MASTER_VERIFY,
self::INPUT_KEY_CACHE_BACKEND_REDIS_SENTINEL_LOAD_FROM_SLAVES =>
self::CONFIG_PATH_CACHE_BACKEND_REDIS_SENTINEL_LOAD_FROM_SLAVES,
];

/**
Expand Down Expand Up @@ -102,7 +118,26 @@ public function getOptions()
TextConfigOption::FRONTEND_WIZARD_TEXT,
self::CONFIG_PATH_CACHE_BACKEND_PORT,
'Redis server listen port'
)
),
new TextConfigOption(
self::INPUT_KEY_CACHE_BACKEND_REDIS_SENTINEL_MASTER,
TextConfigOption::FRONTEND_WIZARD_TEXT,
self::CONFIG_PATH_CACHE_BACKEND_REDIS_SENTINEL_MASTER,
'Redis sentinel master'
),
new TextConfigOption(
self::INPUT_KEY_CACHE_BACKEND_REDIS_SENTINEL_MASTER_VERIFY,
TextConfigOption::FRONTEND_WIZARD_TEXT,
self::CONFIG_PATH_CACHE_BACKEND_REDIS_SENTINEL_MASTER_VERIFY,
'Verify connected server is actually master'
),
new TextConfigOption(
self::INPUT_KEY_CACHE_BACKEND_REDIS_SENTINEL_LOAD_FROM_SLAVES,
TextConfigOption::FRONTEND_WIZARD_TEXT,
self::CONFIG_PATH_CACHE_BACKEND_REDIS_SENTINEL_LOAD_FROM_SLAVES,
'Using the value \'1\' indicates to only load from slaves and \'2\' ' .
'to include the master in the random read slave selection'
),
];
}

Expand Down Expand Up @@ -191,7 +226,21 @@ private function validateRedisConfig(array $options, DeploymentConfig $deploymen
$this->getDefaultConfigValue(self::INPUT_KEY_CACHE_BACKEND_REDIS_DATABASE)
);

return $this->redisValidator->isValidConnection($config);
$config['sentinel_master'] = isset($options[self::INPUT_KEY_CACHE_BACKEND_REDIS_SENTINEL_MASTER])
? $options[self::INPUT_KEY_CACHE_BACKEND_REDIS_SENTINEL_MASTER]
: $deploymentConfig->get(
self::CONFIG_PATH_CACHE_BACKEND_REDIS_SENTINEL_MASTER,
$this->getDefaultConfigValue(self::INPUT_KEY_CACHE_BACKEND_REDIS_SENTINEL_MASTER)
);

$config['sentinel_master_verify'] = isset($options[self::INPUT_KEY_CACHE_BACKEND_REDIS_SENTINEL_MASTER_VERIFY])
? $options[self::INPUT_KEY_CACHE_BACKEND_REDIS_SENTINEL_MASTER_VERIFY]
: $deploymentConfig->get(
self::CONFIG_PATH_CACHE_BACKEND_REDIS_SENTINEL_MASTER_VERIFY,
$this->getDefaultConfigValue(self::CONFIG_PATH_CACHE_BACKEND_REDIS_SENTINEL_MASTER_VERIFY)
);

return $this->redisValidator->isValidConnection(array_filter($config));
}

/**
Expand Down
63 changes: 58 additions & 5 deletions setup/src/Magento/Setup/Model/ConfigOptionsList/PageCache.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,22 @@ class PageCache implements ConfigOptionsListInterface
const INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_DATABASE = 'page-cache-redis-db';
const INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_PORT = 'page-cache-redis-port';
const INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_COMPRESS_DATA = 'page-cache-redis-compress-data';
const INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_SENTINEL_MASTER = 'page-cache-redis-sentinel-master';
const INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_SENTINEL_MASTER_VERIFY = 'page-cache-redis-sentinel-master-verify';
const INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_SENTINEL_LOAD_FROM_SLAVES= 'page-cache-redis-sentinel-load-from-slaves';

const CONFIG_PATH_PAGE_CACHE_BACKEND = 'cache/frontend/page_cache/backend';
const CONFIG_PATH_PAGE_CACHE_BACKEND_SERVER = 'cache/frontend/page_cache/backend_options/server';
const CONFIG_PATH_PAGE_CACHE_BACKEND_DATABASE = 'cache/frontend/page_cache/backend_options/database';
const CONFIG_PATH_PAGE_CACHE_BACKEND_PORT = 'cache/frontend/page_cache/backend_options/port';
const CONFIG_PATH_PAGE_CACHE_BACKEND_COMPRESS_DATA = 'cache/frontend/page_cache/backend_options/compress_data';
const CONFIG_PATH_PAGE_CACHE_BACKEND_COMPRESS_DATA =
'cache/frontend/page_cache/backend_options/compress_data';
const CONFIG_PATH_PAGE_CACHE_BACKEND_REDIS_SENTINEL_MASTER =
'cache/frontend/page_cache/backend_options/sentinel_master';
const CONFIG_PATH_PAGE_CACHE_BACKEND_REDIS_SENTINEL_MASTER_VERIFY =
'cache/frontend/page_cache/backend_options/sentinel_master_verify';
const CONFIG_PATH_PAGE_CACHE_BACKEND_REDIS_SENTINEL_LOAD_FROM_SLAVES =
'cache/frontend/page_cache/backend_options/load_from_slaves';

/**
* @var array
Expand All @@ -41,7 +51,10 @@ class PageCache implements ConfigOptionsListInterface
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_SERVER => '127.0.0.1',
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_DATABASE => '1',
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_PORT => '6379',
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_COMPRESS_DATA => '0'
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_COMPRESS_DATA => '0',
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_SENTINEL_MASTER => null,
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_SENTINEL_MASTER_VERIFY => null,
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_SENTINEL_LOAD_FROM_SLAVES => null,
];

/**
Expand All @@ -58,7 +71,13 @@ class PageCache implements ConfigOptionsListInterface
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_SERVER => self::CONFIG_PATH_PAGE_CACHE_BACKEND_SERVER,
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_DATABASE => self::CONFIG_PATH_PAGE_CACHE_BACKEND_DATABASE,
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_PORT => self::CONFIG_PATH_PAGE_CACHE_BACKEND_PORT,
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_COMPRESS_DATA => self::CONFIG_PATH_PAGE_CACHE_BACKEND_COMPRESS_DATA
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_COMPRESS_DATA => self::CONFIG_PATH_PAGE_CACHE_BACKEND_COMPRESS_DATA,
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_SENTINEL_MASTER =>
self::CONFIG_PATH_PAGE_CACHE_BACKEND_REDIS_SENTINEL_MASTER,
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_SENTINEL_MASTER_VERIFY =>
self::CONFIG_PATH_PAGE_CACHE_BACKEND_REDIS_SENTINEL_MASTER_VERIFY,
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_SENTINEL_LOAD_FROM_SLAVES =>
self::CONFIG_PATH_PAGE_CACHE_BACKEND_REDIS_SENTINEL_LOAD_FROM_SLAVES,
];

/**
Expand Down Expand Up @@ -112,7 +131,26 @@ public function getOptions()
TextConfigOption::FRONTEND_WIZARD_TEXT,
self::CONFIG_PATH_PAGE_CACHE_BACKEND_COMPRESS_DATA,
'Set to 1 to compress the full page cache (use 0 to disable)'
)
),
new TextConfigOption(
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_SENTINEL_MASTER,
TextConfigOption::FRONTEND_WIZARD_TEXT,
self::CONFIG_PATH_PAGE_CACHE_BACKEND_REDIS_SENTINEL_MASTER,
'Redis sentinel master'
),
new TextConfigOption(
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_SENTINEL_MASTER_VERIFY,
TextConfigOption::FRONTEND_WIZARD_TEXT,
self::CONFIG_PATH_PAGE_CACHE_BACKEND_REDIS_SENTINEL_MASTER_VERIFY,
'Verify connected server is actually master'
),
new TextConfigOption(
self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_SENTINEL_LOAD_FROM_SLAVES,
TextConfigOption::FRONTEND_WIZARD_TEXT,
self::CONFIG_PATH_PAGE_CACHE_BACKEND_REDIS_SENTINEL_LOAD_FROM_SLAVES,
'Using the value \'1\' indicates to only load from slaves ' .
'and \'2\' to include the master in the random read slave selection'
),
];
}

Expand Down Expand Up @@ -202,7 +240,22 @@ private function validateRedisConfig(array $options, DeploymentConfig $deploymen
$this->getDefaultConfigValue(self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_DATABASE)
);

return $this->redisValidator->isValidConnection($config);
$config['sentinel_master'] = isset($options[self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_SENTINEL_MASTER])
? $options[self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_SENTINEL_MASTER]
: $deploymentConfig->get(
self::CONFIG_PATH_PAGE_CACHE_BACKEND_REDIS_SENTINEL_MASTER,
null
);

$config['sentinel_master_verify'] =
isset($options[self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_SENTINEL_MASTER_VERIFY])
? $options[self::INPUT_KEY_PAGE_CACHE_BACKEND_REDIS_SENTINEL_MASTER_VERIFY]
: $deploymentConfig->get(
self::CONFIG_PATH_PAGE_CACHE_BACKEND_REDIS_SENTINEL_MASTER_VERIFY,
null
);

return $this->redisValidator->isValidConnection(array_filter($config));
}

/**
Expand Down
Loading