Skip to content

Commit

Permalink
chore: readme cleanup and helm release (parseablehq#1034)
Browse files Browse the repository at this point in the history
  • Loading branch information
nitisht authored Dec 15, 2024
1 parent c0fb214 commit eea4841
Show file tree
Hide file tree
Showing 4 changed files with 105 additions and 89 deletions.
69 changes: 31 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,67 +2,49 @@
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/parseablehq/.github/main/images/logo-dark.png">
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/parseablehq/.github/main/images/logo.svg">
<a href="https://www.parseable.io" target="_blank"><img src="https://raw.githubusercontent.com/parseablehq/.github/main/images/logo.svg" alt="Parseable logo" /></a>
<a href="https://www.parseable.com" target="_blank"><img src="https://raw.githubusercontent.com/parseablehq/.github/main/images/logo.svg" alt="Parseable logo" /></a>
</picture>
<br>
The <i>versatile</i> log database for search, analysis, and monitoring
</h2>

<div align="center">

[![Docker Pulls](https://img.shields.io/docker/pulls/parseable/parseable?logo=docker&label=Docker%20Pulls)](https://hub.docker.com/r/parseable/parseable)
[![Slack](https://img.shields.io/badge/slack-brightgreen.svg?logo=slack&label=Community&style=flat&color=%2373DC8C&)](https://logg.ing/community)
[![Docs](https://img.shields.io/badge/stable%20docs-parseable.io%2Fdocs-brightgreen?style=flat&color=%2373DC8C&label=Docs)](https://logg.ing/docs)
[![Docs](https://img.shields.io/badge/stable%20docs-parseable.com%2Fdocs-brightgreen?style=flat&color=%2373DC8C&label=Docs)](https://logg.ing/docs)
[![Build](https://img.shields.io/github/checks-status/parseablehq/parseable/main?style=flat&color=%2373DC8C&label=Checks)](https://github.com/parseablehq/parseable/actions)

[Key Concepts](https://www.parseable.io/docs/concepts) | [Features](https://github.com/parseablehq/parseable#rocket-highlights) | [Documentation](https://www.parseable.io/docs) | [Demo](https://demo.parseable.com/login?q=eyJ1c2VybmFtZSI6ImFkbWluIiwicGFzc3dvcmQiOiJhZG1pbiJ9) | [Integrations](https://www.parseable.io/docs/category/integrations) | [FAQ](https://www.parseable.io/docs/faq)
[Key Concepts](https://www.parseable.com/docs/concepts) | [Features](https://github.com/parseablehq/parseable#rocket-highlights) | [Documentation](https://www.parseable.com/docs) | [Demo](https://demo.parseable.com/login?q=eyJ1c2VybmFtZSI6ImFkbWluIiwicGFzc3dvcmQiOiJhZG1pbiJ9) | [FAQ](https://www.parseable.com/docs/faq)

</div>

Parseable is a **cloud native log analytics platform, with a focus on simplicity & resource efficiency**. Parseable is useful for use cases where **complete data ownership, security and privacy are paramount**.
Parseable is a disk **_less_**, cloud native database for logs, observability, security, and compliance. Parseable is built with focus on simplicity & resource efficiency. Parseable is useful for use cases where **complete data ownership, data security and privacy are paramount**.

To experience Parseable UI, checkout [demo.parseable.com ↗︎](https://demo.parseable.com/login?q=eyJ1c2VybmFtZSI6ImFkbWluIiwicGFzc3dvcmQiOiJhZG1pbiJ9). You can also view the [demo video ↗︎](https://www.parseable.com/video.mp4).
To experience Parseable UI, checkout [demo.parseable.com ↗︎](https://demo.parseable.com/login?q=eyJ1c2VybmFtZSI6ImFkbWluIiwicGFzc3dvcmQiOiJhZG1pbiJ9).

## QuickStart :zap:
## Quickstart :zap:

### Run Parseable

<details>
<summary><a href="https://www.parseable.com/docs/docker-quick-start">Docker Image</a></summary>
<p>

You can <a href="https://www.parseable.com/docs/docker-quick-start">get started with Parseable Docker</a> with a simple Docker run and then send data via cURL to understand how you can ingest data to Parseable. Below is the command to run Parseable in local storage mode with Docker.
Get started with Parseable Docker with a single command:

```bash
docker run -p 8000:8000 \
containers.parseable.com/parseable/parseable:latest \
parseable local-store
```

Once this runs successfully, you'll see dashboard at [http://localhost:8000 ↗︎](http://localhost:8000). You can login to the dashboard default credentials `admin`, `admin`.

To ingest data, run the below command. This will send logs to the `demo` stream. You can see the logs in the dashboard.

```bash
curl --location --request POST 'http://localhost:8000/api/v1/ingest' \
--header 'X-P-Stream: demo' \
--header 'Authorization: Basic YWRtaW46YWRtaW4=' \
--header 'Content-Type: application/json' \
--data-raw '[
{
"id": "434a5f5e-2f5f-11ed-a261-0242ac120002",
"datetime": "24/Jun/2022:14:12:15 +0000",
"host": "153.10.110.81"
}
]'
```

</p>
</details>

<details>
<summary><a href="https://www.parseable.com/docs/docker-quick-start">Executable Binary</a></summary>
<p>

You can download and run the Parseable binary on your laptop.
Download and run the Parseable binary on your laptop:

- Linux or MacOS

Expand All @@ -76,9 +58,12 @@ curl -fsSL https://logg.ing/install | bash
powershell -c "irm https://logg.ing/install-windows | iex"
```

Once this runs successfully, you'll see dashboard at [http://localhost:8000 ↗︎](http://localhost:8000). You can login to the dashboard default credentials `admin`, `admin`.
</p>
</details>

### Ingestion and query

To ingest data, run the below command. This will send logs to the `demo` stream. You can see the logs in the dashboard.
Once you have Parseable running, ingest data with the below command. This will send logs to the `demo` stream. You can see the logs in the dashboard.

```bash
curl --location --request POST 'http://localhost:8000/api/v1/ingest' \
Expand All @@ -94,16 +79,24 @@ curl --location --request POST 'http://localhost:8000/api/v1/ingest' \
]'
```

</p>
</details>
Access the Parseable UI at [http://localhost:8000 ↗︎](http://localhost:8000). You can login to the dashboard default credentials `admin`, `admin`.

## Getting started :bulb:

For quickstart, refer the [quickstart section ↗︎](#quickstart-zap).

This section elaborates available options to run Parseable in production or development environments.

- Distributed Parseable on Kubernetes: [Helm Installation](https://www.parseable.com/docs/server/installation/distributed/setup-distributed-parseable-on-kubernetes-via-helm).
- Distributed Parseable on AWS EC2 / VMs / Linux: [Binary Installation](https://www.parseable.com/docs/server/installation/distributed/setup-systemd-service-for-distributed-parseable-server).

## Features :rocket:

- [High availability & Cluster mode ↗︎](https://www.parseable.com/docs/concepts/distributed-architecture)
- [Local cache ↗︎](https://www.parseable.com/docs/features/tiering)
- [Alerts ↗︎](https://www.parseable.io/docs/alerts)
- [Role based access control ↗︎](https://www.parseable.io/docs/rbac)
- [OAuth2 support ↗︎](https://www.parseable.io/docs/oidc)
- [Alerts ↗︎](https://www.parseable.com/docs/alerts)
- [Role based access control ↗︎](https://www.parseable.com/docs/rbac)
- [OAuth2 support ↗︎](https://www.parseable.com/docs/oidc)
- [LLM integration ↗︎](https://www.parseable.com/docs/integrations/llm-based-sql-generation)
- [OpenTelemetry support ↗︎](https://www.parseable.com/docs/opentelemetry)

Expand All @@ -121,14 +114,14 @@ Traditionally, logging has been seen as a text search problem. Log volumes were

But with log data growing exponentially, today's log data challenges involve whole lot more – Data ingestion, storage, and observation, all at scale. We are building Parseable to address these challenges.

## Verify Image Build Provenance Attestation
All the image builds/pushes are attested for build provenance and integrity using the [attest-build-provenance](https://github.com/actions/attest-build-provenance) action. The attestations can be verified by having the latest version of [GitHub CLI](https://github.com/cli/cli/releases/latest) installed in your system. Then, execute the following command:
## Verify images :writing_hand:

Parseable builds are attested for build provenance and integrity using the [attest-build-provenance](https://github.com/actions/attest-build-provenance) action. The attestations can be verified by having the latest version of [GitHub CLI](https://github.com/cli/cli/releases/latest) installed in your system. Then, execute the following command:

```sh
gh attestation verify PATH/TO/YOUR/PARSEABLE/ARTIFACT-BINARY -R parseablehq/parseable
```


## Contributing :trophy:

<a href="https://github.com/parseablehq/parseable/graphs/contributors"><img src="https://contrib.rocks/image?repo=parseablehq/parseable" /></a>
Expand Down
Binary file added helm-releases/parseable-1.6.5.tgz
Binary file not shown.
2 changes: 1 addition & 1 deletion helm/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ apiVersion: v2
name: parseable
description: Helm chart for Parseable Server
type: application
version: 1.6.4
version: 1.6.5
appVersion: "v1.6.3"
maintainers:
- name: Parseable Team
Expand Down
Loading

0 comments on commit eea4841

Please sign in to comment.