Skip to content

Commit

Permalink
Merge pull request #452 from chenrui333/update-release-version
Browse files Browse the repository at this point in the history
chore: bump version to 0.3.7
  • Loading branch information
javuto authored Jul 8, 2024
2 parents 166e5a7 + 0b10ef7 commit 3efcca8
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 39 deletions.
2 changes: 1 addition & 1 deletion .env.example
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
OSCTRL_VERSION=0.3.6
OSCTRL_VERSION=0.3.7
OSQUERY_VERSION=5.12.1
NGINX_VERSION=1.21.6-alpine
POSTGRES_VERSION=13.5-alpine
Expand Down
68 changes: 34 additions & 34 deletions deploy/docker/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# osctrl Docker dev environment

This directory contains all the necessary configs to setup the osctrl Docker dev environment. There a couple of manual steps that are required before having a fully functional deployment:
This directory contains all the necessary configs to setup the osctrl Docker dev environment. There a couple of manual steps that are required before having a fully functional deployment:

1. Generate TLS/SSL termination certificate and private key
2. Generate JWT secret for API tokens
Expand All @@ -11,61 +11,61 @@ Follow these steps to generate a self-signed certificate that is going to be use

1. `cp conf/tls/openssl.cnf.example conf/tls/openssl.cnf`
2. `BASE_DOMAIN=<DOMAIN> openssl req -x509 -new -nodes -days <X - ex: 365) -keyout conf/tls/osctrl.key -out conf/tls/osctrl.crt -config conf/tls/openssl.cnf`
1. Replace `<DOMAIN>` with an a domain like `osctrl.example.com`
2. ![docker_openssl_generate](../../.img/docker_openssl_generate.png)
1. Replace `<DOMAIN>` with an a domain like `osctrl.example.com`
2. ![docker_openssl_generate](../../.img/docker_openssl_generate.png)

## Generate JWT secret

You can generate a random enough JWT secret to be used with the `osctrl-api` and `osctrl-admin` components using one of the following commands:

1. `uuidgen | shasum -a 256 | awk '{print $1}'`
1. ![docker_uuid_gen](../../.img/docker_uuid_gen.png)
1. ![docker_uuid_gen](../../.img/docker_uuid_gen.png)
2. `vim .env` and set `JWT_SECRET`

## Set .env

1. `cp .env.example .env`
2. `vim .env` and set:
1. osctrl
1. `OSCTRL_VERSION` - define the version of osctrl to use
2. `JWT_SECRET` - define the JWT secret (see instructions above)
3. `OSCTRL_USER` - define username for osctrl admin user
4. `OSCTRL_PASS` - define password for osctrl admin user
2. osquery
1. `OSQUERY_VERSION` - define the version of Osquery for test instance
3. NGINX
1. `NGINX_VERSION` - define the version of NGINX to use
4. Postgres
1. `POSTGRES_VERSION` - define the version of Postgres to use
2. `POSTGRES_DB_NAME` - define the name of the database for osctrl
3. `POSTGRES_DB_USERNAME` - define the username to conenct to osctrl database
4. `POSTGRES_DB_PASSWORD` - define the password to conenct to osctrl database
5. Save and exit
1. osctrl
1. `OSCTRL_VERSION` - define the version of osctrl to use
2. `JWT_SECRET` - define the JWT secret (see instructions above)
3. `OSCTRL_USER` - define username for osctrl admin user
4. `OSCTRL_PASS` - define password for osctrl admin user
2. osquery
1. `OSQUERY_VERSION` - define the version of Osquery for test instance
3. NGINX
1. `NGINX_VERSION` - define the version of NGINX to use
4. Postgres
1. `POSTGRES_VERSION` - define the version of Postgres to use
2. `POSTGRES_DB_NAME` - define the name of the database for osctrl
3. `POSTGRES_DB_USERNAME` - define the username to conenct to osctrl database
4. `POSTGRES_DB_PASSWORD` - define the password to conenct to osctrl database
5. Save and exit
3. `docker-compose build`
1. Build Docker images
1. Build Docker images
4. `docker-compose up`
1. Spin up osctrl Docker stack
1. Spin up osctrl Docker stack

## Login into osctrl

1. Open a browser to `https://127.0.0.1:8443/login`
2. Login
1. Enter `<OSCTRL_USER>` for username
2. Enter `<OSCTRL_PASS>` for password
1. Enter `<OSCTRL_USER>` for username
2. Enter `<OSCTRL_PASS>` for password

## References

* [What is osctrl?](https://osctrl.net/)
* [osctrl-api](https://app.swaggerhub.com/apis-docs/jmpsec/osctrl-api/0.3.6#/)
- [What is osctrl?](https://osctrl.net/)
- [osctrl-api](https://app.swaggerhub.com/apis-docs/jmpsec/osctrl-api/0.3.7#/)

### Docker

* [How to create new users in a Docker container?](https://net2.com/how-to-create-new-users-in-docker-container/)
* [Is mkdir -p totally safe when creating folder already exists](https://unix.stackexchange.com/questions/242995/is-mkdir-p-totally-safe-when-creating-folder-already-exists)
* [Meaning of ampersand (&) in docker-compose.yml file](https://stackoverflow.com/questions/45805380/meaning-of-ampersand-in-docker-compose-yml-file)
* [ChooseYourSIEMAdventure/docker-compose-splunk.yml](https://github.com/CptOfEvilMinions/ChooseYourSIEMAdventure/blob/main/docker-compose-splunk.yml)
* [Interactive shell using Docker Compose](https://stackoverflow.com/questions/36249744/interactive-shell-using-docker-compose)
* [Advanced Dockerfiles: Faster Builds and Smaller Images Using BuildKit and Multistage Builds](https://www.docker.com/blog/advanced-dockerfiles-faster-builds-and-smaller-images-using-buildkit-and-multistage-builds/)
* [Using openssl to get the certificate from a server](https://stackoverflow.com/questions/7885785/using-openssl-to-get-the-certificate-from-a-server)
* [osquery flags](https://osquery.readthedocs.io/en/stable/installation/cli-flags/)
* [mkcert is a simple tool for making locally-trusted development certificates](https://github.com/FiloSottile/mkcert)
- [How to create new users in a Docker container?](https://net2.com/how-to-create-new-users-in-docker-container/)
- [Is mkdir -p totally safe when creating folder already exists](https://unix.stackexchange.com/questions/242995/is-mkdir-p-totally-safe-when-creating-folder-already-exists)
- [Meaning of ampersand (&) in docker-compose.yml file](https://stackoverflow.com/questions/45805380/meaning-of-ampersand-in-docker-compose-yml-file)
- [ChooseYourSIEMAdventure/docker-compose-splunk.yml](https://github.com/CptOfEvilMinions/ChooseYourSIEMAdventure/blob/main/docker-compose-splunk.yml)
- [Interactive shell using Docker Compose](https://stackoverflow.com/questions/36249744/interactive-shell-using-docker-compose)
- [Advanced Dockerfiles: Faster Builds and Smaller Images Using BuildKit and Multistage Builds](https://www.docker.com/blog/advanced-dockerfiles-faster-builds-and-smaller-images-using-buildkit-and-multistage-builds/)
- [Using openssl to get the certificate from a server](https://stackoverflow.com/questions/7885785/using-openssl-to-get-the-certificate-from-a-server)
- [osquery flags](https://osquery.readthedocs.io/en/stable/installation/cli-flags/)
- [mkcert is a simple tool for making locally-trusted development certificates](https://github.com/FiloSottile/mkcert)
2 changes: 1 addition & 1 deletion deploy/docker/conf/dev/.env.example
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
OSCTRL_VERSION=0.3.6
OSCTRL_VERSION=0.3.7
OSQUERY_VERSION=5.12.1
NGINX_VERSION=1.21.6-alpine
POSTGRES_VERSION=13.5-alpine
Expand Down
2 changes: 1 addition & 1 deletion osctrl-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ servers:
info:
title: osctrl-api
description: "This the API for osctrl, a fast and efficient osquery management solution."
version: 0.3.6
version: 0.3.7
externalDocs:
description: osctrl documentation
url: https://osctrl.net
Expand Down
2 changes: 1 addition & 1 deletion version/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ package version

const (
// OsctrlVersion to have the version for all components
OsctrlVersion = "0.3.6"
OsctrlVersion = "0.3.7"
// OsqueryVersion to have the version for osquery defined
OsqueryVersion = "5.12.1"
)
2 changes: 1 addition & 1 deletion version/version_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ func TestOsqueryVersion(t *testing.T) {
}

func TestOsctrlVersion(t *testing.T) {
assert.Equal(t, "0.3.6", OsctrlVersion)
assert.Equal(t, "0.3.7", OsctrlVersion)
}

0 comments on commit 3efcca8

Please sign in to comment.