Skip to content

Bugfix/uf uid gid #320

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.

Sign up for GitHub

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
Feb 25, 2020
Merged

Bugfix/uf uid gid #320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
793c864
Fixing uid/gid on UF images; adding tests
Feb 24, 2020
bf1e310
Adding more tests
Feb 24, 2020
507b5ec
Forgot to add new test fixture
Feb 24, 2020
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
1 change: 1 addition & 0 deletions tests/fixtures/pwfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
changeme123
230 changes: 230 additions & 0 deletions tests/test_docker_splunk.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,6 +396,28 @@ def test_splunk_entrypoint_no_provision(self):
if cid:
self.client.remove_container(cid, v=True, force=True)

def test_splunk_uid_gid(self):
cid = None
try:
# Run container
cid = self.client.create_container(self.SPLUNK_IMAGE_NAME, tty=True, command="no-provision")
cid = cid.get("Id")
self.client.start(cid)
# Wait a bit
time.sleep(5)
# If the container is still running, we should be able to exec inside
# Check that the git SHA exists in /opt/ansible
exec_command = self.client.exec_create(cid, "id", user="splunk")
std_out = self.client.exec_start(exec_command)
assert "uid=41812" in std_out
assert "gid=41812" in std_out
except Exception as e:
self.logger.error(e)
raise e
finally:
if cid:
self.client.remove_container(cid, v=True, force=True)

def test_uf_entrypoint_help(self):
# Run container
cid = self.client.create_container(self.UF_IMAGE_NAME, tty=True, command="help")
Expand Down Expand Up @@ -452,6 +474,28 @@ def test_uf_entrypoint_no_provision(self):
if cid:
self.client.remove_container(cid, v=True, force=True)

def test_uf_uid_gid(self):
cid = None
try:
# Run container
cid = self.client.create_container(self.UF_IMAGE_NAME, tty=True, command="no-provision")
cid = cid.get("Id")
self.client.start(cid)
# Wait a bit
time.sleep(5)
# If the container is still running, we should be able to exec inside
# Check that the git SHA exists in /opt/ansible
exec_command = self.client.exec_create(cid, "id", user="splunk")
std_out = self.client.exec_start(exec_command)
assert "uid=41812" in std_out
assert "gid=41812" in std_out
except Exception as e:
self.logger.error(e)
raise e
finally:
if cid:
self.client.remove_container(cid, v=True, force=True)

def test_adhoc_1so_using_default_yml(self):
# Generate default.yml
cid = self.client.create_container(self.SPLUNK_IMAGE_NAME, tty=True, command="create-defaults")
Expand Down Expand Up @@ -811,6 +855,112 @@ def test_adhoc_1uf_change_tailed_files(self):
if cid:
self.client.remove_container(cid, v=True, force=True)

def test_adhoc_1so_password_from_file(self):
# Create a splunk container
cid = None
# From fixtures/pwfile
filePW = "changeme123"
try:
splunk_container_name = generate_random_string()
cid = self.client.create_container(self.SPLUNK_IMAGE_NAME, tty=True, ports=[8089],
volumes=["/var/secrets/pwfile"], name=splunk_container_name,
environment={
"DEBUG": "true",
"SPLUNK_START_ARGS": "--accept-license",
"SPLUNK_PASSWORD": "/var/secrets/pwfile"
},
host_config=self.client.create_host_config(binds=[FIXTURES_DIR + "/pwfile:/var/secrets/pwfile"],
port_bindings={8089: ("0.0.0.0",)})
)
cid = cid.get("Id")
self.client.start(cid)
# Poll for the container to be ready
assert self.wait_for_containers(1, name=splunk_container_name)
# Check splunkd
splunkd_port = self.client.port(cid, 8089)[0]["HostPort"]
url = "https://localhost:{}/services/server/info".format(splunkd_port)
kwargs = {"auth": ("admin", filePW), "verify": False}
status, content = self.handle_request_retry("GET", url, kwargs)
assert status == 200
except Exception as e:
self.logger.error(e)
raise e
finally:
if cid:
self.client.remove_container(cid, v=True, force=True)

def test_adhoc_1uf_password_from_file(self):
# Create a splunk container
cid = None
# From fixtures/pwfile
filePW = "changeme123"
try:
splunk_container_name = generate_random_string()
cid = self.client.create_container(self.UF_IMAGE_NAME, tty=True, ports=[8089],
volumes=["/var/secrets/pwfile"], name=splunk_container_name,
environment={
"DEBUG": "true",
"SPLUNK_START_ARGS": "--accept-license",
"SPLUNK_PASSWORD": "/var/secrets/pwfile"
},
host_config=self.client.create_host_config(binds=[FIXTURES_DIR + "/pwfile:/var/secrets/pwfile"],
port_bindings={8089: ("0.0.0.0",)})
)
cid = cid.get("Id")
self.client.start(cid)
# Poll for the container to be ready
assert self.wait_for_containers(1, name=splunk_container_name)
# Check splunkd
splunkd_port = self.client.port(cid, 8089)[0]["HostPort"]
url = "https://localhost:{}/services/server/info".format(splunkd_port)
kwargs = {"auth": ("admin", filePW), "verify": False}
status, content = self.handle_request_retry("GET", url, kwargs)
assert status == 200
except Exception as e:
self.logger.error(e)
raise e
finally:
if cid:
self.client.remove_container(cid, v=True, force=True)

def test_adhoc_1so_splunk_pass4symmkey(self):
# Create a splunk container
cid = None
try:
splunk_container_name = generate_random_string()
cid = self.client.create_container(self.SPLUNK_IMAGE_NAME, tty=True, ports=[8089], name=splunk_container_name,
environment={
"DEBUG": "true",
"SPLUNK_START_ARGS": "--accept-license",
"SPLUNK_PASSWORD": self.password,
"SPLUNK_PASS4SYMMKEY": "wubbalubbadubdub"
},
host_config=self.client.create_host_config(port_bindings={8089: ("0.0.0.0",)})
)
cid = cid.get("Id")
self.client.start(cid)
# Poll for the container to be ready
assert self.wait_for_containers(1, name=splunk_container_name)
# Check splunkd
splunkd_port = self.client.port(cid, 8089)[0]["HostPort"]
url = "https://localhost:{}/services/server/info".format(splunkd_port)
kwargs = {"auth": ("admin", self.password), "verify": False}
status, content = self.handle_request_retry("GET", url, kwargs)
assert status == 200
# Check the decrypted pass4SymmKey
exec_command = self.client.exec_create(cid, "cat /opt/splunk/etc/system/local/server.conf", user="splunk")
std_out = self.client.exec_start(exec_command)
pass4SymmKey = re.search(r'\[general\].*?pass4SymmKey = (.*?)\n', std_out, flags=re.MULTILINE|re.DOTALL).group(1).strip()
exec_command = self.client.exec_create(cid, "/opt/splunk/bin/splunk show-decrypted --value '{}'".format(pass4SymmKey), user="splunk")
std_out = self.client.exec_start(exec_command)
assert "wubbalubbadubdub" in std_out
except Exception as e:
self.logger.error(e)
raise e
finally:
if cid:
self.client.remove_container(cid, v=True, force=True)

def test_adhoc_1so_splunk_secret_env(self):
# Create a splunk container
cid = None
Expand Down Expand Up @@ -845,6 +995,44 @@ def test_adhoc_1so_splunk_secret_env(self):
finally:
if cid:
self.client.remove_container(cid, v=True, force=True)

def test_adhoc_1uf_splunk_pass4symmkey(self):
# Create a splunk container
cid = None
try:
splunk_container_name = generate_random_string()
cid = self.client.create_container(self.UF_IMAGE_NAME, tty=True, ports=[8089], name=splunk_container_name,
environment={
"DEBUG": "true",
"SPLUNK_START_ARGS": "--accept-license",
"SPLUNK_PASSWORD": self.password,
"SPLUNK_PASS4SYMMKEY": "wubbalubbadubdub"
},
host_config=self.client.create_host_config(port_bindings={8089: ("0.0.0.0",)})
)
cid = cid.get("Id")
self.client.start(cid)
# Poll for the container to be ready
assert self.wait_for_containers(1, name=splunk_container_name)
# Check splunkd
splunkd_port = self.client.port(cid, 8089)[0]["HostPort"]
url = "https://localhost:{}/services/server/info".format(splunkd_port)
kwargs = {"auth": ("admin", self.password), "verify": False}
status, content = self.handle_request_retry("GET", url, kwargs)
assert status == 200
# Check the decrypted pass4SymmKey
exec_command = self.client.exec_create(cid, "cat /opt/splunkforwarder/etc/system/local/server.conf", user="splunk")
std_out = self.client.exec_start(exec_command)
pass4SymmKey = re.search(r'\[general\].*?pass4SymmKey = (.*?)\n', std_out, flags=re.MULTILINE|re.DOTALL).group(1).strip()
exec_command = self.client.exec_create(cid, "/opt/splunkforwarder/bin/splunk show-decrypted --value '{}'".format(pass4SymmKey), user="splunk")
std_out = self.client.exec_start(exec_command)
assert "wubbalubbadubdub" in std_out
except Exception as e:
self.logger.error(e)
raise e
finally:
if cid:
self.client.remove_container(cid, v=True, force=True)

def test_adhoc_1uf_splunk_secret_env(self):
# Create a uf container
Expand Down Expand Up @@ -2373,6 +2561,48 @@ def test_compose_3idx1cm_custom_repl_factor(self):
os.remove(os.path.join(SCENARIOS_DIR, "defaults", "default.yml"))
except OSError as e:
pass

def test_adhoc_1cm_idxc_pass4symmkey(self):
# Create the container
cid = None
try:
splunk_container_name = generate_random_string()
cid = self.client.create_container(self.SPLUNK_IMAGE_NAME, tty=True, ports=[8089], name=splunk_container_name,
environment={
"DEBUG": "true",
"SPLUNK_START_ARGS": "--accept-license",
"SPLUNK_PASSWORD": self.password,
"SPLUNK_ROLE": "splunk_cluster_master",
"SPLUNK_INDEXER_URL": "idx1",
"SPLUNK_IDXC_PASS4SYMMKEY": "keepsummerbeingliketotallystokedaboutlikethegeneralvibeandstuff",
"SPLUNK_IDXC_LABEL": "keepsummersafe",
},
host_config=self.client.create_host_config(port_bindings={8089: ("0.0.0.0",)})
)
cid = cid.get("Id")
self.client.start(cid)
# Poll for the container to be ready
assert self.wait_for_containers(1, name=splunk_container_name)
# Check splunkd
splunkd_port = self.client.port(cid, 8089)[0]["HostPort"]
url = "https://localhost:{}/services/server/info".format(splunkd_port)
kwargs = {"auth": ("admin", self.password), "verify": False}
status, content = self.handle_request_retry("GET", url, kwargs)
assert status == 200
# Check if the cluster label and pass4SymmKey line up
exec_command = self.client.exec_create(cid, "cat /opt/splunk/etc/system/local/server.conf", user="splunk")
std_out = self.client.exec_start(exec_command)
assert "cluster_label = keepsummersafe" in std_out
pass4SymmKey = re.search(r'\[clustering\].*?pass4SymmKey = (.*?)\n', std_out, flags=re.MULTILINE|re.DOTALL).group(1).strip()
exec_command = self.client.exec_create(cid, "/opt/splunk/bin/splunk show-decrypted --value '{}'".format(pass4SymmKey), user="splunk")
std_out = self.client.exec_start(exec_command)
assert "keepsummerbeingliketotallystokedaboutlikethegeneralvibeandstuff" in std_out
except Exception as e:
self.logger.error(e)
raise e
finally:
if cid:
self.client.remove_container(cid, v=True, force=True)

def test_compose_1cm_smartstore(self):
# Generate default.yml
Expand Down
10 changes: 8 additions & 2 deletions uf/common-files/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@ COPY uf/common-files/apps ${SPLUNK_HOME}-etc/apps/
FROM ${SPLUNK_BASE_IMAGE}:latest as bare
LABEL maintainer="support@splunk.com"

# Currently kubernetes only accepts UID and not USER field to
# start a container as a particular user. So we create Splunk
# user with pre-determined UID.
ARG UID=41812
ARG GID=41812

ENV SPLUNK_HOME=/opt/splunkforwarder \
SPLUNK_GROUP=splunk \
SPLUNK_USER=splunk
Expand All @@ -44,8 +50,8 @@ ENV SPLUNK_HOME=/opt/splunkforwarder \
COPY [ "splunk/common-files/updateetc.sh", "/sbin/"]

# Setup users and groups
RUN groupadd -r ${SPLUNK_GROUP} \
&& useradd -r -m -g ${SPLUNK_GROUP} ${SPLUNK_USER} \
RUN groupadd -r -g ${GID} ${SPLUNK_GROUP} \
&& useradd -r -m -u ${UID} -g ${GID} ${SPLUNK_USER} \
&& chmod 755 /sbin/updateetc.sh

# Copy files from package
Expand Down