Skip to content

Commit

Permalink
Feature/feb 2024 marketplace apps (#6835)
Browse files Browse the repository at this point in the history
* adds jupyterlab + nats drafts. updates openvpn for ansible release

* update distro vers for cyberpanel + cloudron

* update splunk deployment doc

* update to required-limited-user shortcodes

* add revisions from review

* Fixes links, extra spaces, command code block formatting, and adds missing publish date

---------

Co-authored-by: Matthew Wildman <matt@wildman.online>
  • Loading branch information
tbaka-akamai and wildmanonline authored Feb 20, 2024
1 parent 1e93188 commit 1cd7313
Show file tree
Hide file tree
Showing 7 changed files with 190 additions and 29 deletions.
2 changes: 2 additions & 0 deletions docs/products/tools/marketplace/guides/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ See the [Marketplace](/docs/marketplace/) listing page for a full list of all Ma
- [Jitsi](/docs/products/tools/marketplace/guides/jitsi/)
- [Joomla](/docs/products/tools/marketplace/guides/joomla/)
- [Joplin](/docs/products/tools/marketplace/guides/joplin/)
- [JupyterLab](/docs/products/tools/marketplace/guides/jupyterlab/)
- [Kali Linux](/docs/products/tools/marketplace/guides/kali-linux/)
- [Kepler](/docs/products/tools/marketplace/guides/kepler/)
- [LAMP Stack](/docs/products/tools/marketplace/guides/lamp-stack/)
Expand All @@ -73,6 +74,7 @@ See the [Marketplace](/docs/marketplace/) listing page for a full list of all Ma
- [Minecraft ](/docs/products/tools/marketplace/guides/minecraft/)
- [Moodle](/docs/products/tools/marketplace/guides/moodle/)
- [MySQL/MariaDB](/docs/products/tools/marketplace/guides/mysql/)
- [NATS Single Node](/docs/products/tools/marketplace/guides/nats-single-node/)
- [Nextcloud](/docs/products/tools/marketplace/guides/nextcloud/)
- [NirvaShare](/docs/products/tools/marketplace/guides/nirvashare/)
- [Node.js](/docs/products/tools/marketplace/guides/nodejs/)
Expand Down
6 changes: 4 additions & 2 deletions docs/products/tools/marketplace/guides/cloudron/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ description: "Cloudron is a platform that makes it easy to install, manage and s
keywords: ['cloudron','web apps','platform','marketplace']
tags: ["ubuntu","marketplace", "web applications","linode platform", "cloud manager"]
published: 2020-12-15
modified: 2022-05-17
modified: 2023-01-30
modified_by:
name: Linode
title: "Deploy Cloudron through the Linode Marketplace"
Expand Down Expand Up @@ -31,9 +31,11 @@ Cloudron offers both free and paid plans. Visit [Cloudron's website](https://www

## Configuration Options

- **Supported distributions:** Ubuntu 20.04 LTS
- **Supported distributions:** Ubuntu 22.04 LTS
- **Recommended plan:** All plan types and sizes can be used.

{{< content "marketplace-required-limited-user-fields-shortguide">}}

## Getting Started after Deployment

The Cloudron application is served on the Linode, however it still requires a few additional steps to fully complete the installation process.
Expand Down
6 changes: 4 additions & 2 deletions docs/products/tools/marketplace/guides/cyberpanel/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ description: "CyberPanel is a next-generation control panel, which provides a fr
keywords: ['cyberpanel','marketplace','server']
tags: ["marketplace", "linode platform", "cloud manager"]
published: 2021-02-23
modified: 2023-02-02
modified: 2024-01-30
image: DeployCyberPanel_marketplaceapps.png
modified_by:
name: Linode
Expand All @@ -28,9 +28,11 @@ authors: ["Linode"]

## Configuration Options

- **Supported distributions:** CentOS 7, Ubuntu 20.04 LTS
- **Supported distributions:** Ubuntu 22.04 LTS
- **Recommended minimum plan:** All plan types and sizes can be used with CyberPanel.

{{< content "marketplace-required-limited-user-fields-shortguide">}}

## Getting Started after Deployment

### Access your CyberPanel App
Expand Down
64 changes: 64 additions & 0 deletions docs/products/tools/marketplace/guides/jupyterlab/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
title: "Deploy JupyterLab through the Linode Marketplace"
description: "Deploy JupyterLab on a Linode Compute Instance. Jupyter is a web-based interactive development environment for notebooks, code, and data."
published: 2024-02-20
modified_by:
name: Linode
keywords: ['productivity','notebook','data science']
tags: ["marketplace", "linode platform", "cloud manager"]
external_resources:
- '[Project Jupyter](https://jupyter.org/)'
authors: ["Linode"]
---

[JupyterLab](https://jupyter.org/) stands as the cutting-edge web-based interactive development environment, catering to notebooks, code, and data. With a flexible interface, users can easily configure and arrange workflows in data science, scientific computing, computational journalism, and machine learning.

## Deploying a Marketplace App

{{< content "deploy-marketplace-apps-shortguide">}}

{{< content "marketplace-verify-standard-shortguide">}}

{{< note >}}
**Estimated deployment time:** JupyterLab should be fully installed within 10-15 minutes after the Compute Instance has finished provisioning.
{{< /note >}}

## Configuration Options

- **Supported distributions:** Ubuntu 22.04 LTS
- **Recommended plan:** All plan types and sizes can be used.

### JupyterLab Options

- **Email address** *(required)*: Enter the email address to use for generating the SSL certificates.

{{< content "marketplace-required-limited-user-fields-shortguide">}}

{{< content "marketplace-custom-domain-fields-shortguide">}}

{{< content "marketplace-special-character-limitations-shortguide">}}

### Getting Started after Deployment

## Accessing the Jupyter Server

Launch your web browser and navigate to the custom domain you set during deployment or the reverse DNS (rDNS) domain associated with your Compute Instance (e.g., 192-0-2-1.ip.linodeusercontent.com). This will direct you to the Jupyter Server login page, where you'll need to enter a token or password. For guidance on locating your Linode's IP addresses and rDNS information, consult the [Managing IP Addresses](/docs/products/compute/compute-instances/guides/manage-ip-addresses/) guide.

## Obtaining the Jupyter Token

By default, Jupyter issues a token for authentication. The Jupyter access token was automatically generated during the initial install process and is stored in the `/root/.credentials` file. To view the default token, log in to your Compute Instance either through the [LISH Console](/docs/products/compute/compute-instances/guides/lish/#through-the-cloud-manager-weblish) or via SSH, and check the contents of the file:

```command
cat /root/.credentials
```

Copy and paste this token into the **Password or token:** field on the Jupyter login page. If you prefer password authentication, use the token to set a password in the **Setup a Password** section on the login page. Once this is done, you can employ both the token and the password for accessing JupyterLab.

### More Information

You may wish to consult the following resources for additional information on this topic. While these are provided in the hope that they will be useful, please note that we cannot vouch for the accuracy or timeliness of externally hosted materials.

- [Project Jupyter](https://jupyter.org/)
- [JupyterLab Documentation](https://jupyterlab.readthedocs.io/en/latest/)

{{< content "marketplace-update-note-shortguide">}}
77 changes: 77 additions & 0 deletions docs/products/tools/marketplace/guides/nats-single-node/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
title: "Deploy NATS through the Linode Marketplace"
description: "Deploy NATS on a Linode Compute Instance. NATS is a connective technology responsible for addressing, discovery and exchanging of messages that drive the common patterns in distributed systems; asking and answering questions, aka services/microservices, and making and processing statements, or stream processing."
published: 2024-02-20
modified_by:
name: Linode
keywords: ['cloud native','microservices','distributed systems', 'PubSub']
tags: ["marketplace", "linode platform", "cloud manager"]
external_resources:
- '[NATS](https://nats.io/)'
authors: ["Linode"]
---

[NATS](https://docs.nats.io/nats-concepts/overview) is a connective technology built for the hyper-connected world. It is a single technology that enables applications to securely communicate across any combination of cloud vendors, on-premise, edge, web and mobile, and devices. NATS consists of a family of open-source products that are tightly integrated but can be deployed easily and independently. NATS is being used globally by thousands of companies, spanning use-cases including microservices, edge computing, mobile, and IoT.

## Deploying a Marketplace App

{{< content "deploy-marketplace-apps-shortguide">}}

{{< content "marketplace-verify-standard-shortguide">}}

{{< note >}}
**Estimated deployment time:** NATS should be fully installed within 2-5 minutes after the Compute Instance has finished provisioning.
{{< /note >}}

## Configuration Options

- **Supported distributions:** Ubuntu 22.04 LTS
- **Recommended plan:** All plan types and sizes can be used.

### NATS Server Options

- **NATS Server Name**: The name for the NATS server. Default is "Test".
- **Version**: NATS server software version. Default is 2.10.1.
- **Email address** *(required)*: Enter the email address to use for generating the SSL certificates.
- **NATS Server Port**: NATS server port for clients to connect. Default is 4222.
- **NATS Websocket Port**: To setup the NATS server Websocket port. Default is 8888.
- **NATS MQTT Port**: To setup the NATS server MQTT port. Default is 1883.

{{< content "marketplace-required-limited-user-fields-shortguide">}}

{{< content "marketplace-custom-domain-fields-shortguide">}}

{{< content "marketplace-special-character-limitations-shortguide">}}

### Getting Started after Deployment

## Accessing the NATS Monitoring UI

To monitor the NATS messaging system, nats-server provides a lightweight HTTP server on a dedicated monitoring port. The monitoring server provides several endpoints, providing statistics and other information.

Open your web browser and go to the custom domain you specified during deployment or the rDNS domain of your Compute Instance (e.g., `192-0-2-1.ip.linodeusercontent.com`). This will take you to the NATS monitoring page. Refer to the [Monitoring NATS](https://docs.nats.io/running-a-nats-service/nats_admin/monitoring) guide for details on the different endpoints, statistics and other info you have access to.

## Obtaining the NATS users passwords.

By default, this NATS deployment creates 2 users, one named "example" and another system user named "system". The passwords for these users are generated during the initial install process. To obtain these password, log in to your Compute Instance either through the [LISH Console](/docs/products/compute/compute-instances/guides/lish/#through-the-cloud-manager-weblish) or via SSH, then just read the /root/.credentials file, ie:

```command
cat /root/.credentials
```
This file will contain the two credentials needed for those users.

For details, see [NATS Authorization](https://docs.nats.io/running-a-nats-service/configuration/securing_nats/authorization).

### More Information

For more information, refer to these resources. Note that we can't confirm the authenticity of externally hosted materials.

- [Support](https://natsio.slack.com/)

- [Installation examples](https://docs.nats.io/running-a-nats-service/introduction/installation)

- [Sample code/Tutorials](https://natsbyexample.com/)

- [Latest version](https://github.com/nats-io/nats-server)

{{< content "marketplace-update-note-shortguide">}}
35 changes: 15 additions & 20 deletions docs/products/tools/marketplace/guides/openvpn/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ keywords: ['vpn','openvpn','tunnel','marketplace app']
tags: ["ssl","cloud-manager","linode platform","security","marketplace","vpn"]
bundles: ['network-security']
published: 2019-04-05
modified: 2022-03-08
modified: 2024-01-30
modified_by:
name: Linode
title: "Deploy OpenVPN through the Linode Marketplace"
Expand Down Expand Up @@ -32,7 +32,7 @@ OpenVPN is a widely trusted, free, and open-source VPN (virtual private network)

## Configuration Options

- **Supported distributions:** Debian 11, Ubuntu 20.04 LTS
- **Supported distributions:** Ubuntu 22.04 LTS
- **Recommended minimum plan:** All plan types and sizes can be used, though consider the amount of traffic needed for the VPN and select a plan with enough *Outbound Network Transfer* to handle the expected traffic.

### OpenVPN Options
Expand All @@ -41,9 +41,10 @@ OpenVPN is a widely trusted, free, and open-source VPN (virtual private network)
The admin password for the OpenVPN application is no longer manually entered when creating the Compute Instance. Instead, this password is now automatically generated. See [Obtaining the Admin Password](#obtaining-the-admin-password) for instructions on viewing the admin password after deployment.
{{< /note >}}

{{< content "marketplace-limited-user-fields-shortguide">}}
{{< content "marketplace-required-limited-user-fields-shortguide">}}

{{< content "marketplace-custom-domain-fields-shortguide">}}
- **Email address for Let's Encrypt SSL Certificate (required):** Start of Authority address for free Let's Encrypt SSL.
- **Email address for the SOA record:** The start of authority (SOA) email address for this server. This is a required field if you want the installer to create DNS records.

{{< content "marketplace-special-character-limitations-shortguide">}}
Expand All @@ -52,13 +53,9 @@ The admin password for the OpenVPN application is no longer manually entered whe

### Access Details

{{< note type="alert" >}}
OpenVPN Access Server is only accessible over an *HTTPS* connection (not *HTTP*). When accessing both the admin and client dashboards, your browser may warn you that the connection is not private, is not secure, or that there is a potential security risk. You must accept this risk to continue.
{{< /note >}}

**OpenVPN Admin Interface:**

- **URL:** `https://192.0.2.1:943/admin/`, where `192.0.2.1` represents the IPv4 address of your new Compute Instance. For assistance locating the IP address, see [Managing IP Addresses](/docs/products/compute/compute-instances/guides/manage-ip-addresses/#viewing-ip-addresses).
- **URL:** `https://192-0-2-1.ip.linodeusercontent.com`, where `192-0-2-1` represents the IPv4 address of your new Compute Instance. See the [Managing IP Addresses](/docs/products/compute/compute-instances/guides/manage-ip-addresses/#configuring-rdns) guide for information on viewing the rDNS value.
- **Username:** `openvpn`
- **Password:** See [Obtaining the Admin Password](#obtaining-the-admin-password) below.

Expand All @@ -70,23 +67,21 @@ For more details on logging in to the OpenVPN admin interface for the first time

### Obtaining the Admin Password

The password for the main administrator account was automatically generated during the initial install process. To find this password, log in to your Compute Instance through the [LISH Console](/docs/products/compute/compute-instances/guides/lish/#through-the-cloud-manager-weblish). Your credentials should appear towards the end of the installation script.

{{<output>}}
Access Server Web UIs are available here:
Admin UI: https://192.0.2.1:943/admin
Client UI: https://192.0.2.1:943/
Login as "openvpn" with "password" to continue
(password can be changed on Admin UI)
+++++++++++++++++++++++++++++++++++++++++++++++
{{</output>}}
The password for the main administrator account was automatically generated during the initial install process. To find this password, log in to your Compute Instance through the [LISH Console](/docs/products/compute/compute-instances/guides/lish/#through-the-cloud-manager-weblish). The credentials are available in the file `/root/.credentials`
```
cat /root/.credentials
Sudo Username: $SUDO_USER
Sudo Password: 2e7cmU8z157xJbGV8LNU0KbUG
OpenVPN Username: openvpn
OpenVPN Password: 9oxKqQT098DV
```

You can also obtain your password by running the following command:
To obtain your OpenVPN password, run this command:

cat /usr/local/openvpn_as/init.log | grep 'To login'

### Open a Connection to your VPN

To open a connection to your OpenVPN server from your computer, you'll need to install the OpenVPN client software. Follow the instructions in the [Client Software Installation](/docs/guides/install-openvpn-access-server-on-linux/#client-software-installation) section of our [OpenVPN](/docs/guides/install-openvpn-access-server-on-linux/#client-software-installation) guide for a detailed explanation of how to install and use this software.

{{< content "marketplace-update-note-shortguide">}}
{{< content "marketplace-update-note-shortguide">}}
29 changes: 24 additions & 5 deletions docs/products/tools/marketplace/guides/splunk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ description: "This guide shows you how to install Splunk, a powerful data soluti
keywords: ['monitoring','splunk', 'data solution']
tags: ["marketplace", "linode platform", "cloud manager"]
published: 2021-09-03
modified: 2022-03-08
modified: 2024-01-31
modified_by:
name: Linode
title: "Deploy Splunk through the Linode Marketplace"
Expand All @@ -15,6 +15,8 @@ authors: ["Linode"]

Splunk is a powerful log analyzer that can be used to obtain insight into your infrastructure. Splunk collects, monitors, analyzes, and visualizes data from database applications, web servers, cloud networks, and a variety of other sources.

The Akamai Connected Cloud Splunk Marketplace App includes support for the [Akamai SIEM integration](https://techdocs.akamai.com/siem-integration/docs/akamai-siem-integration-for-splunk-and-cef-syslog) on deployment. For details on generating valid tokens, see [create authentication credentials](https://techdocs.akamai.com/developer/docs/set-up-authentication-credentials).

## Deploying a Marketplace App

{{< content "deploy-marketplace-apps-shortguide">}}
Expand All @@ -27,26 +29,43 @@ Splunk is a powerful log analyzer that can be used to obtain insight into your i

## Configuration Options

- **Supported distributions:** Debian 10, Ubuntu 20.04 LTS
- **Supported distributions:** Ubuntu 22.04 LTS
- **Recommended minimum plan:** All plan types and sizes can be used.

### Splunk Options

- **Splunk Admin user** *(required)*: This will be the username you use to login the Splunk Dashboard.
- **Splunk Admin Password** *(required)*: This will be the password you use to login the Splunk Dashboard.
- **Akamai Access Token**: Akamai Access Token
- **Akamai Client Secret**: Akamai Client Secret
- **Akamai Client Token**: Akamai Client Token
- **Luna Hostname**: Akamai Luna Hostname
- **Akamai Security Configuration ID**: Akamai Security Configuration ID

{{< content "marketplace-custom-domain-fields-shortguide">}}
- **Email address for the SOA record:** The start of authority (SOA) email address for this server. This is a required field if you want the installer to create DNS records.

{{< content "marketplace-limited-user-fields-shortguide">}}
{{< content "marketplace-required-limited-user-fields-shortguide">}}

{{< content "marketplace-special-character-limitations-shortguide">}}

## Getting Started after Deployment

### Obtaining the Admin Password

The password for the sudo user account was automatically generated during the initial install process. To find this password, log in to your Compute Instance through the [LISH Console](/docs/products/compute/compute-instances/guides/lish/#through-the-cloud-manager-weblish). The credentials are available in the file `/root/.credentials`
```
cat /root/.credentials
sudo username: $SUDO_USER
sudo password: 0oVSsWmkbGesmtuTlOEgFl7t
splunk user: $SPLUNK_USER
splunk admin password: fRLdHksJoMPrjLtRCogEPVLYOML1zQtQ0kIsL7IWvo49
```

### Access your Splunk App

Open a browser and navigate to your [Linode's IP address](/docs/guides/find-your-linodes-ip-address/) and port `8000`, for example, `http://192.0.2.0:8000/`. You will be presented a login field where you can enter the credentials you previously specified in the *Splunk Username* and *Splunk Password* fields when you deployed the app.
Open a browser and navigate to `https://192-0-2-1.ip.linodeusercontent.com:8000`, where `192-0-2-1` represents the IPv4 address of your new Compute Instance. See the [Managing IP Addresses](/docs/products/compute/compute-instances/guides/manage-ip-addresses/#configuring-rdns) guide for information on viewing the rDNS value.

You will be presented a login field where you can enter the credentials you previously specified in the *Splunk Username* and the generated *Splunk Password* in `/root/.credentials`

Now that you’ve accessed your dashboard, checkout [the official Splunk documentation](https://docs.splunk.com/Documentation/Splunk) to learn how to further configure your instance.

Expand Down

0 comments on commit 1cd7313

Please sign in to comment.