An open API service indexing awesome lists of open source software.

https://github.com/massdriver-cloud/k8s-qdrant


https://github.com/massdriver-cloud/k8s-qdrant

Last synced: 4 months ago
JSON representation

Awesome Lists containing this project

README

          

[![Massdriver][logo]][website]

# k8s-qdrant

[![Release][release_shield]][release_url]
[![Contributors][contributors_shield]][contributors_url]
[![Forks][forks_shield]][forks_url]
[![Stargazers][stars_shield]][stars_url]
[![Issues][issues_shield]][issues_url]
[![MIT License][license_shield]][license_url]

Qdrant is a vector similarity search engine. Vector databases are a relatively new way for interacting with abstract data representations derived from opaque machine learning models such as deep learning architectures.

---

## Design

For detailed information, check out our [Operator Guide](operator.md) for this bundle.

## Usage

Our bundles aren't intended to be used locally, outside of testing. Instead, our bundles are designed to be configured, connected, deployed and monitored in the [Massdriver][website] platform.

### What are Bundles?

Bundles are the basic building blocks of infrastructure, applications, and architectures in [Massdriver][website]. Read more [here](https://docs.massdriver.cloud/concepts/bundles).

## Bundle

### Params

Form input parameters for configuring a bundle for deployment.

View

## Properties

- **`database`** *(object)*
- **`instance_configuration`** *(object)*
- **`cpu_limit`** *(number)*: Unit is in CPUs. Decimal numbers are allowed (3 digits of precision). Value must be between 0.5 and 32. Minimum: `0.5`. Maximum: `32`.
- **`memory_limit`** *(integer)*: Select memory limit and conversion unit. **Minimum is 50MB**. Minimum: `50000000`.
- **`storage_size`** *(number)*: Unit is Gi. Decimal numbers are allowed. Value must be between 1 and 1000. **Cannot be changed after creation.**. Minimum: `1`. Maximum: `1000`.
- **`replica_configuration`** *(object)*
- **`replicas`** *(integer)*: Number of replicas to create. Must be an integer between 1 and 5. Must be one of: `[1, 2, 3, 4, 5]`.
- **`namespace`** *(string)*: Choose a namespace for Elasticsearch.

### Connections

Connections from other bundles that this bundle depends on.

View

## Properties

- **`kubernetes_cluster`** *(object)*: Kubernetes cluster authentication and cloud-specific configuration. Cannot contain additional properties.
- **`data`** *(object)*
- **`authentication`** *(object)*
- **`cluster`** *(object)*
- **`certificate-authority-data`** *(string)*
- **`server`** *(string)*
- **`user`** *(object)*
- **`token`** *(string)*
- **`infrastructure`** *(object)*: Cloud specific Kubernetes configuration data.
- **One of**
- AWS EKS infrastructure config*object*: . Cannot contain additional properties.
- **`arn`** *(string)*: Amazon Resource Name.

Examples:
```json
"arn:aws:rds::ACCOUNT_NUMBER:db/prod"
```

```json
"arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
```

- **`oidc_issuer_url`** *(string)*: An HTTPS endpoint URL.

Examples:
```json
"https://example.com/some/path"
```

```json
"https://massdriver.cloud"
```

- Infrastructure Config*object*: Azure AKS Infrastructure Configuration. Cannot contain additional properties.
- **`ari`** *(string)*: Azure Resource ID.

Examples:
```json
"/subscriptions/12345678-1234-1234-abcd-1234567890ab/resourceGroups/resource-group-name/providers/Microsoft.Network/virtualNetworks/network-name"
```

- **`oidc_issuer_url`** *(string)*
- GCP Infrastructure GRN*object*: Minimal GCP Infrastructure Config. Cannot contain additional properties.
- **`grn`** *(string)*: GCP Resource Name (GRN).

Examples:
```json
"projects/my-project/global/networks/my-global-network"
```

```json
"projects/my-project/regions/us-west2/subnetworks/my-subnetwork"
```

```json
"projects/my-project/topics/my-pubsub-topic"
```

```json
"projects/my-project/subscriptions/my-pubsub-subscription"
```

```json
"projects/my-project/locations/us-west2/instances/my-redis-instance"
```

```json
"projects/my-project/locations/us-west2/clusters/my-gke-cluster"
```

- **`specs`** *(object)*
- **`aws`** *(object)*: .
- **`region`** *(string)*: AWS Region to provision in.

Examples:
```json
"us-west-2"
```

- **`azure`** *(object)*: .
- **`region`** *(string)*: Select the Azure region you'd like to provision your resources in.
- **`gcp`** *(object)*: .
- **`project`** *(string)*
- **`region`** *(string)*: The GCP region to provision resources in.

Examples:
```json
"us-east1"
```

```json
"us-east4"
```

```json
"us-west1"
```

```json
"us-west2"
```

```json
"us-west3"
```

```json
"us-west4"
```

```json
"us-central1"
```

- **`kubernetes`** *(object)*: Kubernetes distribution and version specifications.
- **`cloud`** *(string)*: Must be one of: `['aws', 'gcp', 'azure']`.
- **`distribution`** *(string)*: Must be one of: `['eks', 'gke', 'aks']`.
- **`platform_version`** *(string)*
- **`version`** *(string)*

### Artifacts

Resources created by this bundle that can be connected to other bundles.

View

## Properties

- **`qdrant_authentication`** *(object)*: Qdrant database authentication. Cannot contain additional properties.
- **`data`** *(object)*
- **`authentication`**: Qdrant connection string. Cannot contain additional properties.
- **`api_key`** *(string)*
- **`hostname`** *(string)*
- **`port`** *(integer)*: Port number. Minimum: `0`. Maximum: `65535`.
- **`infrastructure`** *(object)*: . Cannot contain additional properties.
- **`kubernetes_namespace`** *(string)*
- **`kubernetes_service`** *(string)*
- **`specs`** *(object)*
- **`aws`** *(object)*: .
- **`region`** *(string)*: AWS Region to provision in.

Examples:
```json
"us-west-2"
```

- **`azure`** *(object)*: .
- **`region`** *(string)*: Select the Azure region you'd like to provision your resources in.
- **`gcp`** *(object)*: .
- **`project`** *(string)*
- **`region`** *(string)*: The GCP region to provision resources in.

Examples:
```json
"us-east1"
```

```json
"us-east4"
```

```json
"us-west1"
```

```json
"us-west2"
```

```json
"us-west3"
```

```json
"us-west4"
```

```json
"us-central1"
```

- **`qdrant`** *(object)*: Common metadata for Qdrant databases.
- **`version`** *(string)*: The Qdrant database version. Default: ``.

Examples:
```json
"0.6.1"
```

Examples:
```json
{
"version": "0.6.1"
}
```

## Contributing

### Bug Reports & Feature Requests

Did we miss something? Please [submit an issue](https://github.com/massdriver-cloud/k8s-qdrant/issues) to report any bugs or request additional features.

### Developing

**Note**: Massdriver bundles are intended to be tightly use-case scoped, intention-based, reusable pieces of IaC for use in the [Massdriver][website] platform. For this reason, major feature additions that broaden the scope of an existing bundle are likely to be rejected by the community.

Still want to get involved? First check out our [contribution guidelines](https://docs.massdriver.cloud/bundles/contributing).

### Fix or Fork

If your use-case isn't covered by this bundle, you can still get involved! Massdriver is designed to be an extensible platform. Fork this bundle, or [create your own bundle from scratch](https://docs.massdriver.cloud/bundles/development)!

## Connect

Questions? Concerns? Adulations? We'd love to hear from you!

Please connect with us!

[![Email][email_shield]][email_url]
[![GitHub][github_shield]][github_url]
[![LinkedIn][linkedin_shield]][linkedin_url]
[![Twitter][twitter_shield]][twitter_url]
[![YouTube][youtube_shield]][youtube_url]
[![Reddit][reddit_shield]][reddit_url]

[logo]: https://raw.githubusercontent.com/massdriver-cloud/docs/main/static/img/logo-with-logotype-horizontal-400x110.svg
[docs]: https://docs.massdriver.cloud/?utm_source=github&utm_medium=readme&utm_campaign=k8s-qdrant&utm_content=docs
[website]: https://www.massdriver.cloud/?utm_source=github&utm_medium=readme&utm_campaign=k8s-qdrant&utm_content=website
[github]: https://github.com/massdriver-cloud?utm_source=github&utm_medium=readme&utm_campaign=k8s-qdrant&utm_content=github
[slack]: https://massdriverworkspace.slack.com/?utm_source=github&utm_medium=readme&utm_campaign=k8s-qdrant&utm_content=slack
[linkedin]: https://www.linkedin.com/company/massdriver/?utm_source=github&utm_medium=readme&utm_campaign=k8s-qdrant&utm_content=linkedin

[contributors_shield]: https://img.shields.io/github/contributors/massdriver-cloud/k8s-qdrant.svg?style=for-the-badge
[contributors_url]: https://github.com/massdriver-cloud/k8s-qdrant/graphs/contributors
[forks_shield]: https://img.shields.io/github/forks/massdriver-cloud/k8s-qdrant.svg?style=for-the-badge
[forks_url]: https://github.com/massdriver-cloud/k8s-qdrant/network/members
[stars_shield]: https://img.shields.io/github/stars/massdriver-cloud/k8s-qdrant.svg?style=for-the-badge
[stars_url]: https://github.com/massdriver-cloud/k8s-qdrant/stargazers
[issues_shield]: https://img.shields.io/github/issues/massdriver-cloud/k8s-qdrant.svg?style=for-the-badge
[issues_url]: https://github.com/massdriver-cloud/k8s-qdrant/issues
[release_url]: https://github.com/massdriver-cloud/k8s-qdrant/releases/latest
[release_shield]: https://img.shields.io/github/release/massdriver-cloud/k8s-qdrant.svg?style=for-the-badge
[license_shield]: https://img.shields.io/github/license/massdriver-cloud/k8s-qdrant.svg?style=for-the-badge
[license_url]: https://github.com/massdriver-cloud/k8s-qdrant/blob/main/LICENSE

[email_url]: mailto:support@massdriver.cloud
[email_shield]: https://img.shields.io/badge/email-Massdriver-black.svg?style=for-the-badge&logo=mail.ru&color=000000
[github_url]: mailto:support@massdriver.cloud
[github_shield]: https://img.shields.io/badge/follow-Github-black.svg?style=for-the-badge&logo=github&color=181717
[linkedin_url]: https://linkedin.com/in/massdriver-cloud
[linkedin_shield]: https://img.shields.io/badge/follow-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&color=0A66C2
[twitter_url]: https://twitter.com/massdriver?utm_source=github&utm_medium=readme&utm_campaign=k8s-qdrant&utm_content=twitter
[twitter_shield]: https://img.shields.io/badge/follow-Twitter-black.svg?style=for-the-badge&logo=twitter&color=1DA1F2
[discourse_url]: https://community.massdriver.cloud?utm_source=github&utm_medium=readme&utm_campaign=k8s-qdrant&utm_content=discourse
[discourse_shield]: https://img.shields.io/badge/join-Discourse-black.svg?style=for-the-badge&logo=discourse&color=000000
[youtube_url]: https://www.youtube.com/channel/UCfj8P7MJcdlem2DJpvymtaQ
[youtube_shield]: https://img.shields.io/badge/subscribe-Youtube-black.svg?style=for-the-badge&logo=youtube&color=FF0000
[reddit_url]: https://www.reddit.com/r/massdriver
[reddit_shield]: https://img.shields.io/badge/subscribe-Reddit-black.svg?style=for-the-badge&logo=reddit&color=FF4500