Giter VIP home page Giter VIP logo

docs-rabbitmq-pcf's Introduction

VMware RabbitMQ for Tanzu Application Service docs

This repo contains the VMware RabbitMQ for Tanzu Application Service documentation.

In this README:

Branches

The main branch is the tree-trunk, so ALWAYS make changes you want carried forward in this branch. This includes:

  • Unreleased features
  • Doc bug fixes
  • Doc reorganization or enhancement

Then, if necessary, immediately cherry-pick/copy any changes that you want to push immediately to production into the appropriate branches listed below:

Branch Name Staging Prod
main v2.5 N/A
2.4 v2.4 v2.4
2.3 v2.3 v2.3
2.2 v2.2 v2.2
2.1 v2.1 v2.1
2.0 NOT IN USE
1.21 NOT IN USE
1.20 NOT IN USE
1.19 NOT IN USE
1.18 NOT IN USE
1.17 NOT IN USE
1.16 NOT IN USE
1.15 NOT IN USE
1.14 NOT IN USE
1.13 NOT IN USE
1.12 NOT IN USE
1.11 NOT IN USE
1.10 NOT IN USE
1.9 NOT IN USE
1.8 NOT IN USE
1.7 NOT IN USE
1.6 NOT IN USE
1.5 NOT IN USE

Releasing a new minor version

Because main is the latest and greatest documentation, the process would be to cut a x.x branch for the version that main was targeting during that time.

After this point, main will then be the target for the next version of this product.

Partials

Cross-product partials for these docs are single sourced from the Docs Partials repository.

Contributing to documentation

If there is some documentation to add for an unreleased patch version of these docs, then create a branch off of the live branch you intend to modify and create a pull request against that branch. After the version that change is targeting is released, the pull request can be merged and will be live the next time a documentation deployment occurs.

If the documentation is meant to be target several released versions, then you will need to:

  • create a pull request for each individual minor version
  • or ask the technical writer to cherry-pick to particular branches/versions.

For instructions on how to create a pull request on a branch and instructions on how to create a pull request using a fork, see Creating a PR in the documentation team wiki.

Publishing docs

  • 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

  • Markdown files live in this repo.
  • Images should live in an images directory at the same level and linked with a relative link.
  • Each page requires an entry in config/toc.md for the table of contents.
  • Variables live in config/template_variables.yml.

In Docsdash

  1. Wait about 1 minute for processing to complete after uploading.

  2. Go to https://docsdash.vmware.com/deployment-stage

    There should be an entry with a blue link which says Documentation and points to staging.

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"

Troubleshooting Markdown

Problem List displays as a paragraph
Symptom: Bulleted or numbered lists look fine on GitHub but display as a single paragraph in HTML.
Solution: Add a blank line after the stem sentence and before the first item in the list.
Problem List numbering is broken: every item is 1.
Symptom: Each numbered item in a list is a 1. instead of 1., 2., 3., etc
Solution: Try removing any blank newlines within each step.
Problem Code boxes not showing
Symptom: VMware publishing system doesn't accept code tags after the three back ticks.
Solution: Make sure you're not using shell or bash or console or yaml after back ticks.

Style guide

Use this section to specify spelling of special words for VMware RabbitMQ for Tanzu Application Service:

  • on-demand plan
  • shared-VM plan
  • dedicated-VM plan
  • RabbitMQ Management UI

docs-rabbitmq-pcf's People

Contributors

abbyachau avatar ablease avatar animatedmax avatar ansd avatar avade avatar benlaplanche avatar bentarnoff avatar blgm avatar carlo-colombo avatar cf-meganmoore avatar coro avatar davidhiston avatar dlresende avatar ferozjilla avatar ghanna2017 avatar harshac avatar henryborys avatar ljarzynski avatar mark-peters-pivotal avatar mirahimage avatar mkuratczyk avatar mlimonczenko avatar pspinrad avatar radaeze avatar richardjjg avatar semanticallynull avatar snneji avatar theckkw avatar vlad-stoian avatar zvance avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

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

docs-rabbitmq-pcf's Issues

Firewall modification for RabbitMQ Service Broker

Need documentation when deploying RabbitMQ in a seperate services network. RabbitMQ Service broker - which runs on port 4567, should be able to access from Pivotal ERT. Firwall policy needs to be changed to allow access from ERT -> RabbitMQ Service Broker port 4567.

Formatting

Search for "You can read more" - this paragraph has typos and formatting issues.

HAProxy for pre-provisioned plans

We just found out, for the pre-provisioned cluster, even though we use external load-balancer, we still need HAProxy for the management dashboard. The document should clarify this.

Thanks
Yansheng

Metrics names have changed in 2.0

In 1.x Tile series we get metrics from the RabbitMQ management API. In Tile 2.x we get metrics from the RabbitMQ prometheus endpoint. As a result the names of some of the metrics have changed.

In the 2.0 we should be very clear that the metrics names have all changed, and provide information for the new metrics names.

We should also include that object level metrics are off by default.

VMWare Tanzu RabbitMQ for VMs docs https://docs.pivotal.io/rabbitmq-cf/2-0/monitor.html

RabbitMQ Prometheus metrics. https://github.com/rabbitmq/rabbitmq-prometheus/blob/master/metrics.md

upgrade path is incorrect

The document says you can upgrade directly from 1.15 to 1.17. That is not the case. When I tried to stage the 1.17 tile, I got the following message in OpsMgr
This upgrade requires that the currently installed version be 1.16.0 or higher.

Thanks
Yansheng

There is no documentation here about the "standard" plan that ships with PCF Dev

As a new user of cf using PCF Dev, I'm finding that working with RabbitMQ in this environment is a bit of a maze. This document explains a few differrent service options, but I'm using the free version that ships with PCF Dev, and I have found little-to-no documentation about installing it, getting it running, and (in my case) troubleshooting it.

In my case whenever I try to access the RabbitMQ Management Dashboard, my CF server returns 404 to the browser, the route isn't recognized. My first instinct is to seek out the documentation, but It either doesn't exist or is so difficult to find that I'm lost :(.

The docs have good coverage on the paid services, but for the version that ships on PCF Dev.. :(

Confusion around service access gateway tcp port range

When following the steps documented here: https://docs.pivotal.io/rabbitmq-cf/1-21/enable-service-gateway.html#configure-service-gateway-plan is it expected that the tcp port range be the same as configured and managed here: https://docs.pivotal.io/application-service/2-8/adminguide/enabling-tcp-routing.html#modify-ports So if in the cf curl steps we configure range 18000-18100 will that be the same range configured for the service access gateway? Would there ever be a time where these ranges are different?

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.