Skip to content

Commit

Permalink
updated composition manual installation
Browse files Browse the repository at this point in the history
  • Loading branch information
juliarobles committed Oct 18, 2024
1 parent 10545b6 commit 532a177
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 5 deletions.
26 changes: 24 additions & 2 deletions docs/docs/installation/manual/composition.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ The installation of the OpenTwins plugin in Grafana will depend on how Grafana w
<Tabs groupId="environment">
<TabItem value="helm" label="Helm" default>

To install the plugin you need to add its compiled code in a folder with the same name as its ID inside the Grafana plugins folder, which is X by default.
To install the plugin you need to add its compiled code in a folder with the same name as its ID inside the Grafana plugins folder, which is _/var/lib/grafana/plugins_ by default.
To do this using Helm, add an extraInitContainer to your values.yaml, where you navigate to the plugins folder, download the zip of the latest release and unzip it.
Below is what you need to add.

Expand Down Expand Up @@ -169,7 +169,29 @@ Verify that the Grafana pod is in Running and Ready status. The OpenTwins plugin

</TabItem>
<TabItem value="local" label="Local">
Por ahora el plugin no está firmado, así que tendremos que especificar en el archivo de configuraci

To install the plugin on a local Grafana, you must first download the zip file of the latest plugin release and then access the Grafana folder on your PC.

In this folder you have to find the [Grafana configuration file](https://grafana.com/docs/grafana/v9.5/setup-grafana/configure-grafana). Follow the [Grafana documentation](https://grafana.com/docs/grafana/v9.5/setup-grafana/configure-grafana/#configuration-file-location) to know its location, the name of the file and how to modify it. When you have it, modify the appropriate file by uncommenting and adding the following:

```ini
[plugins]
# Enter a comma-separated list of plugin identifiers to identify plugins to load even if they are unsigned. Plugins with modified signatures are never loaded.
allow_loading_unsigned_plugins = ertis-opentwins
```

In the same file, check the [path to the plugins folder](https://grafana.com/docs/grafana/v9.5/setup-grafana/configure-grafana/#plugins). You can modify it if you consider it convenient. Then, go to that folder and unzip the plugin zip file. You should get a folder with the name "ertis-opentwins" which must have something like this inside (make sure that there are no intermediate folders).

<center>
<img
src={require('./img/opentwins-plugin-content.png').default}
alt="Kubectl get services"
style={{ width: 700 }}
/>
</center>

For the changes to take effect, **Grafana must be restarted**. Please refer to [its documentation](https://grafana.com/docs/grafana/v9.5/setup-grafana/start-restart-grafana/) to find out how to do this depending on your operating system. The OpenTwins plugin should now be available for enabling in the Grafana configuration.

</TabItem>
</Tabs>

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/docs/installation/manual/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import DocCardList from '@theme/DocCardList';

:::warning

The documentation of this method is being written right now. We recommend using [helm installation](./using-helm.mdx).
The documentation of this method is being written right now. We recommend using [helm installation](../using-helm.mdx).

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/overview/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ OpenTwins is built on a **open source microservices architecture**, designed to

:::note

Although it is possible to deploy and connect the different components without containerization, this approach is not recommended due to the difficulties involved in terms of installation and management. However, it is important to note that OpenTwins could be [manually connected](../installation/manual.md) to non-containerized components, such as a local instance of Grafana.
Although it is possible to deploy and connect the different components without containerization, this approach is not recommended due to the difficulties involved in terms of installation and management. However, it is important to note that OpenTwins could be [manually connected](../installation/manual/index.md) to non-containerized components, such as a local instance of Grafana.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -518,4 +518,4 @@ from(bucket: "opentwins")
This satisfies the basic requirements to consider a system as a digital twin.
However, to take full advantage of its capabilities, we recommend including other functionalities or additional data sources.
This will allow you to obtain a more complete and accurate view of the real system.
You can check our [guides](./category/guides) for more information
You can check our [guides](./guides/index.md) for more information

0 comments on commit 532a177

Please sign in to comment.