Point an appropriate hostname<\/a> to the server’s ipv4 address. You need to do this step for us to get a TLS certificate from Letsencrypt automatically.<\/p>\n\nExpanding virtual memory and joining the docker group<\/h3>\n\n
SSH into the server.<\/p>\n\n
We will run all commands as the debian user, but need to use sudo occasionally.<\/p>\n\n
Start by joining the docker group and activating it for your session.<\/p>\n\n
We also need to extend vm.max_map_count as OpenSearch can otherwise cause some out of memory exceptions.<\/p>\n\n
sudo usermod -aG docker $USER\nnewgrp docker\necho 'vm.max_map_count=262144' | sudo tee -a \/etc\/sysctl.d\/opensearch.conf\nsudo sysctl -p<\/pre>\n\nCreating a Docker network<\/h3>\n\n
Create a docker network that we use for the containers we want to proxy via Caddy and automatically manage Let’s Encrypt\/Zero SSL to get secure connectivity.<\/p>\n\n
docker network create caddy<\/pre>\n\nCreate a hashed password for Basic Auth to Caddy<\/h3>\n\n
We use the hash-password command from Caddy to hash a password. Do not copy the text below, but replace the text PASSWORD with a good password<\/strong>that you will need to use in your application to connect to OpenSearch.<\/p>\n\nWe replace $ with $$ with sed so that the hash will work in docker-compose.yml, otherwise it will be interpreted as variables.<\/p>\n\n
docker run --rm lucaslorentz\/caddy-docker-proxy:ci-alpine hash-password --plaintext PASSWORD|sed 's\/\\$\/\\$\\$\/g'\n<\/pre>\n\nSet up the docker-compose.yml file<\/h3>\n\n
Now we create the folder for the docker-compose.yml file and add the text below.Replace HASHED_PASSWORD<\/strong> with the password hash you got above.<\/p>\n\nmkdir -p ~\/compose\/opensearch\ncat ~\/compose\/opensearch\/docker-compose.yml\nversion: \"3.7\" \n \nservices: \n caddy: \n image: lucaslorentz\/caddy-docker-proxy:ci-alpine \n ports: \n - 80:80 \n - 443:443 \n environment: \n - CADDY_INGRESS_NETWORKS=caddy \n networks: \n - caddy \n volumes: \n - \/var\/run\/docker.sock:\/var\/run\/docker.sock \n - caddy_data:\/data \n restart: unless-stopped \n opensearch: \n image: opensearchproject\/opensearch:2.11.1\n volumes: \n - osdata01:\/usr\/share\/opensearch\/data\n environment:\n - \"cluster.name=opensearch-cluster\"\n - \"node.name=os-node01\"\n - \"discovery.type=single-node\"\n - \"bootstrap.memory_lock=true\"\n - \"plugins.security.disabled=true\"\n - \"OPENSEARCH_JAVA_OPTS=-Xms2G -Xmx2G\"\n labels:\n caddy: HOSTNAME\n caddy.reverse_proxy: \"{{upstreams 9200}}\"\n caddy.basicauth: \/*\n caddy.basicauth.admin: HASHED_PASSWORD\n networks:\n - caddy\n ulimits:\n memlock:\n soft: -1\n hard: -1\n nofile:\n soft: 65536\n hard: 65536\n restart: unless-stopped\n\nvolumes:\n osdata01:\n driver: local\n caddy_data:\n driver: local\n\nnetworks:\n caddy:\n external: true\nEDF<\/eof><\/pre>\n\nWe also set the maximum memory usage for the Java engine to 2GB above. You may need to increase this as well as the server’s memory if you have large indexes.<\/p>\n\n
Enter your host name<\/h3>\n\n
If you have specified a hostname that you want to use for the server or for OpenSearch, you can now edit the code snippet above and change HOSTNAME to your chosen hostname. You can also do it afterwards with the sed command shown below.<\/p>\n\n
For demo purposes, we created os.oderland.cloud so that we can then go to https:\/\/ os.oderland.cloud to reach OpenSearch. The example looks like this with the sed command.<\/p>\n\n
sed -i 's\/HOSTNAME\/os.oderland.cloud\/g' ~\/compose\/opensearch\/docker-compose.yml<\/pre>\n\nStarting up OpenSearch and Caddy<\/h3>\n\n
Then launch our new docker compose stack.<\/p>\n\n
cd ~\/compose\/opensearch\ndocker compose up -d<\/pre>\n\nAll images\/layers are then downloaded and the services start up.<\/p>\n\n
You can follow the log via: <\/p>\n\n
docker compose logs -f<\/pre>\n\nFrequently asked questions<\/h2>\n\nChange host name<\/h3>\n\n
If you edit the docker-compose.yml file afterwards and change to another hostname, you need to restart the stack and force new configs via:<\/p>\n\n
docker compose up --force-recreate -d<\/pre>\n\nHow to control the Caddy Proxy<\/h3>\n\n
Read more about the Caddy proxy<\/a> and how you can control via e.g. paths or how to add more domains to the same service.<\/p>\n","protected":false},"excerpt":{"rendered":"What is OpenSearch and why do I want to install it? OpenSearch is a distributed search and analysis engine based on Apache Lucene. It is used as a tool to assist in searches, analysis and monitoring. Some systems such as Magento, WordPress, etc. can use this to speed up and…<\/p>\n","protected":false},"author":15,"comment_status":"open","ping_status":"closed","template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"ht-kb-category":[682],"ht-kb-tag":[],"class_list":["post-21939","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_category-cloud-en"],"acf":[],"_links":{"self":[{"href":"https:\/\/www.oderland.se\/support\/en\/wp-json\/wp\/v2\/ht-kb\/21939","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.oderland.se\/support\/en\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/www.oderland.se\/support\/en\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/www.oderland.se\/support\/en\/wp-json\/wp\/v2\/users\/15"}],"replies":[{"embeddable":true,"href":"https:\/\/www.oderland.se\/support\/en\/wp-json\/wp\/v2\/comments?post=21939"}],"version-history":[{"count":5,"href":"https:\/\/www.oderland.se\/support\/en\/wp-json\/wp\/v2\/ht-kb\/21939\/revisions"}],"predecessor-version":[{"id":21946,"href":"https:\/\/www.oderland.se\/support\/en\/wp-json\/wp\/v2\/ht-kb\/21939\/revisions\/21946"}],"wp:attachment":[{"href":"https:\/\/www.oderland.se\/support\/en\/wp-json\/wp\/v2\/media?parent=21939"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/www.oderland.se\/support\/en\/wp-json\/wp\/v2\/ht-kb-category?post=21939"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/www.oderland.se\/support\/en\/wp-json\/wp\/v2\/ht-kb-tag?post=21939"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
![\"OpenSearch](\"https:\/\/www.oderland.se\/support\/wp-content\/uploads\/2024\/02\/opensearch_logo_default-1024x196.png\"){kind=logo}
<\/figure>\n\n