Skip to content

Commit 892fe89

Browse files
Add keyrings directory creation to Debian documentation (#11977) (#12023)
1 parent c45586a commit 892fe89

File tree

2 files changed

+141
-80
lines changed

2 files changed

+141
-80
lines changed

_install-and-configure/install-dashboards/debian.md

Lines changed: 70 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -24,120 +24,169 @@ This guide assumes that you are comfortable working from the Linux command line
2424
## Installing OpenSearch Dashboards from a package
2525

2626
1. Download the Debian package for the desired version directly from the [OpenSearch downloads page](https://opensearch.org/downloads.html){:target='\_blank'}. The Debian package can be downloaded for both **x64** and **arm64** architectures.
27-
1. From the CLI, install using `dpkg`.
27+
1. From the CLI, install using `dpkg`:
2828
```bash
2929
# x64
3030
sudo dpkg -i opensearch-dashboards-{{site.opensearch_dashboards_version}}-linux-x64.deb
3131
# arm64
3232
sudo dpkg -i opensearch-dashboards-{{site.opensearch_dashboards_version}}-linux-arm64.deb
3333
```
34-
1. After the installation completes, reload the systemd manager configuration.
34+
{% include copy.html %}
35+
36+
1. After the installation completes, reload the systemd manager configuration:
3537
```bash
3638
sudo systemctl daemon-reload
3739
```
38-
1. Enable OpenSearch as a service.
40+
{% include copy.html %}
41+
42+
1. Enable OpenSearch Dashboards as a service:
3943
```bash
4044
sudo systemctl enable opensearch-dashboards
4145
```
42-
1. Start the OpenSearch service.
46+
{% include copy.html %}
47+
48+
1. Start the OpenSearch Dashboards service:
4349
```bash
4450
sudo systemctl start opensearch-dashboards
4551
```
46-
1. Verify that OpenSearch launched correctly.
52+
{% include copy.html %}
53+
54+
1. Verify that OpenSearch Dashboards launched correctly:
4755
```bash
4856
sudo systemctl status opensearch-dashboards
4957
```
58+
{% include copy.html %}
5059

5160
### Fingerprint verification
5261

5362
The Debian package is not signed. If you would like to verify the fingerprint, the OpenSearch Project provides a `.sig` file as well as the `.deb` package for use with GNU Privacy Guard (GPG).
5463

55-
1. Download the desired Debian package.
64+
1. Download the desired Debian package:
5665
```bash
5766
curl -SLO https://artifacts.opensearch.org/releases/bundle/opensearch-dashboards/{{site.opensearch_dashboards_version}}/opensearch-dashboards-{{site.opensearch_dashboards_version}}-linux-x64.deb
5867
```
59-
1. Download the corresponding signature file.
68+
{% include copy.html %}
69+
70+
1. Download the corresponding signature file:
6071
```bash
6172
curl -SLO https://artifacts.opensearch.org/releases/bundle/opensearch-dashboards/{{site.opensearch_dashboards_version}}/opensearch-dashboards-{{site.opensearch_dashboards_version}}-linux-x64.deb.sig
6273
```
63-
1. Download and import the GPG key.
74+
{% include copy.html %}
75+
76+
1. Download and import the GPG key:
6477
```bash
6578
curl -o- https://artifacts.opensearch.org/publickeys/opensearch-release.pgp | gpg --import -
6679
```
67-
1. Verify the signature.
80+
{% include copy.html %}
81+
82+
1. Verify the signature:
6883
```bash
6984
gpg --verify opensearch-dashboards-{{site.opensearch_dashboards_version}}-linux-x64.deb.sig opensearch-dashboards-{{site.opensearch_dashboards_version}}-linux-x64.deb
7085
```
86+
{% include copy.html %}
7187

7288
## Installing OpenSearch Dashboards from an APT repository
7389

7490
APT, the primary package management tool for Debian–based operating systems, allows you to download and install the Debian package from the APT repository.
7591

76-
1. Install the necessary packages.
92+
1. Install the necessary packages:
7793
```bash
7894
sudo apt-get update && sudo apt-get -y install lsb-release ca-certificates curl gnupg2
7995
```
96+
{% include copy.html %}
97+
98+
1. Create the keyrings directory if it doesn't already exist:
99+
```bash
100+
sudo mkdir -p /etc/apt/keyrings
101+
```
102+
{% include copy.html %}
103+
80104
1. Import the public GPG key. This key is used to verify that the APT repository is signed.
81105
```bash
82106
curl -o- https://artifacts.opensearch.org/publickeys/opensearch-release.pgp | sudo gpg --dearmor --batch --yes -o /etc/apt/keyrings/opensearch-release-keyring
83107
```
84-
1. Create an APT repository for OpenSearch.
108+
{% include copy.html %}
109+
110+
1. Create an APT repository for OpenSearch Dashboards:
85111
```bash
86112
echo "deb [signed-by=/etc/apt/keyrings/opensearch-release-keyring] https://artifacts.opensearch.org/releases/bundle/opensearch-dashboards/{{major_version_mask}}/apt stable main" | sudo tee /etc/apt/sources.list.d/opensearch-dashboards-{{major_version_mask}}.list
87113
```
88-
1. Verify that the repository was created successfully.
114+
{% include copy.html %}
115+
116+
1. Verify that the repository was created successfully:
89117
```bash
90118
sudo apt-get update
91119
```
120+
{% include copy.html %}
121+
92122
1. (Optional) As of May 22, 2024, the `Origin` and `Label` values of the APT repository were updated as part of [this change](https://github.com/opensearch-project/opensearch-build/issues/4485). If you created the APT repository before this date, run the following command to accept the updated release information:
93123
```bash
94124
sudo apt-get update --allow-releaseinfo-change
95125
```
96-
1. With the repository information added, list all available versions of OpenSearch:
126+
{% include copy.html %}
127+
128+
1. With the repository information added, list all available versions of OpenSearch Dashboards:
97129
```bash
98130
sudo apt list -a opensearch-dashboards
99131
```
100-
1. Choose the version of OpenSearch you want to install:
101-
- Unless otherwise indicated, the latest available version of OpenSearch is installed.
132+
{% include copy.html %}
133+
134+
1. Choose the version of OpenSearch Dashboards you want to install:
135+
- Unless otherwise indicated, the latest available version of OpenSearch Dashboards is installed.
102136
```bash
103137
sudo apt-get install opensearch-dashboards
104138
```
139+
{% include copy.html %}
140+
105141
- To install a specific version of OpenSearch Dashboards, pass a version number after the package name.
106142
```bash
107143
# Specify the version manually using opensearch=<version>
108144
sudo apt-get install opensearch-dashboards={{site.opensearch_dashboards_version}}
109145
```
110-
1. Once complete, enable OpenSearch.
146+
{% include copy.html %}
147+
148+
1. Once complete, enable OpenSearch Dashboards:
111149
```bash
112150
sudo systemctl enable opensearch-dashboards
113151
```
114-
1. Start OpenSearch.
152+
{% include copy.html %}
153+
154+
1. Start OpenSearch Dashboards:
115155
```bash
116156
sudo systemctl start opensearch-dashboards
117157
```
118-
1. Verify that OpenSearch launched correctly.
158+
{% include copy.html %}
159+
160+
1. Verify that OpenSearch Dashboards launched correctly:
119161
```bash
120162
sudo systemctl status opensearch-dashboards
121163
```
164+
{% include copy.html %}
122165
123166
## Exploring OpenSearch Dashboards
124167
125168
By default, OpenSearch Dashboards, like OpenSearch, binds to `localhost` when you initially install it. As a result, OpenSearch Dashboards is not reachable from a remote host unless the configuration is updated.
126169
127-
1. Open `opensearch_dashboards.yml`.
170+
1. Open `opensearch_dashboards.yml`:
128171
```bash
129172
sudo vi /etc/opensearch-dashboards/opensearch_dashboards.yml
130173
```
131-
1. Specify a network interface that OpenSearch Dashboards should bind to.
174+
{% include copy.html %}
175+
176+
1. Specify a network interface that OpenSearch Dashboards should bind to:
132177
```bash
133178
# Use 0.0.0.0 to bind to any available interface.
134179
server.host: 0.0.0.0
135180
```
181+
{% include copy.html %}
182+
136183
1. Save and quit.
137-
1. Restart OpenSearch Dashboards to apply the configuration change.
184+
1. Restart OpenSearch Dashboards to apply the configuration change:
138185
```bash
139186
sudo systemctl restart opensearch-dashboards
140187
```
188+
{% include copy.html %}
189+
141190
1. From a web browser, navigate to OpenSearch Dashboards. The default port is 5601.
142191
1. Log in with the default username `admin` and the default password `admin`. (For OpenSearch 2.12 and later, the password should be the custom admin password)
143192
1. Visit [Getting started with OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/index/) to learn more.

0 commit comments

Comments
 (0)