UNCLASSIFIED - NO CUI

Skip to content
Snippets Groups Projects
Commit d3eb2e6c authored by Shawn's avatar Shawn
Browse files

init

parent 4c3ead75
No related branches found
No related tags found
3 merge requests!28Development,!27Updated operator,!26custom spark operator image to run on k8s
Pipeline #3555211 passed with warnings
# Changelog
All notable changes to this project will be documented in this file. See [conventional commits](https://www.conventionalcommits.org/) for commit guidelines.
- - -
## 1.3.8-3.1.1 - 2023-06-22
#### Bug Fixes
- add required env vars to the container image - (987d497) - Timothy J. Miller
- update gencerts to current version - (2f6fd53) - Timothy J. Miller
- update resource references - (6a393b5) - Timothy J. Miller
- add spark and java so the thing actually works - (98f2391) - Timothy J. Miller
#### Documentation
- fix whoopsie - (6a15552) - Timothy J. Miller
- updated readme - (edd81af) - Timothy J. Miller
#### Miscellaneous Chores
- update documentation link - (db457b6) - Timothy J. Miller
- cleanup dead code - (5b5c648) - Timothy J. Miller
- update base spark-operator image - (ccb246e) - Timothy J. Miller
- bump ubi8 version - (437b3b3) - Timothy J. Miller
#### Performance Improvements
- tini layer change - (6af3ced) - Timothy J. Miller
#### Style
- formatting for humans - (0a67d84) - Timothy J. Miller
- - -
Changelog generated by [cocogitto](https://github.com/cocogitto/cocogitto).
\ No newline at end of file
ARG BASE_REGISTRY=registry1.dso.mil
ARG BASE_IMAGE=ironbank/redhat/ubi/ubi9
ARG BASE_TAG=9.4
ARG BASE_IMAGE=ironbank/redhat/openjdk/openjdk17-runtime-ubi9-slim
ARG BASE_TAG=1.17
FROM ghcr.io/googlecloudplatform/spark-operator:v1beta2-1.3.8-3.1.1 as base
FROM apache/spark:3.4.1 as spark
FROM ${BASE_REGISTRY}/${BASE_IMAGE}:${BASE_TAG}
RUN dnf update -y --nodocs && \
dnf clean all && \
ENV SPARK_HOME=/opt/spark
USER root
RUN microdnf install -y openssl shadow
RUN microdnf upgrade -y && \
microdnf clean all && \
rm -rf /var/cache/dnf
COPY --from=base /usr/bin/spark-operator /usr/bin/
COPY --from=spark /opt/spark /opt/spark/
COPY tini /usr/bin/
RUN chmod +x /usr/bin/tini
COPY scripts/gencerts.sh /usr/bin/
RUN chmod +x /usr/bin/gencerts.sh
COPY scripts/entrypoint.sh /usr/bin/
RUN chmod +x /usr/bin/entrypoint.sh
RUN find / -path /proc -prune -o -perm /4000 -exec chmod u-s {} \;
RUN find / -path /proc -prune -o -perm /2000 -exec chmod g-s {} \;
RUN groupadd -r spark-operator && useradd -r -g spark-operator spark-operator
RUN chown -R spark-operator /usr/bin
COPY scripts/oscap-fixes/*.sh /oscap-fixes/
RUN /oscap-fixes/xccdf_org.ssgproject.content_rule_file_ownership_binary_dirs.sh && \
/oscap-fixes/xccdf_org.ssgproject.content_rule_file_permissions_binary_dirs.sh
USER spark-operator
USER nobody
ENTRYPOINT ["/usr/bin/entrypoint.sh"]
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
<<<<<<< HEAD
boilerplate notice, with the fields enclosed by brackets "[]"
=======
boilerplate notice, with the fields enclosed by brackets "{}"
>>>>>>> binary-testing
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
<<<<<<< HEAD
Copyright [yyyy] [name of copyright owner]
=======
Copyright 2020 Ironbank Containers / Kubeflow / metadata / watcher
>>>>>>> binary-testing
Licensed 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
<<<<<<< HEAD
limitations under the License.
=======
limitations under the License.
>>>>>>> binary-testing
Makefile 0 → 100644
.PHONY: history
ORIGINAL=ghcr.io/googlecloudplatform/spark-operator@sha256:461336fa7e91c5127f29c06143400a911daf0bdbae2b3bea917cbd5cff0c6c3b
TAGGED=spark-operator/spark-operator:v1beta2-1.3.8-3.4.1
HARDENED=spark-operator-v1beta2-1.3.8-3.4.1:hardened
pull:
docker pull ${ORIGINAL}
docker tag ${ORIGINAL} ${TAGGED}
run-original:
docker run --rm \
--name original \
${TAGGED}
shell-original:
docker run -it \
--name original-interactive \
${TAGGED} \
/bin/bash
history:
docker history --format "{{.CreatedBy}}" \
${TAGGED} \
--no-trunc | tac | tee history.txt
build: pull
docker build --no-cache \
--build-arg BASE_REGISTRY="registry.access.redhat.com" \
-t ${HARDENED} .
# Build fast
fast:
docker build \
--build-arg BASE_REGISTRY="registry.access.redhat.com" \
-t ${HARDENED} .
run:
docker run --rm \
${HARDENED}
shell:
docker run -it --rm \
${HARDENED} \
/bin/bash
copy-root:
docker cp original-interactive:/ files
clean:
docker stop original original-interactive ${HARDENED}
docker rm original original-interactive ${HARDENED}
all: pull fast run
# <application name>
# spark-operator
This is a hardened version of the upstream spark-operator image. This is meant to be deployed as a controller for SparkApplication and ScheduledSparkApplications, controlling the execution of spark clusters on Kubernetes. A chart with deployment instructions will be maintained elsewhere.
Project template for all Iron Bank container repositories.
\ No newline at end of file
It can also be used as a base container. An example of some containers that will rely on this are the jupyter notebook containers as well as some others for the Kubeflow deployment.
To test, download `tini` from the URL in [hardening_manifest.yaml](./hardening_manifest.yaml), rename as `tini`, and run `make build` then `make run`.
To compare to unhardened container, run `make run-original`
---
apiVersion: v1
name: "opensource/foo/bar"
name: spark-operator/spark-operator
tags:
- "0.0.0"
- "latest"
- v1beta2-1.3.8-3.4.1
- latest
args:
BASE_IMAGE: "redhat/ubi/ubi9"
BASE_TAG: "9.4"
BASE_IMAGE: "redhat/openjdk/openjdk17-runtime-ubi9-slim"
BASE_TAG: "1.17"
labels:
org.opencontainers.image.title: "title"
org.opencontainers.image.description: "description"
org.opencontainers.image.licenses: "Apache-2.0"
org.opencontainers.image.url: "https://url"
org.opencontainers.image.vendor: "vendor"
org.opencontainers.image.version: "0.0.0"
mil.dso.ironbank.image.keywords: " "
mil.dso.ironbank.image.type: "opensource"
mil.dso.ironbank.product.name: "name"
org.opencontainers.image.title: Spark Operator
org.opencontainers.image.description: spark-operator controller based on UBI 8
org.opencontainers.image.licenses: Apache-2.0
org.opencontainers.image.url: ghcr.io/googlecloudplatform/spark-operator@sha256:461336fa7e91c5127f29c06143400a911daf0bdbae2b3bea917cbd5cff0c6c3b
org.opencontainers.image.vendor: spark-operator
org.opencontainers.image.version: v1beta2-1.3.8-3.1.1
mil.dso.ironbank.image.keywords: spark,spark-operator,v1beta2-1.3.8-3.4.1
mil.dso.ironbank.image.type: opensource
mil.dso.ironbank.product.name: kubeflow
resources:
- filename: "filename.extension"
url: "https://example.com/path/to/file.tar.gz"
- tag: ghcr.io/googlecloudplatform/spark-operator:v1beta2-1.3.8-3.1.1
url: docker://ghcr.io/googlecloudplatform/spark-operator@sha256:461336fa7e91c5127f29c06143400a911daf0bdbae2b3bea917cbd5cff0c6c3b
- tag: docker.io/apache/spark:3.4.1
url: docker://docker.io/apache/spark@sha256:a1dd2487a97fb5e35c5a5b409e830b501a92919029c62f9a559b13c4f5c50f63
- url: https://github.com/krallin/tini/releases/download/v0.19.0/tini-amd64
filename: tini
validation:
type: sha256
value: " "
# For Docker dependencies
- tag: "product/name:1.0.0"
url: "docker://<image-registry>/name/of/product@sha256:<value>"
value: 93dcc18adc78c65a028a84799ecf8ad40c936fdfc5f2a57b1acda5a8117fa82c
maintainers:
- email: "username@example.com"
name: "FirstName LastName"
username: "UserName"
- email: tmiller@mitre.org
username: tmiller
name: Timothy Miller
cht_member: false
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json"
"$schema": "https://docs.renovatebot.com/renovate-schema.json"
}
#!/bin/bash
# echo commands to the terminal output
set -ex
# Check whether there is a passwd entry for the container UID
myuid=$(id -u)
mygid=$(id -g)
# turn off -e for getent because it will return error code in anonymous uid case
set +e
uidentry=$(getent passwd $myuid)
set -e
echo $myuid
echo $mygid
echo $uidentry
# If there is no passwd entry for the container UID, attempt to create one
if [[ -z "$uidentry" ]] ; then
if [[ -w /etc/passwd ]] ; then
echo "$myuid:x:$myuid:$mygid:anonymous uid:$SPARK_HOME:/bin/false" >> /etc/passwd
else
echo "Container ENTRYPOINT failed to add passwd entry for anonymous UID"
fi
fi
exec /usr/bin/tini -s -- /usr/bin/spark-operator "$@"
#!/bin/bash
#
# Copyright 2018 Google LLC
#
# Licensed 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.
#
# Generates a CA certificate, a server key, and a server certificate signed by the CA.
set -e
SCRIPT=`basename ${BASH_SOURCE[0]}`
RESOURCE_NAME="spark-webhook-certs"
function usage {
cat<< EOF
Usage: $SCRIPT
Options:
-h | --help Display help information.
-n | --namespace <namespace> The namespace where the Spark operator is installed.
-s | --service <service> The name of the webhook service.
-p | --in-pod Whether the script is running inside a pod or not.
-r | --resource-name The spark resource name that will hold the secret [default: $RESOURCE_NAME]
EOF
}
function parse_arguments {
while [[ $# -gt 0 ]]
do
case "$1" in
-n|--namespace)
if [[ -n "$2" ]]; then
NAMESPACE="$2"
else
echo "-n or --namespace requires a value."
exit 1
fi
shift 2
continue
;;
-s|--service)
if [[ -n "$2" ]]; then
SERVICE="$2"
else
echo "-s or --service requires a value."
exit 1
fi
shift 2
continue
;;
-p|--in-pod)
export IN_POD=true
shift 1
continue
;;
-r|--resource-name)
if [[ -n "$2" ]]; then
RESOURCE_NAME="$2"
else
echo "-r or --resource-name requires a value."
exit 1
fi
shift 2
continue
;;
-h|--help)
usage
exit 0
;;
--) # End of all options.
shift
break
;;
'') # End of all options.
break
;;
*)
echo "Unrecognized option: $1"
exit 1
;;
esac
done
}
# Set the namespace to "sparkoperator" by default if not provided.
# Set the webhook service name to "spark-webhook" by default if not provided.
IN_POD=false
SERVICE="spark-webhook"
NAMESPACE="spark-operator"
parse_arguments "$@"
TMP_DIR="/tmp/spark-pod-webhook-certs"
echo "Generating certs for the Spark pod admission webhook in ${TMP_DIR}."
mkdir -p ${TMP_DIR}
cat > ${TMP_DIR}/server.conf << EOF
[req]
req_extensions = v3_req
distinguished_name = req_distinguished_name
[req_distinguished_name]
[ v3_req ]
basicConstraints = CA:FALSE
keyUsage = nonRepudiation, digitalSignature, keyEncipherment
extendedKeyUsage = clientAuth, serverAuth
subjectAltName = DNS:${SERVICE}.${NAMESPACE}.svc
EOF
# Create a certificate authority.
touch ${TMP_DIR}/.rnd
export RANDFILE=${TMP_DIR}/.rnd
openssl genrsa -out ${TMP_DIR}/ca-key.pem 2048
openssl req -x509 -new -nodes -key ${TMP_DIR}/ca-key.pem -days 100000 -out ${TMP_DIR}/ca-cert.pem -subj "/CN=${SERVICE}.${NAMESPACE}.svc"
# Create a server certificate.
openssl genrsa -out ${TMP_DIR}/server-key.pem 2048
# Note the CN is the DNS name of the service of the webhook.
openssl req -new -key ${TMP_DIR}/server-key.pem -out ${TMP_DIR}/server.csr -subj "/CN=${SERVICE}.${NAMESPACE}.svc" -config ${TMP_DIR}/server.conf
openssl x509 -req -in ${TMP_DIR}/server.csr -CA ${TMP_DIR}/ca-cert.pem -CAkey ${TMP_DIR}/ca-key.pem -CAcreateserial -out ${TMP_DIR}/server-cert.pem -days 100000 -extensions v3_req -extfile ${TMP_DIR}/server.conf
if [[ "$IN_POD" == "true" ]]; then
TOKEN=$(cat /var/run/secrets/kubernetes.io/serviceaccount/token)
# Base64 encode secrets and then remove the trailing newline to avoid issues in the curl command
ca_cert=$(cat ${TMP_DIR}/ca-cert.pem | base64 | tr -d '\n')
ca_key=$(cat ${TMP_DIR}/ca-key.pem | base64 | tr -d '\n')
server_cert=$(cat ${TMP_DIR}/server-cert.pem | base64 | tr -d '\n')
server_key=$(cat ${TMP_DIR}/server-key.pem | base64 | tr -d '\n')
# Create the secret resource
echo "Creating a secret for the certificate and keys"
STATUS=$(curl -ik \
-o ${TMP_DIR}/output \
-w "%{http_code}" \
-X POST \
-H "Authorization: Bearer $TOKEN" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"kind": "Secret",
"apiVersion": "v1",
"metadata": {
"name": "'"$RESOURCE_NAME"'",
"namespace": "'"$NAMESPACE"'"
},
"data": {
"ca-cert.pem": "'"$ca_cert"'",
"ca-key.pem": "'"$ca_key"'",
"server-cert.pem": "'"$server_cert"'",
"server-key.pem": "'"$server_key"'"
}
}' \
https://kubernetes.default.svc/api/v1/namespaces/${NAMESPACE}/secrets)
cat ${TMP_DIR}/output
case "$STATUS" in
201)
printf "\nSuccess - secret created.\n"
;;
409)
printf "\nSuccess - secret already exists.\n"
;;
*)
printf "\nFailed creating secret.\n"
exit 1
;;
esac
else
kubectl create secret --namespace=${NAMESPACE} generic ${RESOURCE_NAME} --from-file=${TMP_DIR}/ca-key.pem --from-file=${TMP_DIR}/ca-cert.pem --from-file=${TMP_DIR}/server-key.pem --from-file=${TMP_DIR}/server-cert.pem
fi
# Clean up after we're done.
printf "\nDeleting ${TMP_DIR}.\n"
rm -rf ${TMP_DIR}
#!/bin/sh
set -e
find /bin/ \
/usr/bin/ \
/usr/local/bin/ \
/sbin/ \
/usr/sbin/ \
/usr/local/sbin/ \
/usr/libexec \
\! -user root -execdir chown root {} \;
#!/bin/sh
set -e
DIRS="/bin /usr/bin /usr/local/bin /sbin /usr/sbin /usr/local/sbin /usr/libexec"
for dirPath in $DIRS; do
find "$dirPath" -perm /022 -exec chmod go-w '{}' \;
done
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment