Commit Graph

24 Commits (4c03807f40ff144f16f95832e9ee0bc4ef93c3df)

Author SHA1 Message Date
Jakub Bednar 80470f9959 docs(clients): new major version of Go v3 client 2024-11-15 09:58:09 +01:00
Jason Stirnaman 4e601710b1 chore(ci): Adjusts Unix timestamps (line protocol) and query time bounds for testing
- Adjusts times for writing and querying data within a recent retention period.
- Adjusts Unix timestamps (in line protocol samples) to yesterday's date.
- Adjusts UTC time bounds (in queries) to today and yesterday.
- Reverts mistakenly changed timestamps in clustered.
2024-07-03 17:09:49 -05:00
Jason Stirnaman 8f0e583cdc fix(clustered): Clustered Telegraf config and example:
- Mount a volume to store test project files generated in tests.
- Allow URL and `url` in the linter
- Set timestamp precision for Telegraf example
- Fix Telegraf test, use Python to edit the TOML config file
2024-07-03 17:09:49 -05:00
Jason Stirnaman dbaa790fdb fix(v3): curl write examples 2024-07-03 17:09:49 -05:00
Jason Stirnaman f6a9e72c50 chore(v3): Test influxctl token create 2024-07-03 17:09:49 -05:00
Jason Stirnaman ea9b786b83 fix(ci): test content:
- Add python replacement for get-started database/bucket name
- Fixes race condition when deleting previous content:
  - Assign each product it's own test content volume instead of sharing a volume.
  - Delete existing content in the volume before copying test files.
  - Pros and cons, but I suspect a similar approach will be better when ported to Circle CI.
2024-06-26 10:26:52 -05:00
Jason Stirnaman 922e48182a chore(ci): Improve Vale style linting:
- Run Vale in a Docker container by running ./.ci/vale/vale.sh <args>
- Define vale lint scripts in package.json. Lint added and changed files for products.
- Define error-level vale linting in the lint-staged configuration for staged files.
- Improve product-specific nomenclature checks (e.g. database vs bucket)
- Simplify vocab terms and allowed words lists.
- Fixes content errors revealed by vale.
2024-06-26 08:52:21 -05:00
Jason Stirnaman 17c4315569 chore: Write data improvements
-  Format and structure serverless write-data
- Structure cloud-serverless write-data/line-protocol the same as clustered and dedicated to allow for adding more tool-specific pages.
- Make influxctl examples pass tests
2024-06-24 15:42:10 -05:00
Jason Stirnaman 3274742abe chore: fix formatting 2024-06-24 09:42:44 -05:00
Jason Stirnaman 5c74f013a1 chore(ci): Improve CI lint and test runners
- Reconfigures prettier linting.
- Adds .editorconfig to help with consistent editor settings
- Refactors test runs:
  - Removes test configuration from compose.yaml (not suited for this use case).
  - Splits test runner into test content setup and pytest that can be run separately or together (and with other test runners in the future).
  - Configuration is in Dockerfiles and command line (`.lintstagedrc.mjs`)
- Updates CONTRIBUTING.md
- Updates client library write examples in cloud-dedicated and clustered.
2024-06-21 18:41:07 -05:00
Scott Anderson da1b1105ea
Update v3 token management docs and add management tokens (#5373)
* new token management structure, updated links

* task-based management token docs

* added related links to influxctl management docs

* remove draft status from management token admin docs

* standardize references to identity provider

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2024-03-21 13:42:41 -06:00
Scott Anderson 58f4a6de32
Clustered installation docs (#5327)
* WIP clustered install guide

* fix: Use AZURE_CLIENT_ID (#5179)

* docs: add s3 policy

* docs: use suggested style

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* fix: typo

Co-authored-by: Jeffrey Smith II <jsmith@influxdata.com>

* fix(clustered): remove link to inaccessible google doc (#5197)

* added CRD abbreviation

* Alternate Clustered deployment with kubit (#5199)

* WIP kubit deployment

* Update content/influxdb/clustered/install/deploy.md

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* Apply suggestions from code review

Co-authored-by: Jack <56563911+jdockerty@users.noreply.github.com>

* updated kubit apply instructions

* Apply suggestions from code review

Co-authored-by: Jack <56563911+jdockerty@users.noreply.github.com>

* updated clustered install instructions to address PR feedback

* Update content/influxdb/clustered/install/deploy.md

Co-authored-by: Jack <56563911+jdockerty@users.noreply.github.com>

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
Co-authored-by: Jack <56563911+jdockerty@users.noreply.github.com>

* docs: update `kubit` mentions (#5252)

* fix: kubectl references

* chore: bump version of kubit install in docs

* docs: mention --docker flag from new release

* fix: wording

* docs(clustered): bump kubit to `0.0.13` (#5260)

* docs(clustered): bump kubit to `0.0.14` (#5272)

* removed certain prereqs in clustered install docs, related to influxdata/project-clustered#150 (#5290)

* docs(clustered): add azure/gcp storage permission requirements (#5296)

* docs(clustered): add gcp storage iam policy

* fix: wording

* docs: format and include azure

* docs: clarify azure

* address feedback

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* address feedback for azure

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* azure blob storage feedback wrapper

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* address gcp feedback

* Update content/influxdb/clustered/install/prerequisites.md

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* docs(clustered): fix incorrect padding and typos (#5312)

* fix: host and client_id in config.toml

* fix: padding causing html span to show

* revert: host placeholder

* Update _index.md

* Update _index.md

* Update auth.md

* Update prerequisites.md

* Update use-your-cluster.md

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* commented out auth0 placeholder content

* consolidate steps in entra id setup

---------

Co-authored-by: Marko Mikulicic <mmikulicic@gmail.com>
Co-authored-by: Jack Dockerty <jdockerty@influxdata.com>
Co-authored-by: Jack <56563911+jdockerty@users.noreply.github.com>
Co-authored-by: Jeffrey Smith II <jsmith@influxdata.com>
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2024-02-20 12:56:12 -07:00
Jason Stirnaman 4b371c91d8
Update Go Arrow package version (#5288)
Fixes #5271

- Updates Go samples that use the client library to use the same Arrow package version (v13) used in the client library
- Updates Go FlightSQL examples to use the latest Arrow package (v14).
2023-12-28 14:02:58 -06:00
Scott Anderson c856e84fdc
Add influxctl instructions to query and write task-based docs (#5278)
* added influxctl examples to clustered and dedicated get started

* added task-based influxctl query docs

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2023-12-18 08:25:12 -07:00
Jason Stirnaman 5c74bf4ff6
5156 Writes: add v1 to Serverless get-started (#5233)
* chore(ci): Install Telegraf to test container

* chore(v3): test telegraf config and startup:

- creates the config file for the test run. TODO: remove the duplication and use the content for test setup.
- fix placeholder name

* fix(v3): make test pass for curl API example

* chore(ci): make tests pass for write. Add dependencies to Dockerfile.

* chore(tests): update test build

- Compose metadata: Add profile to test service. We can decouple services later and apply the profile to each. Rename. Pass the image name to the container.
- Fetch the parse_yaml.sh script during docker build, so we only fetch when necessary. Track the script in git. This is still a little janky, but better.
- test.sh: Use `HEAD` for diff (duh). Go back to using docker compose up so we're rebuilding only as needed and reusing the container - much faster, but the output isn't as pretty as `run`.
- pytest.ini, requirements.txt: Use pytest-dotenv to load env.products variables.

* fix(write): update JS instructions and pass tests.

* chore(ci): Install influx v2 CLI into the Docker test container.

* chore(ci): move .env file loading to pytest and run product tests separately with the proper .env file:

- Moves .env configs to be loaded by the test runner instead of by Docker. I'd prefer to ignore any product divergence and have them run interchangeably, but the pros outweigh the cons for now.
- Add example for passing custom commands in the compose file.

* fix(v3): replace curl example with v1 and v2, simplify JS example, pass tests.

feat(v3): add v1 write, test, update text:

- adds Serverless v1 /write example with note about autogen behavior
- adds link from v1 examples to Migrate guide
- adds description of autogen behavior to v1-compat guide
- updates "powered by..." text
- adapts examples to make them more testable, asserts `/write` status code
- replace "shared" examples (only used once) with inline to make them testable

fix(v3): promote migrate link

* Update content/influxdb/cloud-dedicated/get-started/write.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* chore(v3): Write: fix wording for curl success  (#5156)

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2023-11-15 14:41:29 -06:00
Jason Stirnaman c4b97f9acf
5025 fix and test python examples (#5207)
* chore(v3): add test replacements

* fix(v3): get-started/query samples, make testable
2023-10-30 16:48:09 -05:00
Jason Stirnaman c4ccc191b6
fix(v3): remove v2-prefer note, replace with specific recommendations (#5195)
* fix(v3): remove v2-prefer note, replace with specific recommendations

- removes the shared v2-prefer shortcode note.
- adds "Flight client" tag to all Flight RPC and Flight SQL client pages.
- replaces the note with specific write/query notes in each platform.
- misc fixes

* fix(v3): v2 client library typo

* fix(v3): Cleanup usage note for all v2 client libraries

- Change note to warning
- Condense
- Move warning to prepend block
- Make consistent on all pages
- Remove autolinking to GitHub repos

* chore(v3): Add "Clustered"

* fix(v3): typo
2023-10-26 14:45:38 -05:00
Scott Anderson 42a493aafa hotfix: fix typo in get-started query examples, closes #5152 2023-10-25 10:23:27 -06:00
Jason Stirnaman 4f838adb38
V3 summarize tools (#5191)
* feat(v3): add table summarizing tools for each platform

* Update content/influxdb/cloud-dedicated/get-started/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/clustered/get-started/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2023-10-25 08:35:52 -05:00
Jason Stirnaman de4fe4c0ba
Fix: Placeholder cleanup (#5164)
* chore(ci): Update vocab.

* chore(test): Set language-specific replacements for code sample tests

This is a bit of kludge to allow for language-specific replacement patterns
while keeping the code samples valid when a user replaces placeholder strings with their own and copies the sample.
This is necessary for executing (not for validating syntax) of the code samples.

- Workaround for identifying language-specific replacements for pytest-codeblocks test runs.
- Uses Python f-strings to identify Python-specific placeholders.
- To import os for your code sample and hide it from users, wrap it in a comment and use the `pytest-codeblocks:cont` comment tag. See d0ca7e22b8/README.md?plain=1#L117

* fix(v3): Cleanup: fix link and grammar
2023-10-04 09:36:20 -05:00
Jason Stirnaman e278c0cd42
fix(v3): Cloud Dedicated, Clustered: Add v1 write examples to Get Started. (#5153)
* fix(v3): Cloud Dedicated, Clustered: Add v1 write examples to Get Started.

* fix(v3): Cloud Dedicated, Clustered: Add related links, fix titles
2023-09-25 11:03:36 -05:00
Scott Anderson 32d117a647 hotfix: update oauth urls for clustered 2023-09-19 16:12:57 -06:00
Scott Anderson 35ad46c4c2
Version restructure (#5133)
* mass changes for version restructure

* fixed latest-patch and flux version generator

* updated hugo configs

* fixed flux frontmatter injector

* fixed flux frontmatter injector

* WIP api generator updates for version restructure (#5128)

* fixed telegraf plugin list

* removed latest shortcode

* fixed current-version

* fixed product dropdown crosslinking

* fixed alt links

* WIP fixing links

* fixed broken links

* updated api doc generation

* fixed additional resources

* added version redirects to edge.js

* fixed search placeholder

* fixed paged titles
2023-09-12 23:33:31 -06:00
Scott Anderson 471ee4561d
InfluxDB Clustered documentation (#5126)
* WIP base changes for clustered docs

* WIP clustered docs

* Add new influxdb/host shortcode and implement it in 3.0 docs (#5077)

* add new influxdb/host shortcode and implement it in 3.0 docs

* remove oss- cloud-only shortcodes from serverless

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* updated urls js to PR suggestion

* Updated JavaScript, templates, and styles for Clustered URLs (#5079)

* updated js, templates, and styles for clustered urls

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* restructure product dropdown template to be more extensible

* fixed more page template bugs

* fixed references to cloud in clustered

* updated docsearch templates

* added early access flagging and cta-link shortcode

* minor content updates in clustered

* updated staging config

* fixed typo in clustered description

* ported influxctl 2.0.1 to clustered

* ported get started changes to clustered

* ported 3.0 admin docs to clustered

* port null tag content to clustered

* ported influxctl note to clustered

* ported query reorg changes to clustered

* updated early access to limited availability, updated clustered landing content

* ported new content to clustered

* ported new content to clustered

* updated cta on clustered landing page

* Updated notifications and added InfluxDB Clustered announcement notification (#5125)

* updated notifications, added clustered announcement notification

* updated cta in clustered notification

* updated influxctl profile configs

* update clustered search attributes

* updated learn more link in clustered notification

* Apply suggestions from code review

* fixed typos

* fixed typos

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2023-09-06 06:21:47 -06:00