Skip to content

Commit eea4841

Browse files
authored
chore: readme cleanup and helm release (#1034)
1 parent c0fb214 commit eea4841

File tree

4 files changed

+105
-89
lines changed

4 files changed

+105
-89
lines changed

README.md

Lines changed: 31 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -2,67 +2,49 @@
22
<picture>
33
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/parseablehq/.github/main/images/logo-dark.png">
44
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/parseablehq/.github/main/images/logo.svg">
5-
<a href="https://www.parseable.io" target="_blank"><img src="https://raw.githubusercontent.com/parseablehq/.github/main/images/logo.svg" alt="Parseable logo" /></a>
5+
<a href="https://www.parseable.com" target="_blank"><img src="https://raw.githubusercontent.com/parseablehq/.github/main/images/logo.svg" alt="Parseable logo" /></a>
66
</picture>
7-
<br>
8-
The <i>versatile</i> log database for search, analysis, and monitoring
97
</h2>
108

119
<div align="center">
1210

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

18-
[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)
16+
[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)
1917

2018
</div>
2119

22-
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**.
20+
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**.
2321

24-
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).
22+
To experience Parseable UI, checkout [demo.parseable.com ↗︎](https://demo.parseable.com/login?q=eyJ1c2VybmFtZSI6ImFkbWluIiwicGFzc3dvcmQiOiJhZG1pbiJ9).
2523

26-
## QuickStart :zap:
24+
## Quickstart :zap:
25+
26+
### Run Parseable
2727

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

32-
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.
32+
Get started with Parseable Docker with a single command:
3333

3434
```bash
3535
docker run -p 8000:8000 \
3636
containers.parseable.com/parseable/parseable:latest \
3737
parseable local-store
3838
```
3939

40-
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`.
41-
42-
To ingest data, run the below command. This will send logs to the `demo` stream. You can see the logs in the dashboard.
43-
44-
```bash
45-
curl --location --request POST 'http://localhost:8000/api/v1/ingest' \
46-
--header 'X-P-Stream: demo' \
47-
--header 'Authorization: Basic YWRtaW46YWRtaW4=' \
48-
--header 'Content-Type: application/json' \
49-
--data-raw '[
50-
{
51-
"id": "434a5f5e-2f5f-11ed-a261-0242ac120002",
52-
"datetime": "24/Jun/2022:14:12:15 +0000",
53-
"host": "153.10.110.81"
54-
}
55-
]'
56-
```
57-
5840
</p>
5941
</details>
6042

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

65-
You can download and run the Parseable binary on your laptop.
47+
Download and run the Parseable binary on your laptop:
6648

6749
- Linux or MacOS
6850

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

79-
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`.
61+
</p>
62+
</details>
63+
64+
### Ingestion and query
8065

81-
To ingest data, run the below command. This will send logs to the `demo` stream. You can see the logs in the dashboard.
66+
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.
8267

8368
```bash
8469
curl --location --request POST 'http://localhost:8000/api/v1/ingest' \
@@ -94,16 +79,24 @@ curl --location --request POST 'http://localhost:8000/api/v1/ingest' \
9479
]'
9580
```
9681

97-
</p>
98-
</details>
82+
Access the Parseable UI at [http://localhost:8000 ↗︎](http://localhost:8000). You can login to the dashboard default credentials `admin`, `admin`.
83+
84+
## Getting started :bulb:
85+
86+
For quickstart, refer the [quickstart section ↗︎](#quickstart-zap).
87+
88+
This section elaborates available options to run Parseable in production or development environments.
89+
90+
- Distributed Parseable on Kubernetes: [Helm Installation](https://www.parseable.com/docs/server/installation/distributed/setup-distributed-parseable-on-kubernetes-via-helm).
91+
- Distributed Parseable on AWS EC2 / VMs / Linux: [Binary Installation](https://www.parseable.com/docs/server/installation/distributed/setup-systemd-service-for-distributed-parseable-server).
9992

10093
## Features :rocket:
10194

10295
- [High availability & Cluster mode ↗︎](https://www.parseable.com/docs/concepts/distributed-architecture)
10396
- [Local cache ↗︎](https://www.parseable.com/docs/features/tiering)
104-
- [Alerts ↗︎](https://www.parseable.io/docs/alerts)
105-
- [Role based access control ↗︎](https://www.parseable.io/docs/rbac)
106-
- [OAuth2 support ↗︎](https://www.parseable.io/docs/oidc)
97+
- [Alerts ↗︎](https://www.parseable.com/docs/alerts)
98+
- [Role based access control ↗︎](https://www.parseable.com/docs/rbac)
99+
- [OAuth2 support ↗︎](https://www.parseable.com/docs/oidc)
107100
- [LLM integration ↗︎](https://www.parseable.com/docs/integrations/llm-based-sql-generation)
108101
- [OpenTelemetry support ↗︎](https://www.parseable.com/docs/opentelemetry)
109102

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

122115
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.
123116

124-
## Verify Image Build Provenance Attestation
125-
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:
117+
## Verify images :writing_hand:
118+
119+
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:
126120

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

131-
132125
## Contributing :trophy:
133126

134127
<a href="https://github.com/parseablehq/parseable/graphs/contributors"><img src="https://contrib.rocks/image?repo=parseablehq/parseable" /></a>

helm-releases/parseable-1.6.5.tgz

49.1 KB
Binary file not shown.

helm/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ apiVersion: v2
22
name: parseable
33
description: Helm chart for Parseable Server
44
type: application
5-
version: 1.6.4
5+
version: 1.6.5
66
appVersion: "v1.6.3"
77
maintainers:
88
- name: Parseable Team

0 commit comments

Comments
 (0)