Git Product home page Git Product logo

salt-get-started's Introduction

SaltStack Get Started Guide Source

This repository contains the content source files for the SaltStack Get Started Guide.

Contributions to fix typos and other errors are welcome.

Source File Format

The source files are in Pandoc's Markdown with the markdown+pipe_tables & backtick_code_blocks extensions enabled.

Code samples that contain Jinja must be wrapped in Jinja {% raw %} and {% endraw %} statements since the source files are sent though Jinja when the site is generated.

Preview

There are many tools that can generate a preview from markdown so you can verify formatting, URLs, and so on. If you have pandoc installed, you can quickly generate HTML using a command similar to:

pandoc *.md > out.html

YAML Frontmatter

The YAML frontmatter and processing directives can be safely ignored (processing directives are contained within {: :}). A few topics contain variables with content for modal windows in the front matter, so there is occasionally a need to make updates here.

salt-get-started's People

Contributors

4x0v7 avatar abeutot avatar barbaricyawps avatar dmurphy18 avatar goetzk avatar grandpubba avatar jacobhammons avatar jpellman avatar karras avatar patrickyevsukov avatar s0undt3ch avatar sdreher avatar shashwatpandeyvns avatar stooj avatar vitaliyf avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  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  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

salt-get-started's Issues

config/pillar.md: dangling reference to ftpsync state

The section "SALT PILLAR ON THE COMMAND LINE" references a ftpsync state.
It's unclear where that comes from. Presumably it was created in the previous paragraph, but that didn't mention to create the state in a ftpsync.sls file.

errors in https://docs.saltstack.com/en/getstarted/fundamentals/states.html

The page fundamentals/states.html has some problems with it. To over-arching to try to submit a fix.
https://docs.saltstack.com/en/getstarted/fundamentals/states.html
The images on the page do not match what I get in the demo environment.

The last image on the page has a section in the text "update_lftpd_conf" which is nowhere in the state file., both say "succeeded: 2",where as when I run it in the demo system, it says succeeded:1, and the side bar talks about execution order, saying "packages are installed before teh configuration file is updated" when nothing in the state referes to a config file.
It looks like the author tried to simplify the page, but didn't do the images or the side bar.

top.md doesn't provide state files for users without the Vagrant environment

If you follow the tutorial but choose not to use the Vagrant demo environment, applying the final top.sls results in an error.

salt '*' state.apply
minion1:
    Data failed to compile:
----------
    No matching sls found for 'common' in env 'base'
minion2:
    Data failed to compile:
----------
    No matching sls found for 'common' in env 'base'

Instructions to create the common directory could be added, along with instructions to populate it with something suitable.

guide gives bad advice on the use of Pillar

This document is the first hit when searching for things like getting started with saltstack, but gives some bad advice that will lead new users the wrong way. It presents Pillar as the only way to separate data from code, rather than as a thing to be used only for secrets. According to this very long thread on Slack, Pillar does not scale well enough to be the only source of data, and using things like map files (documented in the newer getting started documentation) is the best practice for most data.

I'm not sure I have good suggestions for how to deal with this document. The only solutions that come to mind are:

  • rewrite the sections that mention Pillar to be clearer that it is not expected to be used for all data, and to include reference to other, better mechanisms for storing data
  • remove the document from the Internet so that searches land on newer documentation

I gather this problem of searches landing people on out of date advice on Pillar is more widespread than just this document, so it may be that this Issue should be closed and either moved or merged with an umbrella issue somewhere.

config/functions.md: "if you target a directory" unexplained

The "init.sls" section states:

If you target a directory during a state.apply or in the state Top file, salt looks for an init.sls file in that directory and applies it.

However, so far, it hasn't been explained how to target a directory or what targeting a directory even means, leaving the reader baffled.

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.