diff --git a/.gitignore b/.gitignore index c05677cfe..166b7032d 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,4 @@ key.pem .vscode helm-releases/.DS_Store .DS_Store +env-file diff --git a/README.md b/README.md index 37537bf11..4f8767a1d 100644 --- a/README.md +++ b/README.md @@ -46,13 +46,25 @@ It ingests log data via HTTP POST calls and exposes a query API to search and an ## Getting Started ### Docker -Parseable docker image is available on [Docker hub](https://hub.docker.com/r/parseable/parseable). +Parseable docker image is available on [Docker hub](https://hub.docker.com/r/parseable/parseable). Please remember to change the environment variables as relevant. ```sh -mkdir -p /tmp/parseable +cat << EOF > parseable-env +P_S3_URL=https://minio.parseable.io:9000 +P_S3_ACCESS_KEY=minioadmin +P_S3_SECRET_KEY=minioadmin +P_S3_REGION=us-east-1 +P_S3_BUCKET=parseable +P_LOCAL_STORAGE=/data +P_USERNAME=parseable +P_PASSWORD=parseable +EOF + +mkdir -p /tmp/data docker run \ -p 8000:8000 \ - -v /tmp/parseable:/data \ + --env-file parseable-env \ + -v /tmp/data:/data \ parseable/parseable:latest ``` @@ -66,45 +78,48 @@ helm install parseable parseable/parseable --namespace parseable ``` ### Binary -Parseable binary is available on [Github releases](https://github.com/parseablehq/parseable/releases). Please download the latest release for your platform. +Parseable binary is available on [Github releases](https://github.com/parseablehq/parseable/releases). Please download the latest release for your platform, also make sure to change the environment variables as relevant. ```sh +export P_S3_URL="https://minio.parseable.io:9000" +export P_S3_ACCESS_KEY="minioadmin" +export P_S3_SECRET_KEY="minioadmin" +export P_S3_REGION="us-east-1" +export P_S3_BUCKET="parseable" +export P_LOCAL_STORAGE="./data" +export P_USERNAME="parseable" +export P_PASSWORD="parseable" chmod +x parseable ./parseable ```

-Parseable dashboard is available at [http://localhost:8000](http://localhost:8000). Default username and password is `parseable`. - -By default Parseable uses a public bucket to store the data. Please change the object storage credentials to your own bucket, before using Parseable. +Parseable dashboard is available at [http://localhost:8000](http://localhost:8000). Credentials to login to the dashboard are the values you set in the environment variables. :memo: Parseable is in alpha stage and will evolve over time. There may be breaking changes between releases. Please give us your feedback in [Slack](https://launchpass.com/parseable), or [Issues](https://github.com/parseablehq/parseable/issues/new). -### Configuration - -Parseable can be configured using environment variables listed below, with sample values. +## Using Parseable +`` is the name of the stream you want to create. `` is the basic auth header value generated from username & password of the user you created in the environment variables. You can generate the basic auth header value using the following command. ```sh -export P_S3_URL="https://minio.parseable.io:9000" -export P_S3_ACCESS_KEY="minioadmin" -export P_S3_SECRET_KEY="minioadmin" -export P_S3_REGION="us-east-1" -export P_S3_BUCKET="parseable" -export P_LOCAL_STORAGE="./data" -export P_USERNAME="parseable" -export P_PASSWORD="parseable" +echo -n ':' | base64 ``` -## Live Demo +### Create a stream -Try out Parseable server with our demo instance. Send log data to default log stream `frontend` +```sh +curl --location --request PUT 'http://localhost:8000/api/v1/logstream/' \ +--header 'Authorization: Basic ' +``` + +### Send events to the stream ```sh -curl --location --request POST 'https://demo.parseable.io/api/v1/logstream/frontend' \ +curl --location --request POST 'http://localhost:8000/api/v1/logstream/' \ --header 'X-P-META-meta1: value1' \ --header 'X-P-TAG-tag1: value1' \ ---header 'Authorization: Basic cGFyc2VhYmxlOnBhcnNlYWJsZQ==' \ +--header 'Authorization: Basic ' \ --header 'Content-Type: application/json' \ --data-raw '[ { @@ -119,26 +134,11 @@ curl --location --request POST 'https://demo.parseable.io/api/v1/logstream/front ]' ``` -Access the Parseable dashboard to verify the log data is present - - - - - - - - - - - - - - -
URLhttps://demo.parseable.io
Usernameparseable
Passwordparseable
- -For complete Parseable API documentation, refer to [Parseable API workspace on Postman](https://www.postman.com/parseable/workspace/parseable/overview). - -:exclamation: Please do not store any sensitive data on this server as the data is openly accessible. We'll delete the data on this server periodically. +For complete Parseable API documentation, refer to [Parseable API Ref Docs](https://www.parseable.io/docs/api-reference). + +## Live Demo + +You can also try out Parseable on our [https://demo.parseable.io](https://demo.parseable.io). Credentials to login to the dashboard are `parseable` / `parseable`. ## Contributing diff --git a/helm/parseable/values.yaml b/helm/parseable/values.yaml index 21443fe05..22786ea8d 100644 --- a/helm/parseable/values.yaml +++ b/helm/parseable/values.yaml @@ -4,6 +4,7 @@ parseable: repository: parseable/parseable tag: v0.0.2 pullPolicy: IfNotPresent + demo: true env: P_ADDR: "0.0.0.0:8000" P_TLS_CERT_PATH: "" @@ -12,13 +13,14 @@ parseable: RUST_LOG: "parseable=info" # By default parseable uses demo environment. # Please change this before running in production. - #P_S3_URL: "" - #P_S3_ACCESS_KEY: "" - #P_S3_SECRET_KEY: "" - #P_S3_REGION: "" - #P_S3_BUCKET: "" - P_USERNAME: "parseable" - P_PASSWORD: "parseable" + P_S3_URL: "" + P_S3_ACCESS_KEY: "" + P_S3_SECRET_KEY: "" + P_S3_REGION: "" + P_S3_BUCKET: "" + P_LOCAL_STORAGE: "" + P_USERNAME: "" + P_PASSWORD: "" nameOverride: "" fullnameOverride: "" serviceAccount: diff --git a/server/Cargo.toml b/server/Cargo.toml index 72d9a4970..e5a855540 100644 --- a/server/Cargo.toml +++ b/server/Cargo.toml @@ -1,12 +1,11 @@ [package] name = "parseable" -version = "0.0.3" +version = "0.0.4" authors = [ - "NitishTiwari ", - "AdheipSingh ", + "Parseable Team ", ] edition = "2021" -categories = ["olap", "analytics-store"] +categories = ["olap", "logging", "analytics-store"] [dependencies] actix-web-httpauth = "0.6"