Site map

Getting started with IBM Cloud Satellite

Getting started with IBM Cloud Satellite

• What are Satellite locations, hosts, and so on?

• Choose your infrastructure for Satellite

  • Minimum requirements for hosts

• I created a Satellite location, what comes next?

Understanding Satellite use cases

Satellite use cases

• Benefits of using Satellite

• Common use cases for Satellite

  • Deploy Red Hat OpenShift environment as a managed service wherever it is needed

• Finance use cases for Satellite

  • Leverage mainframe data for customers who are restricted from moving data to the cloud

  • Provide a unified environment for developing, verifying, and running containers for customers on third-party clouds

  • Extend IBM Cloud security and compliance for maintaining cloud security

• Insurance use cases for Satellite

  • Analytics platform on-premises

• Manufacturing use cases for Satellite

  • Internet of Things (IoT) service platform

  • Enable the digital transformation of on-premises legacy systems at steel mills and other manufacturing plants

  • Establish a service platform for point of sale (POS) or multi function printer (MFP) systems

  • Accelerate the establishment of new global sites and plants

  • Contain cost and speed for new services during development phase and move on-premises once established

  • Deploy applications on-premises, scale out to the cloud only during peak times

• Distribution use cases for Satellite

  • Deliver and integrate store or warehouse digitization solutions for the distribution or retail sectors

• Public sector or health use cases for Satellite

  • On-premises service platform

• Communications use cases for Satellite

  • Multi-access edge computing (MEC) platform support service

• Utilities use cases for Satellite

  • Expand the use of smart meters with Satellite

Satellite for resellers

• Account overview

• Managing client locations and clusters

• Understanding responsibilities for your enterprise and your clients

• Setting up your account

  • Creating an enterprise account

  • Setting up client accounts

• Setting up the client location

  • Sizing and creating the client location

  • Attaching hosts to the location

  • Assigning hosts to the control plane

• Creating a cluster, API key, and cluster roles

  • Creating a Satellite cluster

  • Creating an API key

  • Setting up cluster admin and developer roles

Edge environments for AI, IoT, and machine learning

• Solving common edge workload challenges with IBM Cloud

• Setting up your edge solution with Satellite

  • Step 1: Set up machine learning and model training for your data

  • Step 2: Deploy Satellite with a serverless component to your edge environment

  • Step 3: Run model inferencing at the edge

Understanding Satellite location and hosts

Understanding Satellite location and hosts

• Satellite location overview

• I created a Satellite location, what comes next?

Understanding Satellite Connector

Satellite Connector overview

• Minimum requirements

• Network requirements

• Next steps

Satellite Connector and Secure Gateway

• Terminology mapping

• Capabilities

Satellite Connector FAQ

• Does Satellite Connector support Cloud Endpoints?

• How can I restrict access to my endpoints?

• I created an ACL for my Connector, why doesn't it take effect?

• What IAM permissions do I need for Connectors?

• How many Connectors are supported per account per region?

• How many endpoints are supported per Connector?

• How many instances of Connector agent can I run?

• Can I deploy Satellite Connectors within IBM Cloud?

Supported Satellite-enabled IBM Cloud services

Supported Satellite-enabled IBM Cloud services

• Setting up access for Satellite-enabled services

Release notes

Release notes

• March 2024

  • 7 March 2024

    • Satellite storage template patch updates are available.

• February 2024

  • 27 February 2024

    • CLI version 1.0.597 is available.

  • 19 February 2024

    • Connector agent for Windows version 1.1.1.

    • Connector agent image version 1.1.4.

  • 16 February 2024

    • Satellite storage template patch updates are available.

  • 12 February 2024

    • You can now enable automatic patch updates for your Satellite storage assignments and configurations.

  • 08 February 2024

    • CLI version 1.0.595 is available.

  • 02 February 2024

    • Storage template revisions are available.

• January 2024

  • 23 January 2024

    • New! Connector agent for Windows.

  • 19 January 2024

    • CLI version 1.0.589 is available.

  • 12 January 2024

    • Connector agent image version 1.1.3.

• December 2023

  • 01 December 2023

    • Template for VMware location setup

• November 2023

  • 27 November 2023

    • Storage template revisions are available.

  • 14 November 2023

    • Troubleshooting documentation for attaching hosts.

  • 01 November 2023

    • Storage template revisions are available.

• October 2023

  • 27 October 2023

    • Connector agent image version 1.1.2.

  • 25 October 2023

    • Troubleshooting documentation for Connector agents.

  • 20 October 2023

    • Satellite storage template for local storage

    • Debugging guide for OpenShift Data Foundation

    • Storage template revisions are available.

  • 10 October 2023

    • Connector agent image version 1.1.1.

    • CLI version 1.0.573 is available.

• September 2023

  • 22 September 2023

    • You can now create Satellite locations in the Madrid (mad, eu-es) region.

    • Storage template revisions

  • 18 September 2023

    • CLI version 1.0.566 is available.

• July 2023

  • 24 July 2023

    • Storage template revisions

  • 5 July 2023

    • Satellite Connector

    • Setting up Connector as a Secure Gateway replacement

    • Understanding your responsibilities with Satellite Connector

• June 2023

  • 26 June 2023

    • CLI change log

  • 22 June 2023

    • Storage template revisions

  • 12 June 2023

    • RHCOS enabled locations with reduced firewall

• May 2023

  • 17 May 2023

    • Storage template revisions

  • 04 May 2023

    • Storage template revisions

• April 2023

  • 25 April 2023

    • Storage template revisions

  • 05 April 2023

    • Storage template revisions

• March 2023

  • 27 March 2023

    • You can download a .csv copy of your outbound network requirements.

  • 24 March 2023

    • Changes to the host network requirements in non-RHCOS locations.

  • 20 March 2023

    • Terraform troubleshooting topic

  • 1 March 2023

    • CLI change log

• January 2023

  • 24 January 2023

    • CLI change log

• December 2022

  • 16 December 2022

    • New! IBM Cloud® Direct Link

  • 14 December 2022

    • New! Satellite storage debugging guide

    • New! GitOps configurations

    • CLI change log

  • 5 December 2022

    • New! Production support for the IBM Cloud Object Storage CSI driver template

  • 1 December 2022

    • New! Satellite storage template feature comparison

    • New! Virtualization on a Satellite location

• November 2022

  • 8 November 2022

    • Bare Metal Server support

  • 3 November 2022

    • Disconnected usage

• October 2022

  • 27 October 2022

    • New! Beta support for the IBM Cloud Object Storage CSI driver template

  • 26 October 2022

    • Create Satellite storage configurations from the console

  • 7 October 2022

    • Subscription identity sync

    • Apply updates your worker nodes in place

  • 3 October 2022

    • CLI change log

• September 2022

  • 23 September 2022

    • Added support for remote workers

  • 21 September 2022

    • CLI change log

  • 12 September 2022

    • CLI change log

  • 6 September 2022

    • New! Location overview information.

• August 2022

  • 31 August 2022

    • New! You can now create Red Hat CoreOS enabled Satellite locations in the Sao Paulo (sao, br-sao) region.

  • 23 August 2022

    • New! You can now create Red Hat CoreOS enabled Satellite locations in the Osaka (osa, jp-osa) region.

  • 18 August 2022

    • New! You can now create Red Hat CoreOS enabled Satellite locations in the Sydney (syd, au-syd) region.

  • 10 August 2022

    • Added information about verifying your permissions

  • 5 August 2022

    • CLI change log

  • 3 August 2022

    • RHEL 8 is now supported.

    • New! Check out the Satellite Config tutorial.

  • 2 August 2022

    • New! You can now create Red Hat CoreOS enabled Satellite locations in the Toronto (tor, ca-tor) region.

• July 2022

  • 22 July 2022

    • New! Beta support for the VMware CSI driver template

  • 15 July 2022

    • New information about using a custom Network Time Protocol (NTP) server

• June 2022

  • 21 June 2022

    • New and updated template parameter for the Azure File CSI driver template.

  • 16 June 2022

    • New! You can now create Red Hat CoreOS enabled Satellite locations in the Washington D.C. (wdc, us-east) region.

  • 15 June 2022

    • CLI change log

    • New! You can now create Red Hat CoreOS enabled Satellite locations in the London (lon, eu-gb) region.

  • 14 June 2022

    • Satellite for resellers

  • 9 June 2022

    • Satellite use cases

  • 1 June 2022

    • Getting started page redesign

    • New! Think you know Satellite? Take a quiz!

• May 2022

  • 26 May 2022

    • CLI change log

  • 16 May 2022

    • New! You can now create Red Hat CoreOS enabled Satellite locations in the Tokyo (tok, jp-tok) region.

  • 13 May 2022

    • New! Added IBM® Event Streams for IBM Cloud® as a Satellite-enabled service

    • New location error message is added.

  • 12 May 2022

    • New! Satellite configuration and assignment update commands

• April 2022

  • 28 April 2022

    • CLI change log

  • 26 April 2022

    • CLI change log

  • 20 April 2022

    • New! Osaka location

  • 18 April 2022

    • Set up an HTTP proxy for your hosts

    • New and updated template parameters for the local block and local file storage templates.

  • 12 April 2022

    • New! Support for Red Hat CoreOS

  • 6 April 2022

    • New! Check your host setup before attaching hosts to your location.

  • 4 April 2022

    • IBM Spectrum Scale template

• March 2022

  • 21 March 2022

    • CLI change log

  • 10 March 2022

    • New! Beta support for the Block Storage for VPC CSI driver template

  • 3 March 2022

    • Beta support for the Google Compute Engine CSI driver template

• February 2022

  • 28 February 2022

    • Host outbound connectivity

  • 24 February 2022

    • CLI change log

    • IBM Key Protect for IBM Cloud

    • Troubleshooting issue for errors when you run the oc debug command

  • 18 February 2022

    • CLI change log

  • 16 February 2022

    • Host connectivity

  • 10 February 2022

    • New! Beta support for the Azure File CSI driver template

• January 2022

  • Review the release notes for January 2022.

  • 27 January 2022

    • IBM Cloud Object Storage

  • 25 January 2022

    • OpenShift Data Foundation

  • 18 January 2022

    • New! IBM Cloud Satellite CLI Map

    • New! Site map

• December 2021

  • Review the release notes for December 2021.

  • 15 December 2021

    • New! Sydney location

  • 3 December 2021

    • CLI change log

• November 2021

  • Review the release notes for November 2021.

  • 29 November 2021

    • Red Hat OpenShift Data Foundation

    • Activity Tracker

  • 16 November 2021

    • New! Sao Paulo location

  • 11 November 2021

    • New location error message is added.

  • 10 November 2021

    • Troubleshooting a certificate expired error for the Red Hat OpenShift console

  • 9 November 2021

    • Azure Disk CSI driver template

  • 8 November 2021

    • Troubleshooting a degraded Ingress operator

• October 2021

  • Review the release notes for October 2021.

  • 12 October 2021

    • Review the release notes for 12 October 2021.

    • CLI change log

• September 2021

  • Review the release notes for September 2021.

  • 29 September 2021

    • Review the release notes for 29 September 2021.

    • New! Alibaba host support

    • New! Toronto location

  • 23 September 2021

    • Review the release notes for 23 September 2021.

    • New! Tokyo location

  • 15 September 2021

    • Review the release notes for 15 September 2021.

    • OpenShift Data Foundation

• August 2021

  • Review the release notes for August 2021.

  • 9 August 2021

    • Review the release notes for 9 August 2021.

    • CLI change log

  • 3 August 2021

    • Review the release notes for 3 August 2021.

    • New! Dallas location

• July 2021

  • Review the release notes for July 2021.

  • 19 July 2021

    • Review the release notes for 19 July 2021.

    • End of UDP endpoint support

  • 16 July 2021

    • Review the release notes for 16 July 2021.

    • New! Beta support for the Azure Disk CSI driver template

  • 8 July 2021

    • Review the release notes for 8 July 2021.

    • DNS provider change from Cloudflare to Akamai

• June 2021

  • Review the release notes for June 2021.

  • 30 June 2021

    • Review the release notes for 30 June 2021.

    • New! General availability of the Satellite storage templates.

    • New! Satellite-enabled IBM Cloud services: Many IBM Cloud Databases are now available to deploy to your Satellite location.

  • 24 June 2021

    • Review the release notes for 24 June 2021.

    • Azure template

    • CLI change log

  • 18 June 2021

    • Review the release notes for 18 June 2021.

    • IP addresses for Link tunnel server endpoints

  • 9 June 2021

    • Review the release notes for 9 June 2021.

    • New! Frankfurt location

    • Digital certificates

• May 2021

  • Review the release notes for May 2021.

  • 26 May 2021

    • Review the release notes for 26 May 2021.

    • CLI change log

  • 19 May 2021

    • Review the release notes for 19 May 2021.

    • New! NetApp ONTAP-NAS storage driver template

  • 12 May 2021

    • Review the release notes for 12 May 2021.

    • New! IBM Systems block storage CSI driver template

  • 7 May 2021

    • Review the release notes for 7 May 2021.

    • New! Spectrum Scale CSI driver template

• April 2021

  • Review the release notes for April 2021.

  • 26 April 2021

    • Review the release notes for 26 April 2021.

    • CLI change log

  • 15 April 2021

    • Review the release notes for 15 April 2021.

    • Cluster add-ons

    • Use case

    • When you create a location from the console, you can now enter the name of an existing IBM Cloud Object Storage bucket that you want to use to back up Satellite location control plane data.

  • 9 April 2021

    • Review the release notes for 9 April 2021.

    • Logging

    • New! Storage template for remote OpenShift Data Foundation

• March 2021

  • Review the release notes for March 2021.

  • 25 March 2021

    • Review the release notes for 25 March 2021.

    • Security and compliance

  • 23 March 2021

    • Review the release notes for 23 March 2021.

    • OpenShift Data Foundation using local disks

  • 12 March 2021

    • Review the release notes for 12 March 2021.

    • Resetting the host key

    • Troubleshooting location health checks

  • 10 March 2021

    • Review the release notes for 10 March 2021.

    • New health-pending host state

  • 1 March 2021

    • Review the release notes for 1 March 2021.

    • New! General availability of IBM Cloud Satellite®

    • CLI change log

    • Cloud provider guides

    • Exposing apps in Satellite clusters

    • Satellite Infrastructure Service

    • New! Template for fast provisioning on AWS

• February 2021

  • Review the release notes for February 2021.

  • 25 February 2021

    • Review the release notes for 25 February 2021.

    • Auditing events

    • CLI change log

  • 23 February 2021

    • Review the release notes for 23 February 2021.

    • Accessing clusters

    • Host requirements

    • Link endpoints

    • Monitoring

    • Reviewing resources

  • 18 February 2021

    • Review the release notes for 18 February 2021.

    • Securing service connections

  • 12 February 2021

    • Review the release notes for 12 February 2021.

    • Link endpoints

    • Securing service connections

  • 8 February 2021

    • Review the release notes for 8 February 2021.

    • CLI change log

    • Host auto assignment

    • Logging and monitoring

    • Worker pool management

• January 2021

  • Review the release notes for January 2021.

  • 29 January 2021

    • Review the release notes for 29 January 2021.

    • AWS hosts

    • Satellite Link

  • 25 January 2021

    • Review the release notes for 25 January 2021.

    • Satellite Link

  • 15 January 2021

    • Review the release notes for 15 January 2021.

    • Host requirements

  • 12 January 2021

    • Review the release notes for 12 January 2021.

    • Host updates

• December 2020

  • Review the release notes for December 2020.

  • 9 December 2020

    • Review the release notes for 9 December 2020.

    • Private hosts

    • Azure host support

    • Physical machine support

    • Host network requirements

    • AWS and GCP host DNS

• November 2020

  • Review the release notes for November 2020.

  • 18 November 2020

    • Review the release notes for 18 November 2020.

    • Internal registry

    • Service overview

• October 2020

  • Review the release notes for October 2020.

  • 8 October 2020

    • Review the release notes for 8 October 2020.

    • Host network requirements

  • 6 October 2020

    • Review the release notes for 6 October 2020.

    • CLI change log

    • Location subdomain troubleshooting

• September 2020

  • Review the release notes for September 2020.

  • 14 September 2020

    • Review the release notes for 14 September 2020.

    • Host requirements

    • IAM

    • Provider documentation

    • Service requirements

• August 2020

  • Review the release notes for August 2020.

  • 21 August 2020

    • Review the release notes for 21 August 2020.

    • New! IBM Cloud Satellite is now available as a closed beta.

Tutorial library for Satellite

Tutorial library for Satellite

Deploying apps to clusters with Continuous Delivery and Satellite Config

Deploying apps to clusters with Continuous Delivery and Satellite Config

• Objectives

• Audience

• Prerequisites

• Getting started

• Defining toolchain settings

• Defining your source repository

• Setting up your delivery pipeline

• Providing an API key

• Setting up Satellite Config

• Reviewing the summary

• Testing the toolchain

• Verifying that the sample app is running

• Deploying a new version of your app from a different branch

Deploying apps to clusters with Satellite Config

Deploying apps to clusters with Satellite Config

• Objectives

• Audience

• Prerequisites

• Beginner tutorial: Deploying a hello world app

• Advanced tutorial: Deploying an app and updating it with new versions

Connecting Locations with IBM Cloud using Direct Link

Connecting Locations with IBM Cloud using Direct Link

• FAQ

• Target use case

• Overview

• Objectives

• Prerequisites

• Creating a Red Hat CoreOS enabled Satellite Location

• Creating a relay

• Provisioning Red Hat CoreOS hosts

Using IBM Cloud Kubernetes Service on classic to host the dl-reverse-proxy

Using IBM Cloud Kubernetes Service on classic to host the dl-reverse-proxy

• Create an IBM Cloud Kubernetes Service cluster

• Set up private Ingress ALBs in the cluster

• Deploy an NGINX reverse proxy

• Configure Link to use the reverse proxy

Deploying OpenShift Data Foundation on Satellite clusters with Azure worker nodes

Deploying OpenShift Data Foundation on Satellite clusters with Azure worker nodes

• Objectives

• Audience

• Deploy the Azure location template

• Create a Satellite cluster that uses your Azure hosts

• Deploy the Azure Disk CSI driver

• Deploy OpenShift Data Foundation

• Verify your deployment

• Next Steps

Attaching bare metal hosts to a location

Attaching bare metal hosts to a location

• Prerequisites

• Bare Metal Server requirements

• Booting up your Bare Metal Server

• Setting up public networking

• Configuring your ignition file

• Attaching your bare metal host to the location

• Assigning a Bare Metal Server host to your Red Hat OpenShift cluster

Setting up virtualization on a Satellite location

Setting up virtualization on a Satellite location

• Prerequisites

• Bare Metal Server requirements for Satellite

• Attaching bare metal servers to your location

• Assigning a Bare Metal Server host to your Red Hat OpenShift cluster

• Setting up storage for your cluster

• Installing the virtualization operator

• Setting up the virtctl CLI

• Creating a data volume for your virtual machine

• Creating a virtual machine

• Additional resources

Installing the CLI

Installing the CLI

• Understanding the CLI tools

• Run the installation command

• Verify the installation

• Install CLI plug-ins and tools

Updating the CLI

• Updating the IBM Cloud CLI

• Updating installed plug-ins

Uninstalling the stand-alone IBM Cloud CLI

• Uninstalling on Windows

• Uninstalling on Linux and macOS

Planning your environment for Satellite locations

Planning your environment for Satellite locations

• Planning your infrastructure

  • Plan your infrastructure provider

  • Plan for a multizone location

  • Plan your host systems

• Planning your operating system

  • Deciding whether to enable Red Hat CoreOS support for your location

• Infrastructure credentials

  • AWS credentials

  • Azure credentials

  • GCP credentials

  • VMWare credentials

Setting up the API

Setting up the API

• About the API

• Working with API keys

  • Required access for managing API keys

• Generating an IAM token

• Passing an IBM Cloud IAM token to authenticate with a service's API

• Passing an IBM Cloud API key to authenticate with a service API

Preparing your host infrastructure

Host system requirements

• Computing characteristics

• Red Hat CoreOS (RHCOS) packages and other machine configurations

• Red Hat Enterprise Linux (RHEL) packages and other machine configurations

Host storage and attached devices

Host network requirements

• Networking configurations

• Host network bandwidth

• Network gateways and interfaces

• Inbound connectivity requirements for Satellite hosts

• Outbound connectivity requirements for Satellite Connector

Required outbound connectivity for hosts overview

Creating locations

Create a Satellite location overview

• Host operating system

• Options for creating your Satellite location

• Is my location enabled for Red Hat CoreOS?

Setting up a Satellite location with remote workers

• Infrastructure composition options and supported topologies

  • Example 1: Compute hosts are located in a single edge or data center

  • Example 2: Compute hosts are located in IBM Cloud and edge or data centers

  • Example 3: Compute hosts are located in IBM Cloud and multiple data centers or edge

  • Example 4: Compute hosts are located in multiple edge or data centers

  • Example 5: Compute hosts, including Satellite control plane, are located in multiple edge or data centers

• Use case: Edge clusters with centralized management in IBM Cloud

Attaching hosts to a location

Downloading the host attachment script for your location

• Download the host attachment script from the console

• Download the host attachment script from the CLI

Attaching on-prem hosts to your location

• Attaching on-premises RHEL hosts to your location

• Attaching on-premises Red Hat CoreOS hosts to your location

• I added hosts to my location, what's next?

Attaching AWS hosts to Satellite

• Adding AWS hosts to Satellite

• Manually attaching AWS instances with the CLI

• AWS instance types

• Security group settings for AWS

• I added hosts to my location, what's next?

Attaching Google Cloud Platform (GCP) hosts

• Manually adding hosts to Satellite in the GCP console

• Manually ordering hosts with the gcloud CLI

• Network firewall settings

• I added hosts to my location, what's next?

Attaching Microsoft Azure hosts

• Adding Azure hosts to Satellite

• Security group settings for Azure

• I added hosts to my location, what's next?

Attaching IBM Cloud hosts for tests

• Manually adding IBM Cloud RHEL hosts to Satellite

• Manually adding IBM Cloud RHCOS hosts to Satellite

• I added hosts to my location, what's next?

Attaching IBM Storage Fusion HCI hosts

• I added hosts to my location, what's next?

Attaching Bare metal hosts

• Bare Metal Server requirements

• Attaching bare metal servers to your location

• I added hosts to my location, what's next?

Attaching Alibaba Cloud hosts

• Security group settings

• I added hosts to my location, what's next?

Managing hosts and locations

Creating connectors

Creating a Connector

• Prerequisites

• Creating a Connector in the console

• Prerequisites for creating a Connector

• Creating a Connector in the CLI

• Next steps

Running a Connector agent

• Prerequisites

• Reviewing the agent parameters

• Running the agent on your container platform

  • Step 1: Creating the local configuration files

  • Step 2: Pulling the agent image

  • Step 3: Running the agent image

• Running the agent on Windows

  • Prerequisites and notes

  • Step 1: Downloading the Connector agent files from the CLI

  • Step 2: Updating the config.json file

  • Step 3: Starting the agent

• Updating the agent on Windows

• Next steps

Running your Connector agent as a service in Docker Swarm Mode for high availability

Satellite Connector end-to-end example

• Creating a Docker container

• Creating your Link endpoint

• Adding TLS support

Configuring a proxy for your Satellite Connector

Creating and managing Connector endpoints

• Creating endpoints from the console

• Creating an access control list rule for your endpoint

Managing apps with Satellite Config

Understanding Satellite Config

• Understanding GitOps-based configurations

• Understanding Direct Upload configurations

• Key concepts for Satellite Config

Connecting Satellite locations with external services by using Link endpoints

Understanding Link endpoints and Satellite

• Architecture

  • Cloud endpoint

  • Location endpoint

• External network requirements and security

  • Do I need to allow any unique inbound traffic from internet-facing ports through firewalls to my location?

  • If IBM owns the Link tunnel, how can I validate that our data is inaccessible? My organization's security policy does not allow tunnels from our networks.

  • How do I make my data secure in transit?

• Encryption protocols

  • TCP and TLS

  • HTTP and HTTPS

  • HTTP tunnel

  • Server-side certificate authentication for TLS and HTTPS

• Access and audit controls

  • Restricting access with source lists

  • Auditing user-initiated events

• Use cases

  • Can I use Link endpoints to

  • Example: Connect from a Satellite location to a service in another cloud provider

  • Example: Enable and audit limited access to a Satellite location from IBM Cloud

Default Link endpoints for IBM Cloud access to your Satellite location

• Default link endpoints for CoreOS enabled locations

• Default link endpoints for locations without CoreOS enabled

Creating and managing link endpoints

• Creating cloud endpoints to connect to resources outside of the location

  • Creating cloud endpoints by using the console

  • Creating cloud endpoints with the CLI

• Testing connections through cloud endpoints

  • Example for testing the connection from an unassigned host

  • Example for testing the connection from a Satellite cluster

• Creating location endpoints to connect to resources in a location

  • Creating location endpoints by using the console

  • Creating location endpoints by using the CLI

  • Setting up source lists to limit access to endpoints

• Enabling and disabling endpoints

Accessing your Red Hat OpenShift API Satellite link endpoints

Auditing, logging, and monitoring Satellite Link endpoints

• Auditing events for endpoint actions

• Logging and monitoring network traffic for endpoints

  • Setting up Monitoring for Satellite Link metrics

  • Running a packet capture of endpoint traffic

Logging and monitoring

Logging for Satellite

• Setting up Log Analysis for Satellite location platform logs

  • Enabling platform logs

  • Viewing logs for your Satellite location

  • Analyzing logs for your Satellite location

  • R00XX error logs

  • Enablement of resource deployment logs

  • Endpoint health status logs

• Setting up Activity Tracker for Satellite location events

• Setting up logging for clusters

  • Enabling a logging instance in your cluster

Monitoring for Satellite

• Understanding what is logged and monitored by default

  • Auditing events for Satellite actions

  • IBM monitoring to resolve and report location alerts

• Viewing location, host, and cluster health

  • Viewing location health

  • Viewing host health

  • Viewing cluster health

  • Viewing Kubernetes resources in clusters

  • Viewing Satellite Config registration status for clusters

• Setting up Monitoring for Satellite location platform metrics

  • Available metrics

  • Attributes for segmentation

• Setting up monitoring for clusters

Auditing events for Satellite

• Events for Satellite clusters

• Events for the Satellite Link component

• Events for the Satellite Config component

• Events for Satellite storage

• Events for Satellite assignments

• Viewing events for Satellite

Setting up storage

Understanding Satellite storage

• What are Satellite storage templates?

• What are my options for deploying storage to Satellite?

• Which deployment option should I use?

• What are the benefits of using templates?

• How do templates work?

• How do I manage updates?

• Which storage templates are available?

Storage template feature overview

Setting up Terraform for Satellite

Setting up Terraform for Satellite

• Installing Terraform and configuring resources for Satellite

• Creating a Satellite location by using Terraform

• What's next?

Setting up Satellite as a Secure Gateway for on-prem solutions

Setting up Satellite as a Secure Gateway for on-prem solutions

• Satellite as a Layer 4 connection solution

• Setting up a secure connection to IBM Cloud with Satellite

  • Step 1: Deploy Satellite to your on-premises environment

  • Step 2: Set up secure communication channels by using Satellite Link

Enhancing security

API reference

API reference

CLI plug-in reference

IBM Cloud Satellite CLI map

• cluster commands

• config commands

• endpoint commands

• group commands

• host commands

• key commands

• location commands

• messages commands

• resource commands

• service commands

• storage commands

• subscription commands

CLI reference for Satellite commands

• ibmcloud sat commands

• ibmcloud sat cluster get

  • Command options

• ibmcloud sat cluster ls

  • Command options

• ibmcloud sat cluster register

  • Command options

• ibmcloud sat cluster unregister

  • Command options

• ibmcloud sat config create

  • Command options

• ibmcloud sat config get

  • Command options

• ibmcloud sat config ls

  • Command options

• ibmcloud sat config rename

  • Command options

• ibmcloud sat config rm

  • Command options

• ibmcloud sat config version create

  • Command options

• ibmcloud sat config version get

  • Command options

• ibmcloud sat config version rm

  • Command options

• ibmcloud sat endpoint create

  • Command options

• ibmcloud sat endpoint get

  • Command options

• ibmcloud sat endpoint ls

  • Command options

• ibmcloud sat endpoint rm

  • Command options

• ibmcloud sat endpoint update

  • Command options

• ibmcloud sat group attach

  • Command options

• ibmcloud sat group create

  • Command options

• ibmcloud sat group detach

  • Command options

• ibmcloud sat group get

  • Command options

• ibmcloud sat group ls

  • Command options

• ibmcloud sat group rm

  • Command options

• ibmcloud sat host assign

  • Command options

• ibmcloud sat host attach

  • Command options

• ibmcloud sat host get

  • Command options

• ibmcloud sat host ls

  • Command options

• ibmcloud sat host rm

  • Command options

• ibmcloud sat host update

  • Command options

• ibmcloud sat key ls

  • Command options

• ibmcloud sat key rm

  • Command options

• ibmcloud sat key rotate

  • Command options

• ibmcloud sat location create

  • Command options

• ibmcloud sat location dns get

  • Command options

• ibmcloud sat location dns ls

  • Command options

• ibmcloud sat location dns register

  • Command options

• ibmcloud sat location get

  • Command options

• ibmcloud sat location ls

  • Command options

• ibmcloud sat location rm

  • Command options

• ibmcloud sat messages

  • Command options

• ibmcloud sat resource get

  • Command options

• ibmcloud sat resource history get

  • Command options

• ibmcloud sat resource ls

  • Command options

• ibmcloud sat service ls

  • Command options

• ibmcloud sat storage assignment autopatch disable

  • Command options

• ibmcloud sat storage assignment autopatch enable

  • Command options

• ibmcloud sat storage assignment create

  • Command options

• ibmcloud sat storage assignment get

  • Command options

• ibmcloud sat storage assignment ls

  • Command options

• ibmcloud sat storage assignment patch

  • Command options

• ibmcloud sat storage assignment rm

  • Command options

• ibmcloud sat storage assignment update

  • Command options

• ibmcloud sat storage config class add

  • Command options

• ibmcloud sat storage config class get

  • Command options

• ibmcloud sat storage config class ls

  • Command options

• ibmcloud sat storage config create

  • Command options

• ibmcloud sat storage config get

  • Command options

• ibmcloud sat storage config ls

  • Command options

• ibmcloud sat storage config param set

  • Command options

• ibmcloud sat storage config patch

  • Command options

• ibmcloud sat storage config rm

  • Command options

• ibmcloud sat storage template get

  • Command options

• ibmcloud sat storage template ls

  • Command options

• ibmcloud sat subscription create

  • Command options

• ibmcloud sat subscription get

  • Command options

• ibmcloud sat subscription identity set

  • Command options

• ibmcloud sat subscription ls

  • Command options

• ibmcloud sat subscription rm

  • Command options

• ibmcloud sat subscription update

  • Command options

CLI change log

• Version 1.0

• Version v1.0.613

• Version v1.0.601

• Version v1.0.597

• Version v1.0.595

• Version v1.0.589

• Version v1.0.579

• Version 0.1.573

• Version v1.0.566

• Version v1.0.540

• Version v1.0.528

• Version v1.0.523

• Version v1.0.516

• Version v1.0.510

• Version v1.0.498

• Version 1.0.489

• Version 1.0.487

• Version 1.0.480

• Version 1.0.471

• Version 1.0.459

• Version 1.0.454

• Version 1.0.452

• Version 1.0.446

• Version 1.0.444

• Version 1.0.439

• Version 1.0.433

• Version 1.0.431

• Version 1.0.430

• Version 1.0.426

• Version 1.0.422

• Version 1.0.420

• Version 1.0.419

• Version 1.0.415

• Version 1.0.408

• Version 1.0.404

• Version 1.0.403

• Version 1.0.394

• Version 1.0.384

• Version 1.0.374

• Version 1.0.372

• Version 1.0.353

• Version 1.0.347

• Version 1.0.344

• Version 1.0.334

• Version 1.0.331

• Version 1.0.327

• Version 1.0.312

• Version 1.0.300

• Version 1.0.295

• Version 1.0.275

• Version 1.0.258

• Version 1.0.233

• Version 1.0.231

• Version 1.0.223

• Version 1.0.208

• Version 1.0.206

• Version 1.0.197

• Version 1.0.178

• Version 1.0.171

• Version 1.0.157

• Version 1.0.143

• Version 1.0.118

• Version 1.0.99

• Version 1.0.94

• Version 1.0.84

• Version 1.0.57

• Version 1.0.28

• Version 1.0.15

• Version 1.0.0

• Deprecated versions

  • Updating to version 1.0 of the plug-in

  • Version 0.4

  • Version 0.3

  • Version 0.2

  • Version 0.1

Limitations, default settings, and usage requirements

Limitations, default settings, and usage requirements

• Locations

• Hosts

• Clusters

• Link and endpoints

• Connector

• Config

• IBM Cloud services

Regions

Regions

• IBM Cloud regions for Satellite FAQs

  • Why is my location managed by an IBM Cloud region?

  • What IBM Cloud multizone metro do I choose for my Satellite location?

  • Can my hosts reside anywhere?

  • How can I deploy in an EU Cloud Certified Location?

  • What about latency requirements?

Pricing

Pricing

• Satellite locations

• Satellite-enabled IBM Cloud services

• Can I estimate my costs?

• Can I view and control my current usage?

Your responsibilities

Your responsibilities

• Overview of shared responsibilities

• Tasks for shared responsibilities by area

  • Incident and operations management

  • Change management

  • Identity and access management

  • Security and regulation compliance

  • Disaster recovery

High availability and recovery

High availability and recovery

• Understanding high availability in IBM Cloud Satellite

  • High availability of the Satellite location control plane

  • High availability of the Satellite control plane nodes

  • High availability of IBM Cloud services

• Basic control plane worker setup

• Highly available control plane worker setup

  • Example high availability setup in an on-premises data center

  • Example high availability setup in a public cloud provider

Disconnected use for Satellite components

Disconnected use for Satellite components

• Understanding disconnected usage

• Setting the disconnected usage time

• Disconnected usage by component

  • Cluster management

  • Apps

  • IBM Cloud Catalog

  • Identity and access management

  • Secret management

  • Logging and monitoring

  • Config management

  • Networking

IBM Cloud Satellite notices

IBM Cloud Satellite notices

• Creative Commons Attribution Share Alike 4.0 Generic

Version history

Connector agent image change log

• Version 1.1

  • Version 1.1.4, released 19 Feb 2024

  • Version 1.1.3, released 11 Jan 2024

  • Version 1.1.2, released 27 Oct 2023

  • Version 1.1.1, released 10 Oct 2023

  • Version 1.1.0, released 20 June 2023

Connector Windows agent change log

• Version 1.1

  • Version 1.1.1, released 19 Feb 2024

  • Version 1.1.0, released 30 Jan 2024

FAQs

FAQs

• What is IBM Cloud Satellite and how does it work?

• Where is Satellite available?

• Is my location setup highly available?

• What happens if my Satellite control plane becomes unavailable?

• Does IBM support third-party and open source tools that I use with Satellite?

• Why can't I install extra software like vulnerability scanning tools on my host?

• What am I charged for when I use IBM Cloud Satellite?

• Can I estimate my costs?

• Can I view and control my current usage?

• What are the terms of the service level agreement?

• What compliance standards does the service meet?

• What IBM Cloud services can I use with Satellite?

• What managed add-ons can I use with Red Hat OpenShift clusters in my Satellite location?

• Does IBM have an infrastructure on-premises compute storage option if I don't already have my own?

Getting help

Getting help

• General ways to resolve issues

• Reviewing cloud issues and status

• Identifying issues for Satellite-enabled IBM Cloud service

• Reviewing logs

• Feedback and questions

• Contacting support

• Opting in to receive email notifications

Troubleshooting

Viewing cloud status

• Viewing the status of a dedicated multizone region (MZR)

• Subscribing to an RSS feed

• Checking incident reports

Location error messages

• Reviewing error messages and logs

• R0001: Ready location

• R0002, R0018, R0020, R0029, R0037, R0039, R0042: Wait for location to be ready

• R0009: Unable to recover

• R0010, R0030, R0031, R0032: Control plane needs hosts

• R0011, R0040, R0041: Issues with the control plane hosts

• R0012: Hosts are needed in all 3 zones

• R0013: Unavailable zone

• R0014: DNS record for control plane

• R0015, R0016: Host issues

• R0023, R0101: Wait for location to be ready

• R0024, R0025: Cluster issues

• R0026: Host disk space

• R0033, R0034, R0035: Control plane capacity issues

• R0036: Location subdomain traffic routing

• R0038, R0101: Location has cluster operations in progress

• R0043: Layer 3 connectivity

• R0044: DNS issues

• R0045: Host read-only file system issues

• R0046: NTP issues

• R0047: Location health checking

• R0048: etcd backup failure

• R0049: Satellite Link IAM API key issue

• R0050, R0051: Satellite Link connector issues

• R0052: Ingress certificate generation issues

• R0056: Pod status stuck in terminating

• R0057: Outbound traffic to IAM is failing

• R0058: DNS registration is failing

• R0059: Outbound traffic to IBM Cloud Container Registry is failing.

• R0060: Outbound traffic to LaunchDarkly is failing.

• R0061: A Satellite cluster API server is unreachable from IBM Cloud.

Recovering your location

Checking cluster health after recovery

• Checking cluster health

  • Step 1: Check worker node health

  • Step 2: Check Calico components

  • Step 3: Check the openshift-kube-proxy

  • Step 4: Check the OpenShift DNS

  • Step 5: Check the Ingress status

• Running the cluster debug script