Skip to content

Commit

Permalink
v1.7.5 (#64)
Browse files Browse the repository at this point in the history
## v1.7.5
|||
|---|---|
|Date|2024-07-16
|Kind| MINOR release
|Author|mschiess@akamai.com

- **Minor improvements**
  - Updated Command Line usage docs (ACC logs installation)
  - [docker] bumped GC-LOGS to version "0.0.5" 
  - [docker] bumped CLI-EAA to version "0.6.10" - fixed the bug that crashed the EAA logs in ULS-Docker Container v1.7.4
  - [docker] changed the privilege within the docker (installation as root - then dropping to unprivileged user) - fix for Openshift + adding higher security
  - changed the path for the .edgerc mock to uls/var (instead of uls/ext)
  • Loading branch information
MikeSchiessl authored Jul 16, 2024
1 parent 4bf1d2a commit c3da86c
Show file tree
Hide file tree
Showing 6 changed files with 57 additions and 13 deletions.
25 changes: 20 additions & 5 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ ARG ULS_DIR="$HOMEDIR/uls"
ARG EXT_DIR="$ULS_DIR/ext"

ARG ETP_CLI_VERSION="0.4.7"
ARG EAA_CLI_VERSION="0.6.9"
ARG EAA_CLI_VERSION="0.6.10"
ARG MFA_CLI_VERSION="0.1.1"
ARG GC_CLI_VERSION="v0.0.4(beta)"
ARG GC_CLI_VERSION="v0.0.5"
ARG LINODE_CLI_VERSION="dev"
ARG ACC_CLI_VERSION="v0.0.1-alpha"

Expand All @@ -33,24 +33,33 @@ RUN apt-get update && \
telnet \
gcc \
libssl-dev \
libffi-dev && \
libffi-dev \
acl && \
rm -rf /var/lib/apt/lists/



# USER & GROUP
RUN groupadd akamai && \
useradd -g akamai -s /bin/bash -m -d ${HOMEDIR} akamai

USER akamai
# Applying the root group to the akamai-uls directory to match openshift security requirements
#RUN setfacl -m g:root:rx ${HOMEDIR} && \
# setfacl -dm g:root:rx ${HOMEDIR}

# Installing now as root and switching later to the akamai user

WORKDIR ${HOMEDIR}
RUN mkdir -p ${ULS_DIR} && \
mkdir -p ${ULS_DIR}/var
mkdir -p ${ULS_DIR}/var && chmod 777 ${ULS_DIR}/var


# Install ULS
COPY bin/ ${ULS_DIR}/bin
WORKDIR ${ULS_DIR}
RUN pip3 install --no-cache-dir -r ${ULS_DIR}/bin/requirements.txt


# Install external CLI'S
## ETP CLI
ENV ETP_CLI_VERSION=$ETP_CLI_VERSION
Expand Down Expand Up @@ -83,6 +92,12 @@ ENV ACC_CLI_VERSION=$ACC_CLI_VERSION
RUN git clone --depth 1 -b "${ACC_CLI_VERSION}" --single-branch https://github.com/MikeSchiessl/acc-logs.git ${EXT_DIR}/acc-logs && \
pip3 install --no-cache-dir -r ${EXT_DIR}/acc-logs/bin/requirements.txt


# Preparing user - switch
#RUN chown -R akamai:root ${HOMEDIR}
USER akamai


# ENTRYPOINTS / CMD
VOLUME ["${ULS_DIR}/var"]
ENTRYPOINT ["/usr/local/bin/python3","-u","bin/uls.py"]
Expand Down
4 changes: 2 additions & 2 deletions bin/uls_config/global_config.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env python3

# Common global variables / constants
__version__ = "1.7.4"
__version__ = "1.7.5"
__tool_name_long__ = "Akamai Unified Log Streamer"
__tool_name_short__ = "ULS"

Expand Down Expand Up @@ -103,7 +103,7 @@
edgerc_gc = ["gc_username", "gc_password", "gc_hostname"] # Required for Guardicore
edgerc_linode = ["linode_hostname", "linode_token"] # Required for Linode
edgerc_documentation_url = "https://github.com/akamai/uls/blob/main/docs/AKAMAI_API_CREDENTIALS.md"
edgerc_mock_file = "ext/edgerc" # Required for display the version if no edgercfile was given
edgerc_mock_file = "var/edgerc" # Required for display the version if no edgercfile was given

# Autoresume Configuration
autoresume_checkpoint_path = "var/" # (Default) Path, where the checkpointfiles should be stored to
Expand Down
16 changes: 16 additions & 0 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,19 @@
# Version History
## v1.7.5
|||
|---|---|
|Date|2024-07-16
|Kind| MINOR release
|Author|mschiess@akamai.com

- **Minor improvements**
- Updated Command Line usage docs (ACC logs installation)
- [docker] bumped GC-LOGS to version "0.0.5"
- [docker] bumped CLI-EAA to version "0.6.10" - fixed the bug that crashed the EAA logs in ULS-Docker Container v1.7.4
- [docker] changed the privilege within the docker (installation as root - then dropping to unprivileged user) - fix for Openshift + adding higher security
- changed the path for the .edgerc mock to uls/var (instead of uls/ext)

---
## v1.7.4
|||
|---|---|
Expand All @@ -16,6 +31,7 @@
- **BUGFIX**
- Fixed a bug in the autoresume function where SIA does not equal it's alias ETP properly

---

## v1.7.3
|||
Expand Down
19 changes: 16 additions & 3 deletions docs/COMMAND_LINE_USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,17 @@ pip3 install -r ext/cli-etp/requirements.txt
git clone --depth 1 --single-branch https://github.com/akamai/cli-mfa.git ext/cli-mfa && \
pip3 install -r ext/cli-mfa/requirements.txt

# Guardicore Log-fetcher (experimental)
# Guardicore Log-fetcher (beta)
git clone -q --depth 1 -b dev --single-branch https://github.com/MikeSchiessl/gc-logs.git ext/cli-gc && \
pip3 install -q -r ext/cli-gc/bin/requirements.txt

# Linode Log fetcher (experimental)
# Linode Log fetcher (alpha)
git clone -q --depth 1 -b dev --single-branch https://github.com/MikeSchiessl/ln-logs.git ext/cli-linode && \
pip3 install -q -r ext/cli-linode/bin/requirements.txt

# Akamai Control Center Events (experimental)
git clone -q --depth 1 -b dev --single-branch https://github.com/MikeSchiessl/acc-logs.git ext/acc-logs && \
pip3 install -q -r ext/acc-logs/bin/requirements.txt
```

### Setup the .EDGERC File
Expand Down Expand Up @@ -124,8 +128,13 @@ All log output will be directed to STDOUT by default.
```bash
python3 bin/uls.py --input sia --feed threat --output udp --host 10.10.10.200 --port 9090 &> /path/to/my/logfile &
```
Rather consider [docker usage](./DOCKER_USAGE.md) instead of this
Rather consider [docker usage](./DOCKER_USAGE.md) instead of this


- ACC EventViewer LOG ==> RAW with starting time
```bash
python3 bin/uls.py --input ACC -f events --section default --starttime 1719852040 --output raw
```
## ULS as a service: systemd

If you are planning to use multiple Akamai feed with ULS, bear in mind you will need to repeat the instruction below multiple times. We built this guide with CentOS 7.
Expand Down Expand Up @@ -226,4 +235,8 @@ pip3 install -q -r ext/cli-etp/requirements.txt
# MFA CLI (only if installed)
git -C ext/cli-mfa pull -q
pip3 install -q -r ext/cli-mfa/requirements.txt

# ACC EventViewer (only if installed)
git -C ext/acc-logs pull -q
pip3 install -q -r ext/acc-logs/requirements.txt
```
2 changes: 1 addition & 1 deletion docs/examples/kubernetes/helm/akamai-uls/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ description: Akamai Universal Log Streamer Helm installation

type: application
version: 2.0.0
appVersion: "1.7.4"
appVersion: "1.7.5"
4 changes: 2 additions & 2 deletions scripts/get-uls.sh
Original file line number Diff line number Diff line change
Expand Up @@ -209,10 +209,10 @@ echo "Installing ACC-CLI"
pip3 install -q -r ${install_dir}/ext/cli-linode/bin/requirements.txt
fi

## GRAB GC-CLI
## GRAB ACC-CLI
if [[ "$install_modules" == *"gc"* ]] ; then
echo "Installing ACC-CLI"
git clone -q --depth 1 -b dev --single-branch https://github.com/MikeSchiessl/gc-logs.git ${install_dir}/ext/acc-logs
git clone -q --depth 1 -b dev --single-branch https://github.com/MikeSchiessl/acc-logs.git ${install_dir}/ext/acc-logs
py_reqs ${install_dir}/ext/acc-logs/bin/requirements.txt
pip3 install -q -r ${install_dir}/ext/acc-logs/bin/requirements.txt
fi
Expand Down

0 comments on commit c3da86c

Please sign in to comment.