Skip to content

Commit

Permalink
cleanup and rename provider and client (#24)
Browse files Browse the repository at this point in the history
- Rename provider from terraform-provider-marqo to marqo-terraform
- Cleaned up junk files
- Rename go marqo client from `marqo` to `go_marqo`
  • Loading branch information
RaynorChavez authored Jul 17, 2024
1 parent 70406eb commit 0ef5aa5
Show file tree
Hide file tree
Showing 31 changed files with 332 additions and 733 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ website/node_modules
.env
*.tfvars
*/old/manage_indices_resource.go
*/docs*

website/vendor

Expand Down
96 changes: 96 additions & 0 deletions docs/data-sources/read_indices.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "marqo-terraform_read_indices Data Source - marqo-terraform"
subcategory: ""
description: |-
---

# marqo-terraform_read_indices (Data Source)





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `id` (String) The unique identifier for the resource.

### Read-Only

- `items` (Attributes List) (see [below for nested schema](#nestedatt--items))
- `last_updated` (String) The last time the resource was updated.

<a id="nestedatt--items"></a>
### Nested Schema for `items`

Optional:

- `all_fields` (Attributes List) (see [below for nested schema](#nestedatt--items--all_fields))
- `tensor_fields` (List of String)

Read-Only:

- `ann_parameters` (Attributes) (see [below for nested schema](#nestedatt--items--ann_parameters))
- `created` (String) The creation date of the index
- `docs_count` (String) The number of documents in the index
- `docs_deleted` (String) The number of documents deleted from the index
- `filter_string_max_length` (String) The filter string max length
- `index_name` (String) The name of the index
- `index_status` (String) The status of the index
- `inference_type` (String) The type of inference used by the index
- `marqo_endpoint` (String) The Marqo endpoint used by the index
- `marqo_version` (String) The version of Marqo used by the index
- `model` (String) The model used by the index
- `normalize_embeddings` (Boolean) Indicates if embeddings should be normalized
- `number_of_inferences` (String) The number of inferences made by the index
- `number_of_replicas` (String) The number of replicas for the index
- `number_of_shards` (String) The number of shards for the index
- `search_query_total` (String) The total number of search queries made on the index
- `storage_class` (String) The storage class of the index
- `store_size` (String) The size of the index storage
- `text_preprocessing` (Attributes) (see [below for nested schema](#nestedatt--items--text_preprocessing))
- `treat_urls_and_pointers_as_images` (Boolean) Indicates if URLs and pointers should be treated as images
- `type` (String) The type of the index
- `vector_numeric_type` (String) The numeric type of the vector

<a id="nestedatt--items--all_fields"></a>
### Nested Schema for `items.all_fields`

Optional:

- `dependent_fields` (Map of Number)
- `features` (List of String)
- `name` (String)
- `type` (String)


<a id="nestedatt--items--ann_parameters"></a>
### Nested Schema for `items.ann_parameters`

Read-Only:

- `parameters` (Attributes) (see [below for nested schema](#nestedatt--items--ann_parameters--parameters))
- `space_type` (String) The space type for ANN parameters

<a id="nestedatt--items--ann_parameters--parameters"></a>
### Nested Schema for `items.ann_parameters.parameters`

Read-Only:

- `ef_construction` (String) The efConstruction parameter for ANN
- `m` (String) The m parameter for ANN



<a id="nestedatt--items--text_preprocessing"></a>
### Nested Schema for `items.text_preprocessing`

Read-Only:

- `split_length` (String) The split length for text preprocessing
- `split_method` (String) The split method for text preprocessing
- `split_overlap` (String) The split overlap for text preprocessing
30 changes: 0 additions & 30 deletions docs/data-sources/scaffolding_example.md

This file was deleted.

13 changes: 4 additions & 9 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,21 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "scaffolding-framework Provider"
page_title: "marqo-terraform Provider"
subcategory: ""
description: |-
---

# scaffolding-framework Provider
# marqo-terraform Provider



## Example Usage

```terraform
provider "scaffolding" {
# example configuration here
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Optional

- `endpoint` (String) Example provider attribute
- `api_key` (String, Sensitive) The Marqo API key. Can be set with MARQO_API_KEY environment variable.
- `host` (String) The Marqo API host. Can be set with MARQO_HOST environment variable.
92 changes: 92 additions & 0 deletions docs/resources/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "marqo-terraform_index Resource - marqo-terraform"
subcategory: ""
description: |-
---

# marqo-terraform_index (Resource)





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `index_name` (String) The name of the index.
- `settings` (Attributes) The settings for the index. (see [below for nested schema](#nestedatt--settings))

<a id="nestedatt--settings"></a>
### Nested Schema for `settings`

Required:

- `type` (String)

Optional:

- `all_fields` (Attributes List) (see [below for nested schema](#nestedatt--settings--all_fields))
- `ann_parameters` (Attributes) (see [below for nested schema](#nestedatt--settings--ann_parameters))
- `filter_string_max_length` (Number)
- `image_preprocessing` (Attributes) (see [below for nested schema](#nestedatt--settings--image_preprocessing))
- `inference_type` (String)
- `model` (String)
- `normalize_embeddings` (Boolean)
- `number_of_inferences` (Number)
- `number_of_replicas` (Number)
- `number_of_shards` (Number)
- `storage_class` (String)
- `tensor_fields` (List of String)
- `text_preprocessing` (Attributes) (see [below for nested schema](#nestedatt--settings--text_preprocessing))
- `treat_urls_and_pointers_as_images` (Boolean)
- `vector_numeric_type` (String)

<a id="nestedatt--settings--all_fields"></a>
### Nested Schema for `settings.all_fields`

Optional:

- `dependent_fields` (Map of Number)
- `features` (List of String)
- `name` (String)
- `type` (String)


<a id="nestedatt--settings--ann_parameters"></a>
### Nested Schema for `settings.ann_parameters`

Optional:

- `parameters` (Attributes) (see [below for nested schema](#nestedatt--settings--ann_parameters--parameters))
- `space_type` (String)

<a id="nestedatt--settings--ann_parameters--parameters"></a>
### Nested Schema for `settings.ann_parameters.parameters`

Optional:

- `ef_construction` (Number)
- `m` (Number)



<a id="nestedatt--settings--image_preprocessing"></a>
### Nested Schema for `settings.image_preprocessing`

Optional:

- `patch_method` (String)


<a id="nestedatt--settings--text_preprocessing"></a>
### Nested Schema for `settings.text_preprocessing`

Optional:

- `split_length` (Number)
- `split_method` (String)
- `split_overlap` (Number)
31 changes: 0 additions & 31 deletions docs/resources/scaffolding_example.md

This file was deleted.

60 changes: 0 additions & 60 deletions examples/create_dependent_fields/create_dependent.tf

This file was deleted.

Loading

0 comments on commit 0ef5aa5

Please sign in to comment.