Git Product home page Git Product logo

docs-ops-manager's Introduction

Ops Manager Documentation

This repository contains content for the Ops Manager documentation. We publish the Ops Manager documentation at https://docs.vmware.com/en/VMware-Tanzu-Operations-Manager/index.html.

In this README:

How To Contribute

Please help us improve the accuracy and completeness of the Ops Manager documentation by contributing content, editing, or expertise.

A common way to contribute is to file a pull request through GitHub.

Every topic in the Ops Manager documentation has a corresponding file in this repository. To locate the source file for a topic, navigate to the topic on the Ops Manager documentation site and click "View the source for this page in GitHub" at the bottom of the topic.

Versions and Branches

Content Branch Published URL
3.0 https://docs.vmware.com/en/VMware-Tanzu-Operations-Manager/3.0/vmware-tanzu-ops-manager/index.html
2.10 https://docs.vmware.com/en/VMware-Tanzu-Operations-Manager/2.10/vmware-tanzu-ops-manager/index.html
2.9 Not supported. https://docs.pivotal.io/ops-manager/2-9/index.html (archived and publiched as a PDF)
2.8 Not supported. https://docs.pivotal.io/ops-manager/2-8/index.html (archived and publiched as a PDF)
2.7 Not supported. https://docs.pivotal.io/ops-manager/2-7/index.html (archived and publiched as a PDF)
master not used
master not used
2.6 https://docs.pivotal.io/ops-manager/2-6/index.html
2.5 https://docs.pivotal.io/ops-manager/2-5/index.html
2.4 https://docs.pivotal.io/ops-manager/2-4/index.html
2.3 https://docs.pivotal.io/ops-manager/2-3/index.html
2.2 https://docs.pivotal.io/ops-manager/2-2/index.html
2.1 https://docs.pivotal.io/ops-manager/2-1/index.html
2.0 https://docs.pivotal.io/ops-manager/2-0/index.html

3.0: The 3.0 branch is used to publish the v3.0 site. Create pull requests on 3.0 to contribute or correct technical inaccuracies in the Ops Manager v3.0 documentation.

2.10: The 2.10 branch is used to publish the v2.10 site. Create pull requests on 2.10 to contribute or correct technical inaccuracies in the Ops Manager v2.10 documentation.

Publishing Docs (2.10 and later)

The 2.10 and later docs have been migrated to docs.vmware.com and are now published using the following tools:

  • docworks is the main tool for managing docs used by writers.
  • docsdash is a deployment UI which manages the promotion from staging to pre-prod to production. The process below describes how to upload our docs to staging, replacing the publication with the same version.

Prepare Markdown Files

This repo contains the following files:

  • Markdown files live in this repo.
  • The table of contents is now in this repo in the toc.md file. Each page requires an entry in the TOC.
  • Variables also live in this repo in the template_variables.yml.

In DocWorks

  1. Run a build of the "VMware Tanzu Ops Manager" project to upload the docs to Docs Dash.
  2. Review your changes on the staging site https://docs-staging.vmware.com/...

In Docsdash

  1. Wait about 1 minute for processing to complete after uploading.
  2. Go to https://docsdash.vmware.com/deployment-stage.

Promoting to Pre-Prod and Prod

Prerequisite Needs additional privileges - reach out to a manager on the docs team #tanzu-docs or ask a writer to do this step for you.

  1. Go to Staging publications in docsdash
    https://docsdash.vmware.com/deployment-stage

  2. Select a publication (make sure it's the latest version)

  3. Click "Deploy selected to Pre-Prod" and wait for the pop to turn green (refresh if necessary after about 10s)

  4. Go to Pre-Prod list
    https://docsdash.vmware.com/deployment-pre-prod

  5. Select a publication

  6. Click "Sign off for Release"

  7. Wait for your username to show up in the "Signed off by" column

  8. Select the publication again

  9. Click "Deploy selected to Prod"

Publishing Docs (2.9 and earlier)

How To Use Bookbinder To View Your Documentation

Bookbinder is a command-line utility for stitching Markdown documents into a hostable web app. The documentation team uses Bookbinder to publish our documentation sites, but you can also use Bookbinder to view a live version of your documentation on your local machine.

Bookbinder draws the content for the site from this repository, the left navigation menu ("subnav") from docs-book-om, and various layout configuration and assets from docs-layout-repo.

To use Bookbinder to view your documentation, perform the following steps:

  1. Clone this repository to the ~/workspace directory on your local machine.
  2. Clone the following repositories to the ~/workspace directory on your local machine:
  3. Use the Versions and Branching table above to determine which branch of docs-ops-manager that you need to git checkout to build the version of the documentation that you want. If necessary, navigate to the docs-ops-manager directory and git checkout BRANCH-NAME.
  4. Navigate in the docs-book-om directory.
  5. Run bundle install to install all of the necessary gems, including Bookbinder.
  6. Run bundle exec bookbinder bind local to build a Rack web-app of the book. After the bind has completed, navigate into the final_app directory and run rackup. Then navigate to localhost:9292/platform/ops-manager/index.html in a browser.

Continuous Integration and Continuous Delivery

We use Concourse pipelines to provide continuous integration and continuous delivery. Any change made to this repository or the https://github.com/pivotal-cf/docs-book-om Book repository trigger a "bind" where the disparate parts of the Ops Manager documentation are assembled into a single web app. A successful bind triggers pushing the app to the staging site, https://docs-pcf-staging.cfapps.io/platform/ops-manager. After review, the staging site is manually pushed to the production site, https://docs.pivotal.io/platform/ops-manager/.

Concourse Pipelines:

docs-ops-manager's People

Contributors

a-peek4 avatar abbyachau avatar alamages avatar animatedmax avatar apeek4 avatar araher avatar bentarnoff avatar cshollingsworth avatar elenasharma avatar erabil avatar forddonald avatar gcapizzi avatar genevieve avatar ghanna2017 avatar jbheron avatar kdolor-pivotal avatar ljarzynski avatar michaeltrestman avatar mirahimage avatar mjgutermuth avatar mlimonczenko avatar mreider avatar pspinrad avatar radaeze avatar ryanpei avatar seviet avatar snneji avatar teamhedgehog avatar thereses avatar vikafed avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docs-ops-manager's Issues

Azure NTP works differently than Documented

URL or GitHub link to the page where you're having the issue
https://docs.pivotal.io/ops-manager/2-9/azure/config-manual.html#director-config
https://docs.pivotal.io/ops-manager/2-10/azure/config-manual.html#director-config

Is your request for a change or addition to content related to a problem? If so, please describe.
Azure NTP works differently than the other iaases. We don't allow the user to configure ntp, instead we use a ptp hardware clock. There's a bit more about it here but it's Azure's supposedly less latent and more accurate solution

Describe the solution you'd like
The docs aren't misleading about ntp usage.

Describe alternatives you've considered
We could revert this commit in the stemcell but it seems like moving in the wrong direction.

Additional context
Add any other context or screenshots about the content request here.

The vsphere permissions list has an unknown permission

Services Network Gateway address is incorrect

Services Network -> Gateway
Enter the first .1 address from the CIDR. For example, if the CIDR is 192.168.16.0/22, enter 192.168.16.1.

Should be (in consistency with infrastructure and runtime networks)
For example, if the CIDR is 192.168.20.0/22, enter 192.168.20.1.

Ops Manager v2.10.7 release notes are missing

URL or GitHub link to the page where you're having the issue
https://docs.pivotal.io/ops-manager/2-10/release-notes.html
https://github.com/pivotal-cf/docs-ops-manager/blob/2.10/release-notes.html.md.erb
https://network.pivotal.io/products/ops-manager/#/releases/831104

Is your request for a change or addition to content related to a problem? If so, please describe.
Ops Manager v2.10.7 was released on 2021-02-11, but the release notes have not been added.

Describe the solution you'd like
Ops Manager v2.10.7 release notes are added.

Describe alternatives you've considered
n/a

Additional context
n/a

Please configure GITBOT

Pivotal provides the Gitbot service to synchronize issues and pull requests made against public GitHub repos with Pivotal Tracker projects.

If you do not want to use Pivotal Tracker to manage this GitHub repo, you do not need to take any action.

If you are a Pivotal employee, you can configure Gitbot to sync your GitHub repo to your Pivotal Tracker project with a pull request.

Steps:

  • Add the Toolsmiths-Bots team to have admin access to your repo
  • Add the cf-gitbot ([email protected]) user to have owner access to your Pivotal Tracker project
  • Create new branch in this repo: cfgitbot-config (an ask+cf@ ticket is the fastest way to get write access if you get a 404)
  • Add your new repo and or project to config-production.yml file
  • Submit a PR, which will get auto-merged if you've done it right. Detailed steps here

If you are not a pivotal employee, you can request that [email protected] set up the integration for you.

You might also be interested in configuring GitHub's Service Hook for Tracker on your repo so you can link your commits to Tracker stories. You can do this yourself by following the directions at:

https://www.pivotaltracker.com/blog/guide-githubs-service-hook-tracker/

If there are any questions, please reach out to [email protected].

Always pcf-nsg and none opsmgr-nsg?

Here:
https://github.com/pivotal-cf/docs-ops-manager/blob/2.0/azure/deploy-manual.html.md.erb

Those commands:
$ az network vnet subnet create --name Management
--vnet-name PCF
--resource-group $RESOURCE_GROUP
--address-prefix 10.0.4.0/26
--network-security-group pcf-nsg
$ az network vnet subnet create --name Deployment
--vnet-name PCF
--resource-group $RESOURCE_GROUP
--address-prefix 10.0.12.0/20
--network-security-group pcf-nsg
$ az network vnet subnet create --name Services
--vnet-name PCF
--resource-group $RESOURCE_GROUP
--address-prefix 10.0.8.0/20
--network-security-group pcf-nsg

are always referring to the pcf-nsg. I assume one or more of them should refer also to opsmgr-nsg otherwise this opsmgr-nsg is not used and doesn't have to be created.

Advanced Meastro Certification Rotation procedure removed from docs

URL or GitHub link to the page where you're having the issue
Where in the documentation set can I see the problem? If it's a more general request, then at least identify the product and version.

Please remove this page: https://docs.vmware.com/en/VMware-Tanzu-Operations-Manager/3.0/vmware-tanzu-ops-manager/security-pcf-infrastructure-advanced-certificate-rotation.html

Along with any references to it (e.g. It's referrenced here https://docs.vmware.com/en/VMware-Tanzu-Operations-Manager/3.0/vmware-tanzu-ops-manager/security-pcf-infrastructure-maestro-tile-compatibility.html and maybe elsewhere). When it makes sense, mention that folks in this situation should contact support.

Is your request for a change or addition to content related to a problem? If so, please describe.
A clear and concise description of the problem. For example: "Whenever I upgrade my software I forget to first collect information about the things I've already installed"

Removal of advanced cert rotation instructions since support has raised that customers get into trouble doing this and it would be better to have them contact support.

https://vmware.slack.com/archives/C035LESM2KH/p1707418832292109

Describe the solution you'd like
A clear and concise description of what you want to happen.
Removal of advanced cert rotation instructions

Describe alternatives you've considered
A clear and concise description of any alternative solutions or content you've considered.
We could add more warning to the page however I see it called out that it's not recommended already. I believe that much of this information may already exist in support KB's which we could link.

Additional context
Add any other context or screenshots about the content request here.

App downtime warning should be in 2.8 and 2.9 version

this warning should recommend customers upgrade to operations manager 2.10 to avoid app downtime. Also we should add this warning to the 2.9 docs. See Slack thread

<p class="note warning"><strong>Warning:</strong> <%= vars.recommended_by %> recommends that you upgrade to <%= vars.ops_manager %> v2.9 and <%= vars.app_runtime_full %> (<%= vars.app_runtime_abbr %>) v2.9 to rotate certificates safely with CredHub Maestro. If you need to rotate a certificate or CA immediately in <%= vars.ops_manager %> v2.8 and <%= vars.app_runtime_abbr %> v2.8, you can use the CredHub Maestro CLI, but you may experience app downtime.</p>

PCF 2.5 - S3 Blobstore CA cert configuration instructions

I have a question about the instructions at location:

PCF 2.5
URL: https://docs.pivotal.io/pivotalcf/2-5/om/aws/config-terraform.html

  • Configuring BOSH Director on AWS Using Terraform
  • S3 Compatible Blobstore
  • 1 S3 Endpoint
  • c. "Copy the custom public CA certificate..."

The instructions refer to the "public CA certificate you used to sign the S3 endpoint"
The Note box also refers to a "custom CA certificate"

Two questions:

  1. What custom CA cert is being referred to in these S3 blobstore instructions and note?
  2. Is "sign the S3 endpoint" correct wording?

image

Improved search functionality

Describe the solution you'd like

This request is likely beyond the scope of the docs team and to the eng team that backs docs however hopefully you can forward it to the correct team.

"90% of the documentation tickets where support providing customers with links to existing docs or kbs that provided a solution to their problem. We want to see the search ability of our docs improved so this information is more discoverable in a self service model. "

This is a feature request for better search on kb articles and docs

Describe alternatives you've considered
A clear and concise description of any alternative solutions or content you've considered.

Additional context
Add any other context or screenshots about the content request here.

Custom VM types no longer required for Azure Government

According to the documentation, you must set custom VM types for Azure Government (as well as Azure Stack). Based on the suggested script, the VM types are being changed from ones which support Premium disks to ones that only support Standard disks. See documentation for reference:
https://docs.pivotal.io/pivotalcf/2-3/om/azure/config-manual.html#stack-gov-prereqs

Since all of the DS* and F*s VM types are supported in Azure Government, this script is no longer neccessary. In fact, when you go to select "Premium_LRS" from the Director Config page, you will get an error if you set the custom VM types.

Opsman LDAP admin client docs improved

URL or GitHub link to the page where you're having the issue
Where in the documentation set can I see the problem? If it's a more general request, then at least identify the product and version.
https://docs.vmware.com/en/VMware-Tanzu-Operations-Manager/3.0/vmware-tanzu-ops-manager/login.html?hWord=N4IghgNiBcIQJmADiAvkA#log-in-to-tanzu-operations-manager-with-ldap-4

Describe the solution you'd like
We'd like the Opsman Ldap pages to reflect more of the information provided here in the open source docs and in uaa itself (https://github.com/cloudfoundry/uaa/blob/master/docs/UAA-LDAP.md)

Tied to support request: https://vmware.slack.com/archives/C035LESM2KH/p1707418832292109

Ops Manager v2.10.15 release notes are missing

URL or GitHub link to the page where you're having the issue
https://docs.pivotal.io/ops-manager/2-10/release-notes.html
https://github.com/pivotal-cf/docs-ops-manager/blob/2.10/release-notes.html.md.erb#L22

Is your request for a change or addition to content related to a problem? If so, please describe.
An addition. Ops Manager v2.10.15 has been released on PivNet, but the release notes are missing in the documentation.

Describe the solution you'd like
Ops Manager v2.10.15 release notes should be in the documentation.

For GCP, need to configure Excluded Resources in the director tile.

I was going to do a PR on this but this section looks to be common, so I am not sure how to proceed. Here is what needs to change.

For GCP, we need to set 169.254.169.254 in the Excluded Resources list. This is because that is the IP of the GCP Metadata (and thereby DNS) resolver. Otherwise you get recursive DNS lookups and have failures to resolve hosts. This is the text I would suggest for GCP:

Current Text:
(Optional) Enter your list of comma-separated Excluded Recursors to declare which IP addresses and ports should not be used by the DNS server.

Suggested Text:
Enter your list of comma-separated Excluded Recursors to declare which IP addresses and ports should not be used by the DNS server, this should minimally include the IP of the Metadata Server (169.254.169.254). Adding this IP is required to avoid name resolution issues with Bosh DNS

Internal Authentication not working as expected

1. Log in to <%= vars.ops_manager %> with the Admin username and password you created in the previous step.

Following the steps provided in this document results in an error message Unable to verify email or password. Please try again.
Since the username and password provided in the previous step isn't working there seems to be no way to log in to Ops Manager after initial install.

AWS - A load balancer cannot be attached to multiple subnets in the same Availability Zone

I run the terraform apply plan. I configured by variables correct and was about to get this working in aws gov. However on the commercial side. US-EAST i am getting the error:
Error: Error applying plan:

3 error(s) occurred:

  • module.pas.aws_lb.ssh: 1 error(s) occurred:

  • aws_lb.ssh: Error creating network Load Balancer: InvalidConfigurationRequest: A load balancer cannot be attached to multiple subnets in the same Availability Zone
    status code: 400, request id: 1c9173b3-4de3-11e9-af33-5fa505d58460

  • module.pas.aws_lb.web: 1 error(s) occurred:

  • aws_lb.web: Error creating network Load Balancer: InvalidConfigurationRequest: A load balancer cannot be attached to multiple subnets in the same Availability Zone
    status code: 400, request id: 1c919b2c-4de3-11e9-bbdc-2df790f44f33

  • module.pas.aws_lb.tcp: 1 error(s) occurred:

  • aws_lb.tcp: Error creating network Load Balancer: InvalidConfigurationRequest: A load balancer cannot be attached to multiple subnets in the same Availability Zone
    status code: 400, request id: 1c920fa7-4de3-11e9-9370-7540ede32166

Anyone know how to resolve the load balancer issue for Pivotal Cloud Foundry on AWS US-EAST for Elastic Load Balancers?

FYI, i am following this guide: https://docs.pivotal.io/pcf/om/2-3/aws/prepare-env-terraform.html

Deploying OpsManager OVA and SSH key format

On the deploy step of the OpsMan OVA, when it comes to the SSH key field as shown here, the screenshot implies that only the encoded string is necessary. I have found this to not be true and the entire public key similar to the format required for authorized_keys is necessary. For example, the format required is similar to the following:

ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAnZBapWsER/EO1hLYvV/rkZe78mUBueZGHx1kw+ByfNbLoA385Cm72L+6qq40yOIH6R42nHN/bynbeHOD4Ptes4/s2lrLJtTzEWgH9XYnId4sE5f+QTFd2kRtTzZcu8WvFudEIyCIWjO+o9yvPETs05dEl/3KDn+t9uXxiszrG9Ycb2uNNpmDES+ohm9BQQFmpwFnao+UuQbRXLCcQ3SoE3Ai5Z9O+3PBwm0IByx87/dUuqvVISAJ8yGu2hJobx9PPStFERtUsfx5x+WIu9XIkrl5tzxgH9hBDsOS9cVUYJ7kKUUf1yyro6ocHyu6TWHJHSJLt8Z2FULxMPpqdn+8Xw== my-key

Either an updated screenshot or, preferably, some expounded instruction which explains this would help others in more quickly deploying the OVA.

GCP Storage buckets

Not sure if this is an issue later on, for me at the moment, OpsMan isn't working even though the VM is up. I'll have to figure out how to see the logs and then check them for a possible issue, but one issue with the docs for setting up Ops Manager on GCP is in the part where it asks you to create storage buckets on GCP.
GCP requires universally unique bucket names and hence does not take the default names in the documentation. I'm the admin for a single project on the GCP account, trying to install for a Single project (not shared). I created buckets with names different from what the documentation said but I don't know if that can be an issue moving on.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.