Documentation/InstallGuideChanges

The new OpenStack Networking Guide will be taking content from the Install and Cloud Admin Guides, which means the content of those two guides is going to be "beefed up" to provide more context for users so that they get a good understanding of what's going on, rather than just a series of steps. We are also considering moving nova-network to be with Neutron, rather than Nova. This is the target outline, of the relevant chapters.

NOTE: this is the current version, put here as a reference for us to work from.

Preface

Document change history

1 Architecture
 * Conceptual architecture
 * Logical architecture
 * Example architectures

2 Basic operating system configuration
 * Before you begin
 * Networking
 * Network Time Protocol (NTP)
 * Passwords
 * MySQL database
 * OpenStack packages
 * Messaging server

3 Configure the Identity Service

4 Configure the Image Service

5 Configure Compute services
 * Compute service
 * Install Compute controller services
 * Configure a Compute node
 * Enable Networking
 * Launch an instance

6 Add the dashboard

7 Add the Block Storage Service

8 Add Object Storage

9 Install the Networking service
 * Networking considerations
 * Neutron concepts
 * Install Networking services
 * Neutron deployment use cases

10 Add the Orchestration service

11 Add the Telemetry service

Proposed changes

Preface

Document change history

1 Architecture
 * Conceptual architecture
 * Provide general explanation of "core" nodes... controller, network, and compute.
 * Provide general explaination of "additional" nodes... storage.
 * Explain general hardware requirements of nodes... cpu, disk, and memory.
 * Logical architecture
 * Example core architectures
 * Two-node with Nova networking (two interfaces per node)
 * Provide diagrams containing services on each node and physical/logical connectivity (e.g., network interfaces with usable IP addresses)
 * Three-node with Neutron networking (two interfaces per node except network which has three)
 * Provide diagrams containing services on each node and physical/logical connectivity (e.g., network interfaces with usable IP addresses)
 * Indicate requirements for "surrounding" network components (e.g., do not use DHCP, external network should offer more than 1 IP address to support floating IPs etc.)
 * Provide links to additional networking information (book?)
 * Example architecture with additional nodes
 * Add storage nodes to either of the core architectures
 * Condensed archectectures
 * Explain option to "condense" architectures with fewer nodes or network interfaces with the caveat that it makes troubleshooting more difficult and probably doesn't reflect a production environment (maybe?)

2 Basic operating system configuration
 * Before you begin
 * Prefer use of "base" installations rather than "everything" installations
 * Provide recommended partition sizes and filesystem types? (maybe?)
 * Networking
 * Explain firewall situation (depends on distribution)
 * Configuration for two-node arch (broken up by node)
 * Provide recommended entries for /etc/hosts or DNS
 * Note importance of key-based SSH authentication when considering multiple compute nodes with migration
 * Provide connectivity tests
 * Configuration for three-node arch (broken up by node)
 * Provide recommended entries for /etc/hosts or DNS
 * Note importance of key-based SSH authentication when considering multiple compute nodes with migration
 * Provide connectivity tests
 * Configuration for additional nodes (although I'm wondering if we should move these details to their associated chapters... e.g., swift)
 * Install additional base services and useful troubleshooting tools
 * ntp, wget, tcpdump...
 * Passwords
 * MySQL database
 * Recommend further restricting grants before moving into production
 * Messaging server (moved before OpenStack packages since the OpenStack repos don't provide these packages)
 * OpenStack packages

3 Configure the Identity Service
 * Add a "demo" tenant and user so that Neutron doesn't break
 * Explain openrc files and how to use them (mostly covered in "Install the OpenStack command-line clients" chapter)

4 Configure the Image Service

5 Configure Compute services
 * Compute service
 * Change to "concepts" like the other services
 * Install Compute controller services
 * Configure a Compute node

6 Configure networking


 * Networking strategy
 * Networking considerations
 * Configure Nova networking
 * Which use case(s)?
 * Neutron concepts
 * ML2
 * Open vSwitch
 * GRE
 * VXLAN
 * Configure Neutron networking
 * ML2 with... GRE or VXLAN?
 * Install Networking services
 * Install Networking services on a dedicated network node
 * Install networking support on a dedicated compute node
 * Install networking support on a dedicated controller node
 * Create the base Neutron networks
 * Neutron deployment use cases
 * Single flat network
 * Provider router with private networks
 * Per-tenant routers with private networks

7 Add the dashboard
 * When complete, jump to launch an instance or continue configuring additional services. We could launch an instance before the dashboard, but I think people feel GUIs provide a more polished experience. If we feel the dashboard is important, we should include screen shots for creating and launching an instance.
 * Note that Cinder is required for the Dashboard to work

8 Add the Block Storage Service
 * When compete, jump to launch an instance or continue configuring additional services

9 Add Object Storage
 * When compete, jump to launch an instance or continue configuring additional services

10 Add the Orchestration service
 * When compete, jump to launch an instance or continue configuring additional services

11 Add the Telemetry service
 * When compete, jump to launch an instance or continue configuring additional services

12 Launch an Instance