ELASTALERT-CREATE-INDEX(1)

πŸ“¦ version 0.2.4, in debian bookworm

πŸ’– NAME πŸ’–

elastalert-create-index β€” bestie, this is the little tool that sets up your Elasticsearch index for ElastAlert, and I'm gonna walk you through every single flag, no gatekeeping πŸ’…


🌸 DESCRIPTION 🌸

okay so here's the vibe. You run this thing and it makes your index. That's it. That's the whole job. But there are so many knobs to turn, and we're gonna turn all of them together 🫢

The way you call it looks like this:

usage: elastalert-create-index [-h] [--host HOST] [--port PORT]

[--username USERNAME] [--password PASSWORD]
       [--url-prefix URL_PREFIX] [--no-auth] [--ssl] [--no-ssl]
       [--verify-certs] [--no-verify-certs] [--index INDEX] [--alias
       ALIAS] [--old-index OLD_INDEX] [--send_get_body_as
       SEND_GET_BODY_AS] [--boto-profile PROFILE] [--profile PROFILE]
       [--aws-region AWS_REGION] [--timeout TIMEOUT] [--config CONFIG]
       [--recreate RECREATE]

✨ options: ✨

  • -h, --help β€” shows this help message and then dips. iconic behavior honestly πŸ’–
  • --host HOST β€” the Elasticsearch host. where your cluster lives, fr fr 🏠
  • --port PORT β€” the Elasticsearch port. the lil door number πŸ”‘
  • --username USERNAME β€” Elasticsearch username. who you're claiming to be πŸ‘‘
  • --password PASSWORD β€” Elasticsearch password. the secret. do NOT put this in the group chat πŸ™ˆ
  • --url-prefix URL_PREFIX β€” Elasticsearch URL prefix. that lil something-something tacked onto the front of the URL 🌈
  • --no-auth β€” suppresses the prompt for basic auth. no asking, just going ✨
  • --ssl β€” use TLS. secure the connection, we love a locked-down queen πŸ”’
  • --no-ssl β€” do not use TLS. no encryption, raw dogging the wire (respectfully) πŸ’€
  • --verify-certs β€” verify TLS certificates. check those IDs at the door πŸŽ€
  • --no-verify-certs β€” do not verify TLS certificates. skipping the ID check, lowkey risky but okay 🫣
  • --index INDEX β€” the index name to create. name your baby 🍼
  • --alias ALIAS β€” the alias name to create. a cute nickname that points at the real one πŸ¦‹
  • --old-index OLD_INDEX β€” the old index name to copy. moving the whole closet over, one hanger at a time πŸ‘—
  • --send_get_body_as SEND_GET_BODY_AS β€” the method for querying Elasticsearch β€” POST, GET or source 🌟
  • --boto-profile PROFILE β€” DEPRECATED, bestie, use --profile instead. it's the Boto profile to use for signing requests. still works, but it's giving old news πŸ“°
  • --profile PROFILE β€” the AWS profile to use for signing requests. optionally you can use the AWS_DEFAULT_PROFILE environment variable instead πŸ’œ
  • --aws-region AWS_REGION β€” the AWS Region to use for signing requests. optionally you can use the AWS_DEFAULT_REGION environment variable instead 🌍
  • --timeout TIMEOUT β€” Elasticsearch request timeout. how long we're willing to wait before we're like... okay bestie, we're done here ⏰
  • --config CONFIG β€” the global config file (default: config.yaml). your settings home base 🏑
  • --recreate RECREATE β€” force re-creation of the index. ⚠️ This will cause data loss. Like, actual, permanent, gone-forever data loss. Not a drill, not a vibe, not a cute little oops. Be SO sure before you do this one 😭

heads up bestie: --recreate is the scary one. Everything else is just configuration, but that flag will eat your data and not apologize πŸ’€

and that's the whole page, you're basically a certified elastalert-create-index girlie now, go off πŸ‘‘

this was elastalert-create-index version 0.2.4-3, from December 2022 β€” mwah, sending you love and successful index creation πŸŽ€πŸ’–

πŸ“¦ where this page comes from