Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

d/s QS guide (not ready for review) #2946

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions guides/common/assembly_installing-server-quick-start.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
ifdef::context[:parent-context: {context}]

include::modules/con_installing-server.adoc[]

ifdef::satellite[]
include::modules/proc_registering-to-red-hat-subscription-management.adoc[leveloffset=+1]

include::modules/proc_attaching-satellite-infrastructure-subscription.adoc[leveloffset=+1]
endif::[]

include::modules/proc_configuring-repositories.adoc[leveloffset=+1]

include::modules/proc_installing-the-satellite-server-packages.adoc[leveloffset=+1]

ifdef::satellite[]
include::modules/proc_importing-a-subscription-manifest-into-foreman-server.adoc[leveloffset=+1]
endif::[]

ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
13 changes: 13 additions & 0 deletions guides/common/assembly_preparing-environment-quick-start.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
ifdef::context[:parent-context: {context}]
[id="preparing-environment-quick-start_{context}"]
= Preparing your environment for installation

Before you install {Project}, ensure that your environment meets the installation requirements.
See link:{InstallingServerDocURL}preparing-environment-for-satellite-installation_{project-context}[Preparing your Environment for Installation] in _{InstallingServerDocTitle}_ for details.

include::modules/ref_system-requirements.adoc[leveloffset=+1]

include::modules/ref_supported-operating-systems.adoc[leveloffset=+1]

ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
6 changes: 3 additions & 3 deletions guides/common/attributes-titles.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@

ifdef::katello[]
:InstallingServerDocTitle: Installing {ProjectServerTitle} with Katello {KatelloVersion} plugin on {install-on-os}
:QuickstartDocTitle: Quickstart guide for {Project} with Katello on {install-on-os}
:QuickStartDocTitle: Quick start guide for {Project} with Katello on {install-on-os}
endif::[]

ifdef::satellite[]
Expand All @@ -48,12 +48,12 @@ ifdef::satellite[]
:ManagingConfigurationsAnsibleDocTitle: Managing configurations using Ansible integration
:ManagingConfigurationsPuppetDocTitle: Managing configurations using Puppet integration
:PlanningDocTitle: Overview, concepts, and deployment considerations
:QuickstartDocTitle: Quickstart
:QuickStartDocTitle: Quick start
:UpgradingDocTitle: Upgrading connected {ProjectName} to {ProjectVersion}
endif::[]

ifdef::orcharhino[]
:InstallingServerDocTitle: Installing {ProjectServerTitle}
:InstallingSmartProxyDocTitle: Installing {SmartProxyServer}
:QuickstartDocTitle: Quickstart
:QuickStartDocTitle: Quick start
endif::[]
2 changes: 1 addition & 1 deletion guides/common/modules/con_installing-server.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ This argument ensures that no actual changes are made.
Potential changes are written to `{installer-log-file}`.

Files are always backed up and so you can revert any unwanted changes.
For example, in the foreman-installer logs, you can see an entry similar to the following about Filebucket:
For example, in the {foreman-installer} logs, you can see an entry similar to the following about Filebucket:

[options="wrap"]
----
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[id="quick-start-additional-resources_{context}"]
= Additional resources (in progress)

* link:{ContentManagementDocURL}Introduction_to_Content_Management_content-management[{ContentManagementDocTitle}]
* Provisioning hosts
* Managing hosts
21 changes: 21 additions & 0 deletions guides/common/modules/con_quick-start-overview.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
[id="Quick-start-overview_{context}"]
= Using this guide

The {Project} installer is a collection of Puppet modules that installs everything required for a full working {Project} setup.
It uses native OS packaging (`.rpm` or `.deb` packages) and adds necessary configuration for the complete installation.

The {Project} components include the web UI, {SmartProxy}, a Puppet server, TFTP, DNS, and DHCP servers.
It is configurable and the Puppet modules can be read or run in "no-op" mode to see what changes it will make.

You can quickly install and configure your {ProjectServer} if the following assumptions apply to your environment:

* You are performing a fresh installation.
* You can connect to the Red{nbsp}Hat Content Delivery Network, located at `cdn.redhat.com`, to obtain packages and receive updates.
* You have an existing host that you want to register to {Project} to use for patching.
// To be confirmed with Ian Ballou or Jeremy Lenz
* Your deployment uses simple Content Views.

If your environment does not fit with these assumptions, see the following resources:

* link:{InstallingServerDocURL}[{InstallingServerDocTitle}]
* link:{InstallingServerDisconnectedDocURL}[{InstallingServerDisconnectedDocTitle}]
File renamed without changes.
File renamed without changes.
File renamed without changes.
15 changes: 15 additions & 0 deletions guides/doc-Quick_start/docinfo.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<title>{QuickStartDocTitle}</title>
<productname>Red Hat Satellite</productname>
<productnumber>{ProjectVersion}</productnumber>
<subtitle>Install and configure {ProjectName} Server</subtitle>
<abstract>
<para>This guide describes how to quickly install {ProjectName} Server in a connected environment.</para>
</abstract>
<authorgroup id="Author_Group">
<author>
<firstname>Red Hat Satellite</firstname>
<surname>Documentation Team</surname>
<email>satellite-doc-list@redhat.com</email>
</author>
</authorgroup>
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,4 @@ include::common/modules/proc_configuring-repositories.adoc[leveloffset=+1]

include::common/modules/proc_installing-the-satellite-server-packages.adoc[leveloffset=+1]

include::common/modules/proc_running-installer.adoc[leveloffset=+1]

include::common/modules/proc_running-installer.adoc[leveloffset=+1]
89 changes: 89 additions & 0 deletions guides/doc-Quick_start/master.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
include::common/attributes.adoc[]
include::common/header.adoc[]
= {QuickStartDocTitle}
:context: quick-start
:mode: connected
:ProductName: {ProjectServer}

ifdef::satellite[]
include::common/modules/con_making-open-source-more-inclusive.adoc[leveloffset=+1]

include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1]
endif::[]

include::common/modules/con_quick-start-overview.adoc[leveloffset=+1]

include::common/assembly_preparing-environment-quick-start.adoc[leveloffset=+1]

include::common/assembly_installing-server-quick-start.adoc[leveloffset=+1]

include::common/modules/con_quick-start-additional-resources.adoc[leveloffset=+1]

// == Importing Subscriptions and Synchronizing Content

// // Enabling Repositories and Synchronizing Content
// include::topics/importing_subscriptions_syncronizing_content_parent.adoc[leveloffset=+1]

// // Enabling Red Hat Repositories
// include::topics/enabling_redhat_repos.adoc[leveloffset=+2]

// // Creating Custom Products and Repositories
// include::topics/creating_custom_products_repos.adoc[leveloffset=+2]

// // Synchronizing Content
// include::topics/synchronizing_content.adoc[leveloffset=+2]

// == Managing and Promoting Content

// // Creating an Application Life Cycle Environment
// include::topics/creating_application_life_cycle_environment.adoc[leveloffset=+2]

// // Creating a Content View
// include::topics/creating_content_view.adoc[leveloffset=+2]

// // Adding Red Hat Enterprise Linux Repositories
// include::topics/adding_linux_repos.adoc[leveloffset=+2]

// // Adding Puppet Modules
// include::topics/adding_puppet_modules.adoc[leveloffset=+2]

// // Publishing a Content View
// include::topics/publishing_content_view.adoc[leveloffset=+2]

// // Creating and Editing Activation Keys
// include::topics/creating_editing_activation_keys.adoc[leveloffset=+2]

// == Patching Your Systems

// // Patching Your Systems
// include::topics/patching_system.adoc[leveloffset=+1]

// // Registering an Existing System
// include::topics/registering_existing_system.adoc[leveloffset=+2]

// // Patching Your System Using Katello Agent
// include::topics/patching_katello_agent.adoc[leveloffset=+2]

// // Installing Katello Agent
// include::topics/installing_katello_agent.adoc[leveloffset=+3]

// // Applying Errata to a Content Host
// include::topics/applying_errata_content_hosts.adoc[leveloffset=+3]

// // Patching Your System Using Remote Execution
// include::topics/patching_remote_execution.adoc[leveloffset=+2]

// // Establishing a Secure Connection for Remote Commands
// include::topics/configuring_remote_execution.adoc[leveloffset=+3]

// Installing Errata Updates
// include::topics/setting_up_job_templates_remote_execution.adoc[leveloffset=+3]

// == Finalizing the Provisioning Configuration

// // Creating Provisioning Templates
// include::topics/creating_provisioning_templates.adoc[leveloffset=+2]

// // Creating Host Groups
// include::topics/creating_host_groups.adoc[leveloffset=+2]

Loading