Skip to content

Commit ace3b88

Browse files
committed
Cleanup readme and update helm to point to new container registry
1 parent cbfbfa1 commit ace3b88

7 files changed

Lines changed: 200 additions & 170 deletions

File tree

README.md

Lines changed: 27 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,56 @@
11
<h2 align="center">
22
<picture>
33
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/parseablehq/.github/main/images/logo-dark.png">
4-
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/parseablehq/.github/main/images/logo.svg">
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>
4+
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/parseablehq/.github/refs/heads/main/images/logo.svg">
5+
<a href="https://www.parseable.com" target="_blank"><img src="https://raw.githubusercontent.com/parseablehq/.github/refs/heads/main/images/logo.svg" alt="Parseable logo" /></a>
66
</picture>
77
</h2>
88

9-
<div align="center">
9+
<div class="title-block" style="text-align: center;" align="center">
1010

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

16-
[Key Concepts](https://www.parseable.com/docs/key-concepts) | [Features](https://www.parseable.com/docs/features/alerts) | [Documentation](https://www.parseable.com/docs) | [Demo](https://app.parseable.com) | [FAQ](https://www.parseable.com/docs/key-concepts/data-model#faq)
15+
**[Introduction](https://www.parseable.com/docs/introduction) &nbsp;&nbsp;&bull;&nbsp;&nbsp;**
16+
**[Docs](https://parseable.com/docs) &nbsp;&nbsp;&bull;&nbsp;&nbsp;**
17+
**[Features](https://www.parseable.com/docs/features) &nbsp;&nbsp;&bull;&nbsp;&nbsp;**
18+
**[Benchmarks](https://www.parseable.com/docs/benchmarks) &nbsp;&nbsp;&nbsp;&nbsp;**
1719

1820
</div>
1921

20-
Parseable is a full-stack observability platform built to ingest, analyze and extract insights from all types of telemetry (MELT) data. You can run Parseable on your local machine, in the cloud, or use [Parseable Cloud](https://app.parseable.com) — the fully managed service. To experience Parseable UI, checkout [app.parseable.com ↗︎](https://app.parseable.com).
22+
Parseable is an open source, columnar data lake platform - purpose built for observability. Send logs, metrics & traces to Parseable via popular logging agents, OpenTelemetry, Kafka, eBPF or other integrations. Use native observability features like alerting, dashboards, anomaly detection, APM, PromQL & SQL - all within a single binary.
2123

22-
<div align="center">
23-
<h3>
24-
<a href="https://app.parseable.com">Try Parseable Cloud — Start Free ↗︎</a>
25-
</h3>
26-
<p><i>The fastest way to get started. No infrastructure to manage.</i></p>
27-
</div>
28-
29-
<div align="center">
30-
<a href="http://www.youtube.com/watch?feature=player_embedded&v=gYn3pFAfrVA" target="_blank">
31-
<img src="http://img.youtube.com/vi/gYn3pFAfrVA/mqdefault.jpg" alt="Watch the video" width="300" height="240" />
32-
</a>
33-
</div>
24+
## Why Parseable?
3425

35-
## Quickstart :zap:
26+
Purpose built for observability and designed around proven data lake engineering patterns, Parseable gives you everything you need to make sense of your telemetry data, right out of the box, with no external dependencies or stitching together of multiple tools.
3627

37-
### Run Parseable
28+
Some of the key highlights include:
3829

39-
<details>
40-
<summary><a href="https://www.parseable.com/docs/quickstart/docker">Docker Image</a></summary>
41-
<p>
30+
- [Data lake architecture](https://www.parseable.com/docs/architecture): Parseable Data lake architecture allows running stateless compute with object storage as the backing storage. This allows scaling storage and compute independently, and avoids the pitfalls of traditional observability systems.
4231

43-
Get started with Parseable Docker image with a single command:
32+
- [Fully featured](https://www.parseable.com/docs/features): Parseable is feature complete with alerting, dashboards, anomaly detection, APM, and more. You can do all of this and more from a single binary, without needing to stitch together multiple tools.
4433

45-
```bash
46-
docker run -p 8000:8000 \
47-
parseable/parseable:latest \
48-
parseable local-store
49-
```
34+
- [Agent ready](https://www.parseable.com/docs/integrations#ai-agents--llms): Whether you need to observe your AI agents or use LLMs to analyze your telemetry data, Parseable has you covered with native support for AI agents and LLMs.
5035

51-
</p>
52-
</details>
36+
- [OpenTelemetry native](https://www.parseable.com/docs/ingest-data/otel): With native OTel support, you can send telemetry data to Parseable without any custom modifications or plugins. Parseable can be used as a drop-in replacement for your existing OpenTelemetry Collector setup.
5337

54-
<details>
55-
<summary><a href="https://www.parseable.com/docs/quickstart/binary">Executable Binary</a></summary>
56-
<p>
38+
## Quickstart
5739

5840
Download and run the Parseable binary on your laptop:
5941

60-
- Linux or MacOS
61-
6242
```bash
6343
curl -fsSL https://logg.ing/install | bash
6444
```
6545

66-
- Windows
46+
<details>
47+
<summary>For Windows</summary>
6748

6849
```pwsh
6950
powershell -c "irm https://logg.ing/install-windows | iex"
7051
```
71-
72-
</p>
7352
</details>
7453

75-
### Ingestion and query
76-
7754
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.
7855

7956
```bash
@@ -90,47 +67,23 @@ curl --location --request POST 'http://localhost:8000/api/v1/ingest' \
9067
]'
9168
```
9269

93-
Access the UI at [http://localhost:8000 ↗︎](http://localhost:8000). You can login to the dashboard default credentials `admin`, `admin`.
94-
95-
## Getting started :bulb:
70+
Access the UI at http://localhost:8000. You can login to the dashboard default credentials `admin`, `admin`.
9671

97-
For quickstart, refer the [quickstart section ↗︎](#quickstart-zap).
72+
For production deployments, refer the [installation guide ↗︎](https://www.parseable.com/docs/self-hosted/installation) for best practices and hardening tips.
9873

99-
This section elaborates available options to run Parseable in production or development environments.
74+
> [!TIP]
75+
> Try out the [Parseable cloud](https://app.parseable.com) — 14 days free trial, no credit card required.
10076
101-
- Distributed Parseable on Kubernetes: [Helm Installation](https://www.parseable.com/docs/installation/distributed/k8s-helm).
102-
- Distributed Parseable on AWS EC2 / VMs / Linux: [Binary Installation](https://www.parseable.com/docs/installation/distributed/linux).
77+
## Contributing
10378

104-
## Features :rocket:
105-
106-
- [High availability & Cluster mode ↗︎](https://www.parseable.com/docs/key-concepts/high-availability)
107-
- [Smart cache ↗︎](https://www.parseable.com/docs/features/smart-cache)
108-
- [Alerts ↗︎](https://www.parseable.com/docs/features/alerts)
109-
- [Role based access control ↗︎](https://www.parseable.com/docs/features/rbac)
110-
- [OAuth2 support ↗︎](https://www.parseable.com/docs/features/oepnid)
111-
- [OpenTelemetry support ↗︎](https://www.parseable.com/docs/OpenTelemetry/logs)
112-
113-
## Adopters :handshake:
114-
115-
Organizations using Parseable in production. [Add yours here](https://github.com/parseablehq/parseable/issues/new?template=add-adopter.yml) — no fork needed!
79+
<a href="https://github.com/parseablehq/parseable/graphs/contributors"><img src="https://contrib.rocks/image?repo=parseablehq/parseable" /></a>
11680

117-
<!-- ADOPTERS:START -->
118-
| Organization | Description of Use |
119-
| --- | --- |
120-
| [HireXL](https://www.hirexl.in/) | Frontend application logging |
121-
| [Elfsquad](https://elfsquad.io) | Centralized application/infrastructure logging |
122-
<!-- ADOPTERS:END -->
81+
[Contribution guide ↗︎](https://github.com/parseablehq/parseable/blob/main/CONTRIBUTING.md)
12382

124-
## Verify images :writing_hand:
83+
## Verify images
12584

12685
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:
12786

12887
```sh
12988
gh attestation verify PATH/TO/YOUR/PARSEABLE/ARTIFACT-BINARY -R parseablehq/parseable
13089
```
131-
132-
## Contributing :trophy:
133-
134-
<a href="https://github.com/parseablehq/parseable/graphs/contributors"><img src="https://contrib.rocks/image?repo=parseablehq/parseable" /></a>
135-
136-
[Contribution guide ↗︎](https://github.com/parseablehq/parseable/blob/main/CONTRIBUTING.md)

helm-releases/parseable-2.8.1.tgz

51.4 KB
Binary file not shown.
55.9 KB
Binary file not shown.

helm/Chart.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
apiVersion: v2
22
name: parseable
3-
description: Parseable Helm chart - Predictive, unified observability — faster resolution, fewer escalations, happier customers.
3+
description: Helm chart for Parseable OSS version. Columnar data lake platform - purpose built for observability
44
type: application
5-
version: 2.8.0
6-
appVersion: "v2.8.0"
7-
icon: "https://raw.githubusercontent.com/parseablehq/.github/main/images/new-logo.svg"
5+
version: 2.8.1
6+
appVersion: "v2.8.1"
7+
icon: "https://raw.githubusercontent.com/parseablehq/.github/main/images/logo.svg"
88

99
maintainers:
1010
- name: Parseable Team

helm/values.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
parseable:
22
image:
3-
repository: parseable/parseable
3+
repository: quay.io/parseablehq/parseable
44
tag: "v2.8.0"
55
pullPolicy: Always
66
## object store can be local-store, s3-store, blob-store or gcs-store.

0 commit comments

Comments
 (0)