Publishing 2019.1.1 release

Author: gabortpubs

Gemfile.lock

@@ -21,7 +21,7 @@ GEM
     colorator (1.1.0)
     commonmarker (0.17.13)
       ruby-enum (~> 0.5)
-    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.1.4)
     dnsruby (1.61.2)
       addressable (~> 2.5)
     em-websocket (0.5.1)
@@ -33,7 +33,7 @@ GEM
     execjs (2.7.0)
     faraday (0.15.2)
       multipart-post (>= 1.2, < 3)
-    ffi (1.9.25)
+    ffi (1.10.0)
     filesize (0.2.0)
     forwardable-extended (2.6.0)
     gemoji (3.0.0)
@@ -129,6 +129,8 @@ GEM
       commonmarker (~> 0.17.6)
       jekyll-commonmark (~> 1)
       rouge (~> 2)
+    jekyll-contentblocks (1.2.0)
+      jekyll
     jekyll-default-layout (0.1.4)
       jekyll (~> 3.0)
     jekyll-feed (0.10.0)
@@ -202,7 +204,7 @@ GEM
       jekyll-seo-tag (~> 2.0)
     jekyll-titles-from-headings (0.5.1)
       jekyll (~> 3.3)
-    jekyll-watch (2.0.0)
+    jekyll-watch (2.1.2)
       listen (~> 3.0)
     jemoji (0.10.1)
       gemoji (~> 3.0)
@@ -227,20 +229,20 @@ GEM
       mini_portile2 (~> 2.3.0)
     octokit (4.12.0)
       sawyer (~> 0.8.0, >= 0.5.3)
-    pathutil (0.16.1)
+    pathutil (0.16.2)
       forwardable-extended (~> 2.6)
     progressbar (1.10.0)
     public_suffix (2.0.5)
     rb-fsevent (0.10.3)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
     rouge (2.2.1)
     ruby-enum (0.7.2)
       i18n
     ruby_dep (1.5.0)
     rubyzip (1.2.2)
     safe_yaml (1.0.4)
-    sass (3.5.7)
+    sass (3.7.3)
       sass-listen (~> 4.0.0)
     sass-listen (4.0.0)
       rb-fsevent (~> 0.9, >= 0.9.4)
@@ -266,6 +268,7 @@ PLATFORMS
 DEPENDENCIES
   github-pages
   jekyll-algolia
+  jekyll-contentblocks
   jekyll-feed
   jekyll-gist
   jekyll-paginate

_2018.3.1/00-home.md

@@ -0,0 +1,78 @@
+---
+title: "Home"
+layout: splash
+permalink: /:collection/
+mastheadNavItem: Documentation
+collection: 2018.3.1
+quickLinks:
+  - link:
+    - title: Introduction
+    - url: about/overview/
+  - link:
+    - title: What's New?
+    - url: about/whats-new/
+  - link:
+    - title: Key Concepts
+    - url: about/key-concepts/
+gettingStarted:
+  - mainTitle: How to get going
+  - link:
+    - title: Installing IBM Event Streams
+    - url: installing/installing/
+    - icon: install.svg
+  - link:
+    - title: Migrating from Community Edition
+    - url: installing/migrating/
+    - icon: migrate.svg
+  - link:
+    - title: Getting started with Event Streams as a hosted service
+    - url: https://cloud.ibm.com/docs/services/EventStreams?topic=eventstreams-getting_started#getting_started
+    - icon: install.svg
+  - link:
+    - title: Upgrading
+    - url: installing/upgrading/
+    - icon: upgrade.svg
+  - link:
+    - title: Logging In
+    - url: getting-started/logging-in/
+    - icon: login.svg
+  - link:
+    - title: Generating a starter application
+    - url: getting-started/generating-starter-app/
+    - icon: generate.svg
+  - link:
+    - title: Testing message loads
+    - url: getting-started/testing-loads/
+    - icon: messageLoads.svg
+  - link:
+    - title: Creating client apps
+    - url: getting-started/client/
+    - icon: clientApps.svg
+commonTasks:
+  - mainTitle: Common Tasks
+  - link:
+    - title: Managing access
+    - url: security/managing-access/
+    - icon: lock.svg
+  - link:
+    - title: Monitoring deployment health
+    - url: administering/deployment-health/
+    - icon: monitorHealth.svg
+  - link:
+    - title: Scaling
+    - url: administering/scaling/
+    - icon: scaling.svg
+  - link:
+    - title: Setting quotas
+    - url: administering/quotas/
+    - icon: quota.svg
+  - link:
+    - title: Replicating across geographies
+    - url: georeplication/about/
+    - icon: geoRep.svg
+  - link:
+    - title: Connecting to IBM MQ
+    - url: connecting/mq/
+    - icon: mqFavicon-01.svg
+
+---

_docs/01-about/01-overview.md _2018.3.1/01-about/01-overview.md

@@ -1,12 +1,12 @@
 ---
 title: "Introduction"
-permalink: /about/overview/
 excerpt: "IBM Event Streams is an event-streaming platform based on the open-source Apache Kafka® project."
-
+categories: about
+slug: overview
 toc: false
 ---
 
-{{site.data.reuse.long_name}} is an event-streaming platform based on the open-source Apache Kafka® project.  {{site.data.reuse.short_name}} release 2018.3.0 uses the Kafka 2.0 release and supports the use of all Kafka interfaces. ![Event Streams 2018.3.1 and later icon](../../images/2018.3.1.svg "Only in Event Streams 2018.3.1 and later.") {{site.data.reuse.short_name}} 2018.3.1 and later uses the Kafka 2.0.1 release.
+{{site.data.reuse.long_name}} is an event-streaming platform based on the open-source Apache Kafka® project.  {{site.data.reuse.short_name}} release 2018.3.0 uses the Kafka 2.0 release and supports the use of all Kafka interfaces. ![Event Streams 2018.3.1](../../../images/2018.3.1.svg "In Event Streams 2018.3.1.") {{site.data.reuse.short_name}} release 2018.3.1 uses the Kafka 2.0.1 release.
 
 {{site.data.reuse.long_name}} builds upon the {{site.data.reuse.icp}} platform to deploy Apache Kafka in a resilient and manageable way. It includes a UI design aimed at application developers getting started with Apache Kafka, as well as users operating a production cluster.
 

_docs/01-about/01-whats-new.md _2018.3.1/01-about/01-whats-new.md

@@ -1,8 +1,8 @@
 ---
 title: "What's new"
-permalink: /about/whats-new/
 excerpt: "Find out what is new in IBM Event Streams."
-
+categories: about
+slug: whats-new
 toc: true
 ---
 
@@ -20,7 +20,7 @@ In addition to {{site.data.reuse.icp}} 3.1.0, {{site.data.reuse.short_name}} 201
 
 ### Kafka version upgraded to 2.0.1
 
-{{site.data.reuse.short_name}} 2018.3.1 and later uses the Kafka 2.0.1 release.
+{{site.data.reuse.short_name}} 2018.3.1 uses the Kafka 2.0.1 release.
 
 ### Kafka Connect sink connector for IBM MQ
 
@@ -46,8 +46,8 @@ See the updated tables for the {{site.data.reuse.short_name}} [resource requirem
 
 Any difference in features or behaviour between {{site.data.reuse.short_name}} releases is highlighted in the documentation using the following graphics:
 
-- ![Event Streams 2018.3.1 and later icon](../../images/2018.3.1.svg "Only in Event Streams 2018.3.1 and later.") Applicable to {{site.data.reuse.long_name}} 2018.3.1 and later.
-- ![Event Streams 2018.3.0 only icon](../../images/2018.3.0.svg "Only in Event Streams 2018.3.0.") Applicable to {{site.data.reuse.long_name}} 2018.3.0 only.
+- ![Event Streams 2018.3.1 icon](../../../images/2018.3.1.svg "In Event Streams 2018.3.1.") Applicable to {{site.data.reuse.long_name}} 2018.3.1.
+- ![Event Streams 2018.3.0 icon](../../../images/2018.3.0.svg "In Event Streams 2018.3.0.") Applicable to {{site.data.reuse.long_name}} 2018.3.0.
 
 ## 2018.3.0 release
 

_2018.3.1/01-about/02-key-concepts.md

@@ -0,0 +1,49 @@
+---
+title: "Key concepts"
+excerpt: "Read about the key concepts of the Apache Kafka technology."
+categories: about
+slug: key-concepts
+toc: true
+---
+
+Apache Kafka® forms the reliable messaging core of {{site.data.reuse.long_name}}. It is a publish-subscribe messaging system designed to be fault-tolerant, providing a high-throughput and low-latency platform for handling real-time data feeds.
+
+![Kafka architecture diagram.](../../../images/kafka_overview.png "Diagram that shows a Kafka architecture. A producer is feeding into a Kafka topic over 3 partitions and the messages are then being subscribed to by consumers.")
+
+The following are some key Kafka concepts.
+
+## Cluster
+Kafka runs as a cluster of one or more servers. The load is balanced across the cluster by distributing it amongst the servers.
+
+## Topic
+A stream of messages is stored in categories called topics.
+
+## Partition
+Each topic comprises one or more partitions. Each partition is an ordered list of messages. The messages on a partition are each given a monotonically increasing number called the offset.
+
+If a topic has more than one partition, it allows data to be fed through in parallel to increase throughput by distributing the partitions across the cluster. The number of partitions also influences the balancing of workload among consumers.
+
+## Message
+The unit of data in Kafka. Each message is represented as a record, which comprises two parts: key and value. The key is commonly used for data about the message and the value is the body of the message. Kafka uses the terms record and message interchangeably.
+
+Many other messaging systems also have a way of carrying other information along with the messages. Kafka 0.11 introduced record headers for this purpose.
+
+Because many tools in the Kafka ecosystem (such as connectors to other systems) use only the value and ignore the key, it’s best to put all of the message data in the value and just use the key for partitioning or log compaction. You should not rely on everything that reads from Kafka to make use of the key.
+
+## Producer
+A process that publishes streams of messages to Kafka topics. A producer can publish to one or more topics and can optionally choose the partition that stores the data.
+
+## Consumer
+A process that consumes messages from Kafka topics and processes the feed of messages. A consumer can consume from one or more topics or partitions.
+
+## Consumer group
+A named group of one or more consumers that together consume the messages from a set of topics. Each consumer in the group reads messages from specific partitions that it is assigned to. Each partition is assigned to one consumer in the group only.
+
+* If there are more partitions than consumers in a group, some consumers have multiple partitions.
+* If there are more consumers than partitions, some consumers have no partitions.
+
+To learn more, see the following information:
+* [Producing messages](../producing-messages)
+* [Consuming messages](../consuming-messages)
+* [Partition leadership](../partition-leadership/)
+* [Apache Kafka documentation](http://kafka.apache.org/documentation.html)

_docs/01-about/03-producing-messages.md _2018.3.1/01-about/03-producing-messages.md

@@ -1,9 +1,9 @@
 ---
 title: "Producing messages"
-permalink: /about/producing-messages/
 excerpt: "A producer is an application that publishes streams of messages to Kafka
 topics."
- 
+categories: about
+slug: producing-messages
 toc: true
 ---
 

_docs/01-about/04-consuming-messages.md _2018.3.1/01-about/04-consuming-messages.md

@@ -1,9 +1,9 @@
 ---
 title: "Consuming messages"
-permalink: /about/consuming-messages/
 excerpt: "A consumer is an application that consumes streams of messages from
 Kafka topics."
- 
+categories: about
+slug: consuming-messages
 toc: true
 ---
 

_docs/01-about/05-partition-leadership.md _2018.3.1/01-about/05-partition-leadership.md

@@ -1,9 +1,9 @@
 ---
 title: "Partition leadership"
-permalink: /about/partition-leadership/
 excerpt: "Each partition has one server in the cluster that acts as the
 partition's leader and other servers that act as the followers."
- 
+categories: about
+slug: partition-leadership
 toc: false
 ---
 

_docs/01-about/06-accessibility.md _2018.3.1/01-about/06-accessibility.md

@@ -1,8 +1,8 @@
 ---
 title: "Accessibility"
-permalink: /about/accessibility/
 excerpt: "Accessibility features for IBM Event Streams."
- 
+categories: about
+slug: accessibility
 toc: true
 ---
 Accessibility features assist users who have a disability, such as restricted mobility or limited vision, to use information technology content successfully.

_docs/01-about/07-notices.md _2018.3.1/01-about/07-notices.md

@@ -1,8 +1,8 @@
 ---
 title: "Notices"
-permalink: /about/notices/
 excerpt: "Legal notices for IBM Event Streams."
- 
+categories: about
+slug: notices
 toc: true
 ---
 

_docs/02-installing/00-trying-out.md _2018.3.1/02-installing/00-trying-out.md

@@ -1,7 +1,8 @@
 ---
 title: "Trying out Event Streams"
-permalink: /installing/trying-out/
 excerpt: "Install a basic deployment to try out IBM Event Streams."
+categories: installing
+slug: trying-out
 toc: false
 ---
 

_docs/02-installing/01-prereqs.md _2018.3.1/02-installing/01-prereqs.md

@@ -1,34 +1,33 @@
 ---
 title: "Pre-requisites"
-permalink: /installing/prerequisites/
 excerpt: "Pre-requisites for installing IBM Event Streams."
-
+categories: installing
+slug: prerequisites
 toc: true
 ---
 
 Ensure your environment meets the following prerequisites before installing {{site.data.reuse.long_name}}.
 
 ## {{site.data.reuse.icp}} environment
 
-{{site.data.reuse.short_name}} version | {{site.data.reuse.icp}} versions supported | Platforms supported
+{{site.data.reuse.short_name}} version | Container platform | Systems
 ----------------------|--------------------|-----------------------|-------------|--------------------
-![Event Streams 2019.1.1 and later icon](../../images/2019.1.1.svg "Event Streams 2019.1.1.") <br/>**Note:** {{site.data.reuse.long_name}} 2019.1.1 is planned to be released on 29 March 2019. | 3.1.2       |  - Linux® 64-bit (x86_64) systems <br/>- Linux on IBM® Z systems <br/>- Red Hat OpenShift Container Platform version 3.9 and 3.10
-  | 3.1.1  | Linux® 64-bit (x86_64) systems <br/> Linux on IBM® Z systems
-![Event Streams 2018.3.1 icon](../../images/2018.3.1.svg "Event Streams 2018.3.1.") | 3.1.2  | - Linux® 64-bit (x86_64) systems <br/>- Linux on IBM® Z systems
-    | 3.1.1  | - Linux® 64-bit (x86_64) systems <br/>- Linux on IBM® Z systems
-    | 3.1.0  | Linux® 64-bit (x86_64) systems
-![Event Streams 2018.3.0 icon](../../images/2018.3.0.svg "Event Streams 2018.3.0.") | 3.1.0  | Linux® 64-bit (x86_64) systems
+![Event Streams 2018.3.1 icon](../../../images/2018.3.1.svg "Event Streams 2018.3.1.") | {{site.data.reuse.icp}} 3.1.1 and 3.1.2  | - Linux® 64-bit (x86_64) systems <br/>- Linux on IBM® Z systems
+  | {{site.data.reuse.icp}} 3.1.0  | - Linux® 64-bit (x86_64) systems
+![Event Streams 2018.3.0 icon](../../../images/2018.3.0.svg "Event Streams 2018.3.0.") | {{site.data.reuse.icp}} 3.1.0  | - Linux® 64-bit (x86_64) systems
 
+![Event Streams 2018.3.1 icon](../../../images/2018.3.1.svg "Event Streams 2018.3.1.") has Helm chart version 1.1.0 and includes Kafka version 2.0.1.
 
-For an overview of supported component and platform versions, see the [support matrix](../../support/#support-matrix).
+![Event Streams 2018.3.0 icon](../../../images/2018.3.0.svg "Event Streams 2018.3.0.") has Helm chart version 1.0.0 and includes Kafka version 2.0.
 
+For an overview of supported component and platform versions, see the [support matrix](../../../support/#support-matrix).
 
 Ensure you have the following set up for your {{site.data.reuse.icp}} environment:
   * Install [{{site.data.reuse.icp}}](https://www.ibm.com/support/knowledgecenter/SSBS6K_3.1.1/installing/install.html). \\
-    **Note:** {{site.data.reuse.long_name}} includes entitlement to {{site.data.reuse.icp_foundation}} which you can [download](../downloading) from IBM Passport Advantage.
+    **Note:** {{site.data.reuse.long_name}} includes entitlement to {{site.data.reuse.icp_foundation}} which you can download from IBM Passport Advantage.
   * Install the [Kubernetes command line tool](https://www.ibm.com/support/knowledgecenter/SSBS6K_3.1.1/manage_cluster/cfc_cli.html), and configure access to your cluster.
-  * Install the [{{site.data.reuse.icp}} Command Line Interface (CLI)](https://www.ibm.com/support/knowledgecenter/en/SSBS6K_3.1.1/manage_cluster/install_cli.html).
-  * Install the [Helm CLI](https://www.ibm.com/support/knowledgecenter/en/SSBS6K_3.1.1/app_center/create_helm_cli.html) required for your version of {{site.data.reuse.icp}}, and add the {{site.data.reuse.icp}} [internal Helm repository](https://www.ibm.com/support/knowledgecenter/en/SSBS6K_3.1.1/app_center/add_int_helm_repo_to_cli.html) called `local-charts` to the Helm CLI as an external repository.
+  * Install the [{{site.data.reuse.icp}} Command Line Interface (CLI)](https://www.ibm.com/support/knowledgecenter/SSBS6K_3.1.1/manage_cluster/install_cli.html).
+  * Install the [Helm CLI](https://www.ibm.com/support/knowledgecenter/SSBS6K_3.1.1/app_center/create_helm_cli.html) required for your version of {{site.data.reuse.icp}}, and add the {{site.data.reuse.icp}} [internal Helm repository](https://www.ibm.com/support/knowledgecenter/SSBS6K_3.1.1/app_center/add_int_helm_repo_to_cli.html) called `local-charts` to the Helm CLI as an external repository.
   * For message indexing capabilities (enabled by default), ensure you set the `vm.max_map_count` property to at least `262144` on all {{site.data.reuse.icp}} nodes in your cluster (not only the master node). Run the following commands on each node: \\
     `sudo sysctl -w vm.max_map_count=262144`\\
     `echo "vm.max_map_count=262144" | tee -a /etc/sysctl.conf`\\
@@ -133,9 +132,9 @@ The CPU and memory limits for some components are not limited by the chart, so t
 
 ## PodSecurityPolicy requirements
 
-To install the {{site.data.reuse.short_name}} chart, you must have the `ibm-restricted-psp` PodSecurityPolicy selected for the target namespace.
+To install the {{site.data.reuse.short_name}} chart, you must have the `ibm-restricted-psp` [PodSecurityPolicy](https://ibm.biz/cpkspec-psp) selected for the target namespace.
 
-You can define the PodSecurityPolicy when creating the [namespace](../planning/#namespaces) for your installation.
+You can define the PodSecurityPolicy when creating the [namespace](../installing/#create-a-namespace) for your installation.
 
 For more information about PodSecurityPolicy definitions, see the [{{site.data.reuse.icp}} documentation](https://www.ibm.com/support/knowledgecenter/SSBS6K_3.1.1/manage_cluster/security.html).