diff --git a/404.html b/404.html index ec91b7124..9134d0b60 100644 --- a/404.html +++ b/404.html @@ -3,11 +3,11 @@ -Page Not Found | Rancher Government Hauler - - +Page Not Found | Rancher Government Hauler + + -
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

+
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

\ No newline at end of file diff --git a/CNAME b/CNAME deleted file mode 100644 index 29281350a..000000000 --- a/CNAME +++ /dev/null @@ -1 +0,0 @@ -docs.hauler.dev \ No newline at end of file diff --git a/assets/css/styles.2eee3a79.css b/assets/css/styles.2cf957a2.css similarity index 63% rename from assets/css/styles.2eee3a79.css rename to assets/css/styles.2cf957a2.css index eafafba21..f33c2d5bd 100644 --- a/assets/css/styles.2eee3a79.css +++ b/assets/css/styles.2cf957a2.css @@ -1 +1 @@ -.col,.container{padding:0 var(--ifm-spacing-horizontal);width:100%}.markdown>h2,.markdown>h3,.markdown>h4,.markdown>h5,.markdown>h6{margin-bottom:calc(var(--ifm-heading-vertical-rhythm-bottom)*var(--ifm-leading))}body,ol ol,ol ul,ul ol,ul ul{margin:0}blockquote,pre{margin:0 0 var(--ifm-spacing-vertical)}.breadcrumbs__link,.button{transition-timing-function:var(--ifm-transition-timing-default)}.button,code{vertical-align:middle}.button--outline.button--active,.button--outline:active,.button--outline:hover,:root{--ifm-button-color:var(--ifm-font-color-base-inverse)}.menu__link:hover,a{transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.navbar--dark,:root{--ifm-navbar-link-hover-color:var(--ifm-color-primary)}.menu,.navbar-sidebar{overflow-x:hidden}:root,html[data-theme=dark]{--ifm-color-emphasis-500:var(--ifm-color-gray-500)}.button,.dropdown__link,.searchbox,.text--truncate{white-space:nowrap}*,.algolia-autocomplete .ds-dropdown-menu *,.searchbox,.searchbox__input{box-sizing:border-box}.searchbox__reset:focus,.searchbox__submit:focus,body:not(.navigation-with-keyboard) :not(input):focus{outline:0}pre,table{overflow:auto}.markdown li,body{word-wrap:break-word}.toggleButton_gllP,html{-webkit-tap-highlight-color:transparent}.clean-list,.containsTaskList_mC6p,.details_lb9f>summary,.dropdown__menu,.menu__list{list-style:none}:root{--ifm-color-scheme:light;--ifm-dark-value:10%;--ifm-darker-value:15%;--ifm-darkest-value:30%;--ifm-light-value:15%;--ifm-lighter-value:30%;--ifm-lightest-value:50%;--ifm-contrast-background-value:90%;--ifm-contrast-foreground-value:70%;--ifm-contrast-background-dark-value:70%;--ifm-contrast-foreground-dark-value:90%;--ifm-color-primary:#3578e5;--ifm-color-secondary:#ebedf0;--ifm-color-success:#00a400;--ifm-color-info:#54c7ec;--ifm-color-warning:#ffba00;--ifm-color-danger:#fa383e;--ifm-color-primary-dark:#306cce;--ifm-color-primary-darker:#2d66c3;--ifm-color-primary-darkest:#2554a0;--ifm-color-primary-light:#538ce9;--ifm-color-primary-lighter:#72a1ed;--ifm-color-primary-lightest:#9abcf2;--ifm-color-primary-contrast-background:#ebf2fc;--ifm-color-primary-contrast-foreground:#102445;--ifm-color-secondary-dark:#d4d5d8;--ifm-color-secondary-darker:#c8c9cc;--ifm-color-secondary-darkest:#a4a6a8;--ifm-color-secondary-light:#eef0f2;--ifm-color-secondary-lighter:#f1f2f5;--ifm-color-secondary-lightest:#f5f6f8;--ifm-color-secondary-contrast-background:#fdfdfe;--ifm-color-secondary-contrast-foreground:#474748;--ifm-color-success-dark:#009400;--ifm-color-success-darker:#008b00;--ifm-color-success-darkest:#007300;--ifm-color-success-light:#26b226;--ifm-color-success-lighter:#4dbf4d;--ifm-color-success-lightest:#80d280;--ifm-color-success-contrast-background:#e6f6e6;--ifm-color-success-contrast-foreground:#003100;--ifm-color-info-dark:#4cb3d4;--ifm-color-info-darker:#47a9c9;--ifm-color-info-darkest:#3b8ba5;--ifm-color-info-light:#6ecfef;--ifm-color-info-lighter:#87d8f2;--ifm-color-info-lightest:#aae3f6;--ifm-color-info-contrast-background:#eef9fd;--ifm-color-info-contrast-foreground:#193c47;--ifm-color-warning-dark:#e6a700;--ifm-color-warning-darker:#d99e00;--ifm-color-warning-darkest:#b38200;--ifm-color-warning-light:#ffc426;--ifm-color-warning-lighter:#ffcf4d;--ifm-color-warning-lightest:#ffdd80;--ifm-color-warning-contrast-background:#fff8e6;--ifm-color-warning-contrast-foreground:#4d3800;--ifm-color-danger-dark:#e13238;--ifm-color-danger-darker:#d53035;--ifm-color-danger-darkest:#af272b;--ifm-color-danger-light:#fb565b;--ifm-color-danger-lighter:#fb7478;--ifm-color-danger-lightest:#fd9c9f;--ifm-color-danger-contrast-background:#ffebec;--ifm-color-danger-contrast-foreground:#4b1113;--ifm-color-white:#fff;--ifm-color-black:#000;--ifm-color-gray-0:var(--ifm-color-white);--ifm-color-gray-100:#f5f6f7;--ifm-color-gray-200:#ebedf0;--ifm-color-gray-300:#dadde1;--ifm-color-gray-400:#ccd0d5;--ifm-color-gray-500:#bec3c9;--ifm-color-gray-600:#8d949e;--ifm-color-gray-700:#606770;--ifm-color-gray-800:#444950;--ifm-color-gray-900:#1c1e21;--ifm-color-gray-1000:var(--ifm-color-black);--ifm-color-emphasis-0:var(--ifm-color-gray-0);--ifm-color-emphasis-100:var(--ifm-color-gray-100);--ifm-color-emphasis-200:var(--ifm-color-gray-200);--ifm-color-emphasis-300:var(--ifm-color-gray-300);--ifm-color-emphasis-400:var(--ifm-color-gray-400);--ifm-color-emphasis-600:var(--ifm-color-gray-600);--ifm-color-emphasis-700:var(--ifm-color-gray-700);--ifm-color-emphasis-800:var(--ifm-color-gray-800);--ifm-color-emphasis-900:var(--ifm-color-gray-900);--ifm-color-emphasis-1000:var(--ifm-color-gray-1000);--ifm-color-content:var(--ifm-color-emphasis-900);--ifm-color-content-inverse:var(--ifm-color-emphasis-0);--ifm-color-content-secondary:#525860;--ifm-background-color:#0000;--ifm-background-surface-color:var(--ifm-color-content-inverse);--ifm-global-border-width:1px;--ifm-global-radius:0.4rem;--ifm-hover-overlay:#0000000d;--ifm-font-color-base:var(--ifm-color-content);--ifm-font-color-base-inverse:var(--ifm-color-content-inverse);--ifm-font-color-secondary:var(--ifm-color-content-secondary);--ifm-font-family-base:system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";--ifm-font-family-monospace:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;--ifm-font-size-base:100%;--ifm-font-weight-light:300;--ifm-font-weight-normal:400;--ifm-font-weight-semibold:500;--ifm-font-weight-bold:700;--ifm-font-weight-base:var(--ifm-font-weight-normal);--ifm-line-height-base:1.65;--ifm-global-spacing:1rem;--ifm-spacing-vertical:var(--ifm-global-spacing);--ifm-spacing-horizontal:var(--ifm-global-spacing);--ifm-transition-fast:200ms;--ifm-transition-slow:400ms;--ifm-transition-timing-default:cubic-bezier(0.08,0.52,0.52,1);--ifm-global-shadow-lw:0 1px 2px 0 #0000001a;--ifm-global-shadow-md:0 5px 40px #0003;--ifm-global-shadow-tl:0 12px 28px 0 #0003,0 2px 4px 0 #0000001a;--ifm-z-index-dropdown:100;--ifm-z-index-fixed:200;--ifm-z-index-overlay:400;--ifm-container-width:1140px;--ifm-container-width-xl:1320px;--ifm-code-background:#f6f7f8;--ifm-code-border-radius:var(--ifm-global-radius);--ifm-code-font-size:90%;--ifm-code-padding-horizontal:0.1rem;--ifm-code-padding-vertical:0.1rem;--ifm-pre-background:var(--ifm-code-background);--ifm-pre-border-radius:var(--ifm-code-border-radius);--ifm-pre-color:inherit;--ifm-pre-line-height:1.45;--ifm-pre-padding:1rem;--ifm-heading-color:inherit;--ifm-heading-margin-top:0;--ifm-heading-margin-bottom:var(--ifm-spacing-vertical);--ifm-heading-font-family:var(--ifm-font-family-base);--ifm-heading-font-weight:var(--ifm-font-weight-bold);--ifm-heading-line-height:1.25;--ifm-h1-font-size:2rem;--ifm-h2-font-size:1.5rem;--ifm-h3-font-size:1.25rem;--ifm-h4-font-size:1rem;--ifm-h5-font-size:0.875rem;--ifm-h6-font-size:0.85rem;--ifm-image-alignment-padding:1.25rem;--ifm-leading-desktop:1.25;--ifm-leading:calc(var(--ifm-leading-desktop)*1rem);--ifm-list-left-padding:2rem;--ifm-list-margin:1rem;--ifm-list-item-margin:0.25rem;--ifm-list-paragraph-margin:1rem;--ifm-table-cell-padding:0.75rem;--ifm-table-background:#0000;--ifm-table-stripe-background:#00000008;--ifm-table-border-width:1px;--ifm-table-border-color:var(--ifm-color-emphasis-300);--ifm-table-head-background:inherit;--ifm-table-head-color:inherit;--ifm-table-head-font-weight:var(--ifm-font-weight-bold);--ifm-table-cell-color:inherit;--ifm-link-color:var(--ifm-color-primary);--ifm-link-decoration:none;--ifm-link-hover-color:var(--ifm-link-color);--ifm-link-hover-decoration:underline;--ifm-paragraph-margin-bottom:var(--ifm-leading);--ifm-blockquote-font-size:var(--ifm-font-size-base);--ifm-blockquote-border-left-width:2px;--ifm-blockquote-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-blockquote-padding-vertical:0;--ifm-blockquote-shadow:none;--ifm-blockquote-color:var(--ifm-color-emphasis-800);--ifm-blockquote-border-color:var(--ifm-color-emphasis-300);--ifm-hr-background-color:var(--ifm-color-emphasis-500);--ifm-hr-height:1px;--ifm-hr-margin-vertical:1.5rem;--ifm-scrollbar-size:7px;--ifm-scrollbar-track-background-color:#f1f1f1;--ifm-scrollbar-thumb-background-color:silver;--ifm-scrollbar-thumb-hover-background-color:#a7a7a7;--ifm-alert-background-color:inherit;--ifm-alert-border-color:inherit;--ifm-alert-border-radius:var(--ifm-global-radius);--ifm-alert-border-width:0px;--ifm-alert-border-left-width:5px;--ifm-alert-color:var(--ifm-font-color-base);--ifm-alert-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-alert-padding-vertical:var(--ifm-spacing-vertical);--ifm-alert-shadow:var(--ifm-global-shadow-lw);--ifm-avatar-intro-margin:1rem;--ifm-avatar-intro-alignment:inherit;--ifm-avatar-photo-size:3rem;--ifm-badge-background-color:inherit;--ifm-badge-border-color:inherit;--ifm-badge-border-radius:var(--ifm-global-radius);--ifm-badge-border-width:var(--ifm-global-border-width);--ifm-badge-color:var(--ifm-color-white);--ifm-badge-padding-horizontal:calc(var(--ifm-spacing-horizontal)*0.5);--ifm-badge-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-breadcrumb-border-radius:1.5rem;--ifm-breadcrumb-spacing:0.5rem;--ifm-breadcrumb-color-active:var(--ifm-color-primary);--ifm-breadcrumb-item-background-active:var(--ifm-hover-overlay);--ifm-breadcrumb-padding-horizontal:0.8rem;--ifm-breadcrumb-padding-vertical:0.4rem;--ifm-breadcrumb-size-multiplier:1;--ifm-breadcrumb-separator:url('data:image/svg+xml;utf8,');--ifm-breadcrumb-separator-filter:none;--ifm-breadcrumb-separator-size:0.5rem;--ifm-breadcrumb-separator-size-multiplier:1.25;--ifm-button-background-color:inherit;--ifm-button-border-color:var(--ifm-button-background-color);--ifm-button-border-width:var(--ifm-global-border-width);--ifm-button-font-weight:var(--ifm-font-weight-bold);--ifm-button-padding-horizontal:1.5rem;--ifm-button-padding-vertical:0.375rem;--ifm-button-size-multiplier:1;--ifm-button-transition-duration:var(--ifm-transition-fast);--ifm-button-border-radius:calc(var(--ifm-global-radius)*var(--ifm-button-size-multiplier));--ifm-button-group-spacing:2px;--ifm-card-background-color:var(--ifm-background-surface-color);--ifm-card-border-radius:calc(var(--ifm-global-radius)*2);--ifm-card-horizontal-spacing:var(--ifm-global-spacing);--ifm-card-vertical-spacing:var(--ifm-global-spacing);--ifm-toc-border-color:var(--ifm-color-emphasis-300);--ifm-toc-link-color:var(--ifm-color-content-secondary);--ifm-toc-padding-vertical:0.5rem;--ifm-toc-padding-horizontal:0.5rem;--ifm-dropdown-background-color:var(--ifm-background-surface-color);--ifm-dropdown-font-weight:var(--ifm-font-weight-semibold);--ifm-dropdown-link-color:var(--ifm-font-color-base);--ifm-dropdown-hover-background-color:var(--ifm-hover-overlay);--ifm-footer-background-color:var(--ifm-color-emphasis-100);--ifm-footer-color:inherit;--ifm-footer-link-color:var(--ifm-color-emphasis-700);--ifm-footer-link-hover-color:var(--ifm-color-primary);--ifm-footer-link-horizontal-spacing:0.5rem;--ifm-footer-padding-horizontal:calc(var(--ifm-spacing-horizontal)*2);--ifm-footer-padding-vertical:calc(var(--ifm-spacing-vertical)*2);--ifm-footer-title-color:inherit;--ifm-footer-logo-max-width:min(30rem,90vw);--ifm-hero-background-color:var(--ifm-background-surface-color);--ifm-hero-text-color:var(--ifm-color-emphasis-800);--ifm-menu-color:var(--ifm-color-emphasis-700);--ifm-menu-color-active:var(--ifm-color-primary);--ifm-menu-color-background-active:var(--ifm-hover-overlay);--ifm-menu-color-background-hover:var(--ifm-hover-overlay);--ifm-menu-link-padding-horizontal:0.75rem;--ifm-menu-link-padding-vertical:0.375rem;--ifm-menu-link-sublist-icon:url('data:image/svg+xml;utf8,');--ifm-menu-link-sublist-icon-filter:none;--ifm-navbar-background-color:var(--ifm-background-surface-color);--ifm-navbar-height:3.75rem;--ifm-navbar-item-padding-horizontal:0.75rem;--ifm-navbar-item-padding-vertical:0.25rem;--ifm-navbar-link-color:var(--ifm-font-color-base);--ifm-navbar-link-active-color:var(--ifm-link-color);--ifm-navbar-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-navbar-padding-vertical:calc(var(--ifm-spacing-vertical)*0.5);--ifm-navbar-shadow:var(--ifm-global-shadow-lw);--ifm-navbar-search-input-background-color:var(--ifm-color-emphasis-200);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-800);--ifm-navbar-search-input-placeholder-color:var(--ifm-color-emphasis-500);--ifm-navbar-search-input-icon:url('data:image/svg+xml;utf8,');--ifm-navbar-sidebar-width:83vw;--ifm-pagination-border-radius:var(--ifm-global-radius);--ifm-pagination-color-active:var(--ifm-color-primary);--ifm-pagination-font-size:1rem;--ifm-pagination-item-active-background:var(--ifm-hover-overlay);--ifm-pagination-page-spacing:0.2em;--ifm-pagination-padding-horizontal:calc(var(--ifm-spacing-horizontal)*1);--ifm-pagination-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-pagination-nav-border-radius:var(--ifm-global-radius);--ifm-pagination-nav-color-hover:var(--ifm-color-primary);--ifm-pills-color-active:var(--ifm-color-primary);--ifm-pills-color-background-active:var(--ifm-hover-overlay);--ifm-pills-spacing:0.125rem;--ifm-tabs-color:var(--ifm-font-color-secondary);--ifm-tabs-color-active:var(--ifm-color-primary);--ifm-tabs-color-active-border:var(--ifm-tabs-color-active);--ifm-tabs-padding-horizontal:1rem;--ifm-tabs-padding-vertical:1rem;--docusaurus-progress-bar-color:var(--ifm-color-primary);--ifm-color-primary:#2453ff;--ifm-color-primary-dark:#2453ff;--ifm-color-primary-darker:#2453ff;--ifm-color-primary-darkest:#2453ff;--ifm-color-primary-light:#2453ff;--ifm-color-primary-lighter:#2453ff;--ifm-color-primary-lightest:#2453ff;--ifm-code-font-size:95%;--docusaurus-highlighted-code-line-bg:#0000001a;--docusaurus-tag-list-border:var(--ifm-color-emphasis-300);--docusaurus-announcement-bar-height:auto;--docusaurus-collapse-button-bg:#0000;--docusaurus-collapse-button-bg-hover:#0000001a;--doc-sidebar-width:300px;--doc-sidebar-hidden-width:30px}.badge--danger,.badge--info,.badge--primary,.badge--secondary,.badge--success,.badge--warning{--ifm-badge-border-color:var(--ifm-badge-background-color)}.button--link,.button--outline{--ifm-button-background-color:#0000}html{background-color:var(--ifm-background-color);color:var(--ifm-font-color-base);color-scheme:var(--ifm-color-scheme);font:var(--ifm-font-size-base)/var(--ifm-line-height-base) var(--ifm-font-family-base);-webkit-font-smoothing:antialiased;text-rendering:optimizelegibility;-webkit-text-size-adjust:100%;text-size-adjust:100%}iframe{border:0;color-scheme:auto}.container{margin:0 auto;max-width:var(--ifm-container-width)}.container--fluid{max-width:inherit}.row{display:flex;flex-wrap:wrap;margin:0 calc(var(--ifm-spacing-horizontal)*-1)}.margin-bottom--none,.margin-vert--none,.markdown>:last-child{margin-bottom:0!important}.margin-top--none,.margin-vert--none{margin-top:0!important}.row--no-gutters{margin-left:0;margin-right:0}.margin-horiz--none,.margin-right--none{margin-right:0!important}.row--no-gutters>.col{padding-left:0;padding-right:0}.row--align-top{align-items:flex-start}.row--align-bottom{align-items:flex-end}.menuExternalLink_NmtK,.row--align-center{align-items:center}.row--align-stretch{align-items:stretch}.row--align-baseline{align-items:baseline}.col{--ifm-col-width:100%;flex:1 0;margin-left:0;max-width:var(--ifm-col-width)}.padding-bottom--none,.padding-vert--none{padding-bottom:0!important}.padding-top--none,.padding-vert--none{padding-top:0!important}.padding-horiz--none,.padding-left--none{padding-left:0!important}.padding-horiz--none,.padding-right--none{padding-right:0!important}.col[class*=col--]{flex:0 0 var(--ifm-col-width)}.col--1{--ifm-col-width:8.33333%}.col--offset-1{margin-left:8.33333%}.col--2{--ifm-col-width:16.66667%}.col--offset-2{margin-left:16.66667%}.col--3{--ifm-col-width:25%}.col--offset-3{margin-left:25%}.col--4{--ifm-col-width:33.33333%}.col--offset-4{margin-left:33.33333%}.col--5{--ifm-col-width:41.66667%}.col--offset-5{margin-left:41.66667%}.col--6{--ifm-col-width:50%}.col--offset-6{margin-left:50%}.col--7{--ifm-col-width:58.33333%}.col--offset-7{margin-left:58.33333%}.col--8{--ifm-col-width:66.66667%}.col--offset-8{margin-left:66.66667%}.col--9{--ifm-col-width:75%}.col--offset-9{margin-left:75%}.col--10{--ifm-col-width:83.33333%}.col--offset-10{margin-left:83.33333%}.col--11{--ifm-col-width:91.66667%}.col--offset-11{margin-left:91.66667%}.col--12{--ifm-col-width:100%}.col--offset-12{margin-left:100%}.margin-horiz--none,.margin-left--none{margin-left:0!important}.margin--none{margin:0!important}.margin-bottom--xs,.margin-vert--xs{margin-bottom:.25rem!important}.margin-top--xs,.margin-vert--xs{margin-top:.25rem!important}.margin-horiz--xs,.margin-left--xs{margin-left:.25rem!important}.margin-horiz--xs,.margin-right--xs{margin-right:.25rem!important}.margin--xs{margin:.25rem!important}.margin-bottom--sm,.margin-vert--sm{margin-bottom:.5rem!important}.margin-top--sm,.margin-vert--sm{margin-top:.5rem!important}.margin-horiz--sm,.margin-left--sm{margin-left:.5rem!important}.margin-horiz--sm,.margin-right--sm{margin-right:.5rem!important}.margin--sm{margin:.5rem!important}.margin-bottom--md,.margin-vert--md{margin-bottom:1rem!important}.margin-top--md,.margin-vert--md{margin-top:1rem!important}.margin-horiz--md,.margin-left--md{margin-left:1rem!important}.margin-horiz--md,.margin-right--md{margin-right:1rem!important}.margin--md{margin:1rem!important}.margin-bottom--lg,.margin-vert--lg{margin-bottom:2rem!important}.margin-top--lg,.margin-vert--lg{margin-top:2rem!important}.margin-horiz--lg,.margin-left--lg{margin-left:2rem!important}.margin-horiz--lg,.margin-right--lg{margin-right:2rem!important}.margin--lg{margin:2rem!important}.margin-bottom--xl,.margin-vert--xl{margin-bottom:5rem!important}.margin-top--xl,.margin-vert--xl{margin-top:5rem!important}.margin-horiz--xl,.margin-left--xl{margin-left:5rem!important}.margin-horiz--xl,.margin-right--xl{margin-right:5rem!important}.margin--xl{margin:5rem!important}.padding--none{padding:0!important}.padding-bottom--xs,.padding-vert--xs{padding-bottom:.25rem!important}.padding-top--xs,.padding-vert--xs{padding-top:.25rem!important}.padding-horiz--xs,.padding-left--xs{padding-left:.25rem!important}.padding-horiz--xs,.padding-right--xs{padding-right:.25rem!important}.padding--xs{padding:.25rem!important}.padding-bottom--sm,.padding-vert--sm{padding-bottom:.5rem!important}.padding-top--sm,.padding-vert--sm{padding-top:.5rem!important}.padding-horiz--sm,.padding-left--sm{padding-left:.5rem!important}.padding-horiz--sm,.padding-right--sm{padding-right:.5rem!important}.padding--sm{padding:.5rem!important}.padding-bottom--md,.padding-vert--md{padding-bottom:1rem!important}.padding-top--md,.padding-vert--md{padding-top:1rem!important}.padding-horiz--md,.padding-left--md{padding-left:1rem!important}.padding-horiz--md,.padding-right--md{padding-right:1rem!important}.padding--md{padding:1rem!important}.padding-bottom--lg,.padding-vert--lg{padding-bottom:2rem!important}.padding-top--lg,.padding-vert--lg{padding-top:2rem!important}.padding-horiz--lg,.padding-left--lg{padding-left:2rem!important}.padding-horiz--lg,.padding-right--lg{padding-right:2rem!important}.padding--lg{padding:2rem!important}.padding-bottom--xl,.padding-vert--xl{padding-bottom:5rem!important}.padding-top--xl,.padding-vert--xl{padding-top:5rem!important}.padding-horiz--xl,.padding-left--xl{padding-left:5rem!important}.padding-horiz--xl,.padding-right--xl{padding-right:5rem!important}.padding--xl{padding:5rem!important}code{background-color:var(--ifm-code-background);border:.1rem solid #0000001a;border-radius:var(--ifm-code-border-radius);font-family:var(--ifm-font-family-monospace);font-size:var(--ifm-code-font-size);padding:var(--ifm-code-padding-vertical) var(--ifm-code-padding-horizontal)}a code{color:inherit}pre{background-color:var(--ifm-pre-background);border-radius:var(--ifm-pre-border-radius);color:var(--ifm-pre-color);font:var(--ifm-code-font-size)/var(--ifm-pre-line-height) var(--ifm-font-family-monospace);padding:var(--ifm-pre-padding)}pre code{background-color:initial;border:none;font-size:100%;line-height:inherit;padding:0}kbd{background-color:var(--ifm-color-emphasis-0);border:1px solid var(--ifm-color-emphasis-400);border-radius:.2rem;box-shadow:inset 0 -1px 0 var(--ifm-color-emphasis-400);color:var(--ifm-color-emphasis-800);font:80% var(--ifm-font-family-monospace);padding:.15rem .3rem}h1,h2,h3,h4,h5,h6{color:var(--ifm-heading-color);font-family:var(--ifm-heading-font-family);font-weight:var(--ifm-heading-font-weight);line-height:var(--ifm-heading-line-height);margin:var(--ifm-heading-margin-top) 0 var(--ifm-heading-margin-bottom) 0}h1{font-size:var(--ifm-h1-font-size)}h2{font-size:var(--ifm-h2-font-size)}h3{font-size:var(--ifm-h3-font-size)}h4{font-size:var(--ifm-h4-font-size)}h5{font-size:var(--ifm-h5-font-size)}h6{font-size:var(--ifm-h6-font-size)}img{max-width:100%}img[align=right]{padding-left:var(--image-alignment-padding)}img[align=left]{padding-right:var(--image-alignment-padding)}.markdown{--ifm-h1-vertical-rhythm-top:3;--ifm-h2-vertical-rhythm-top:2;--ifm-h3-vertical-rhythm-top:1.5;--ifm-heading-vertical-rhythm-top:1.25;--ifm-h1-vertical-rhythm-bottom:1.25;--ifm-heading-vertical-rhythm-bottom:1}.markdown:after,.markdown:before{content:"";display:table}.markdown:after{clear:both}.markdown h1:first-child{--ifm-h1-font-size:3rem;margin-bottom:calc(var(--ifm-h1-vertical-rhythm-bottom)*var(--ifm-leading))}.markdown>h2{--ifm-h2-font-size:2rem;margin-top:calc(var(--ifm-h2-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h3{--ifm-h3-font-size:1.5rem;margin-top:calc(var(--ifm-h3-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h4,.markdown>h5,.markdown>h6{margin-top:calc(var(--ifm-heading-vertical-rhythm-top)*var(--ifm-leading))}.markdown>p,.markdown>pre,.markdown>ul{margin-bottom:var(--ifm-leading)}.markdown li>p{margin-top:var(--ifm-list-paragraph-margin)}.markdown li+li{margin-top:var(--ifm-list-item-margin)}ol,ul{margin:0 0 var(--ifm-list-margin);padding-left:var(--ifm-list-left-padding)}ol ol,ul ol{list-style-type:lower-roman}ol ol ol,ol ul ol,ul ol ol,ul ul ol{list-style-type:lower-alpha}table{border-collapse:collapse;display:block;margin-bottom:var(--ifm-spacing-vertical)}table thead tr{border-bottom:2px solid var(--ifm-table-border-color)}table thead,table tr:nth-child(2n){background-color:var(--ifm-table-stripe-background)}table tr{background-color:var(--ifm-table-background);border-top:var(--ifm-table-border-width) solid var(--ifm-table-border-color)}table td,table th{border:var(--ifm-table-border-width) solid var(--ifm-table-border-color);padding:var(--ifm-table-cell-padding)}table th{background-color:var(--ifm-table-head-background);color:var(--ifm-table-head-color);font-weight:var(--ifm-table-head-font-weight)}table td{color:var(--ifm-table-cell-color)}strong{font-weight:var(--ifm-font-weight-bold)}a{color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}a:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button:hover,.text--no-decoration,.text--no-decoration:hover,a:not([href]){text-decoration:none}p{margin:0 0 var(--ifm-paragraph-margin-bottom)}blockquote{border-left:var(--ifm-blockquote-border-left-width) solid var(--ifm-blockquote-border-color);box-shadow:var(--ifm-blockquote-shadow);color:var(--ifm-blockquote-color);font-size:var(--ifm-blockquote-font-size);padding:var(--ifm-blockquote-padding-vertical) var(--ifm-blockquote-padding-horizontal)}blockquote>:first-child{margin-top:0}blockquote>:last-child{margin-bottom:0}hr{background-color:var(--ifm-hr-background-color);border:0;height:var(--ifm-hr-height);margin:var(--ifm-hr-margin-vertical) 0}.shadow--lw{box-shadow:var(--ifm-global-shadow-lw)!important}.shadow--md{box-shadow:var(--ifm-global-shadow-md)!important}.shadow--tl{box-shadow:var(--ifm-global-shadow-tl)!important}.text--primary,.wordWrapButtonEnabled_EoeP .wordWrapButtonIcon_Bwma{color:var(--ifm-color-primary)}.text--secondary{color:var(--ifm-color-secondary)}.text--success{color:var(--ifm-color-success)}.text--info{color:var(--ifm-color-info)}.text--warning{color:var(--ifm-color-warning)}.text--danger{color:var(--ifm-color-danger)}.text--center{text-align:center}.text--left{text-align:left}.text--justify{text-align:justify}.text--right{text-align:right}.text--capitalize{text-transform:capitalize}.text--lowercase{text-transform:lowercase}.admonitionHeading_Gvgb,.alert__heading,.text--uppercase{text-transform:uppercase}.text--light{font-weight:var(--ifm-font-weight-light)}.text--normal{font-weight:var(--ifm-font-weight-normal)}.text--semibold{font-weight:var(--ifm-font-weight-semibold)}.text--bold{font-weight:var(--ifm-font-weight-bold)}.text--italic{font-style:italic}.text--truncate{overflow:hidden;text-overflow:ellipsis}.text--break{word-wrap:break-word!important;word-break:break-word!important}.clean-btn{background:none;border:none;color:inherit;cursor:pointer;font-family:inherit;padding:0}.alert,.alert .close{color:var(--ifm-alert-foreground-color)}.clean-list{padding-left:0}.alert--primary{--ifm-alert-background-color:var(--ifm-color-primary-contrast-background);--ifm-alert-background-color-highlight:#3578e526;--ifm-alert-foreground-color:var(--ifm-color-primary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-primary-dark)}.alert--secondary{--ifm-alert-background-color:var(--ifm-color-secondary-contrast-background);--ifm-alert-background-color-highlight:#ebedf026;--ifm-alert-foreground-color:var(--ifm-color-secondary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-secondary-dark)}.alert--success{--ifm-alert-background-color:var(--ifm-color-success-contrast-background);--ifm-alert-background-color-highlight:#00a40026;--ifm-alert-foreground-color:var(--ifm-color-success-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-success-dark)}.alert--info{--ifm-alert-background-color:var(--ifm-color-info-contrast-background);--ifm-alert-background-color-highlight:#54c7ec26;--ifm-alert-foreground-color:var(--ifm-color-info-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-info-dark)}.alert--warning{--ifm-alert-background-color:var(--ifm-color-warning-contrast-background);--ifm-alert-background-color-highlight:#ffba0026;--ifm-alert-foreground-color:var(--ifm-color-warning-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-warning-dark)}.alert--danger{--ifm-alert-background-color:var(--ifm-color-danger-contrast-background);--ifm-alert-background-color-highlight:#fa383e26;--ifm-alert-foreground-color:var(--ifm-color-danger-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-danger-dark)}.alert{--ifm-code-background:var(--ifm-alert-background-color-highlight);--ifm-link-color:var(--ifm-alert-foreground-color);--ifm-link-hover-color:var(--ifm-alert-foreground-color);--ifm-link-decoration:underline;--ifm-tabs-color:var(--ifm-alert-foreground-color);--ifm-tabs-color-active:var(--ifm-alert-foreground-color);--ifm-tabs-color-active-border:var(--ifm-alert-border-color);background-color:var(--ifm-alert-background-color);border:var(--ifm-alert-border-width) solid var(--ifm-alert-border-color);border-left-width:var(--ifm-alert-border-left-width);border-radius:var(--ifm-alert-border-radius);box-shadow:var(--ifm-alert-shadow);padding:var(--ifm-alert-padding-vertical) var(--ifm-alert-padding-horizontal)}.alert__heading{align-items:center;display:flex;font:700 var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family);margin-bottom:.5rem}.alert__icon{display:inline-flex;margin-right:.4em}.alert__icon svg{fill:var(--ifm-alert-foreground-color);stroke:var(--ifm-alert-foreground-color);stroke-width:0}.alert .close{margin:calc(var(--ifm-alert-padding-vertical)*-1) calc(var(--ifm-alert-padding-horizontal)*-1) 0 0;opacity:.75}.alert .close:focus,.alert .close:hover{opacity:1}.alert a{text-decoration-color:var(--ifm-alert-border-color)}.alert a:hover{text-decoration-thickness:2px}.avatar{column-gap:var(--ifm-avatar-intro-margin);display:flex}.avatar__photo{border-radius:50%;display:block;height:var(--ifm-avatar-photo-size);overflow:hidden;width:var(--ifm-avatar-photo-size)}.card--full-height,.navbar__logo img,body,html{height:100%}.avatar__photo--sm{--ifm-avatar-photo-size:2rem}.avatar__photo--lg{--ifm-avatar-photo-size:4rem}.avatar__photo--xl{--ifm-avatar-photo-size:6rem}.avatar__intro{display:flex;flex:1 1;flex-direction:column;justify-content:center;text-align:var(--ifm-avatar-intro-alignment)}.badge,.breadcrumbs__item,.breadcrumbs__link,.button,.dropdown>.navbar__link:after{display:inline-block}.avatar__name{font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base)}.avatar__subtitle{margin-top:.25rem}.avatar--vertical{--ifm-avatar-intro-alignment:center;--ifm-avatar-intro-margin:0.5rem;align-items:center;flex-direction:column}.badge{background-color:var(--ifm-badge-background-color);border:var(--ifm-badge-border-width) solid var(--ifm-badge-border-color);border-radius:var(--ifm-badge-border-radius);color:var(--ifm-badge-color);font-size:75%;font-weight:var(--ifm-font-weight-bold);line-height:1;padding:var(--ifm-badge-padding-vertical) var(--ifm-badge-padding-horizontal)}.badge--primary{--ifm-badge-background-color:var(--ifm-color-primary)}.badge--secondary{--ifm-badge-background-color:var(--ifm-color-secondary);color:var(--ifm-color-black)}.breadcrumbs__link,.button.button--secondary.button--outline:not(.button--active):not(:hover){color:var(--ifm-font-color-base)}.badge--success{--ifm-badge-background-color:var(--ifm-color-success)}.badge--info{--ifm-badge-background-color:var(--ifm-color-info)}.badge--warning{--ifm-badge-background-color:var(--ifm-color-warning)}.badge--danger{--ifm-badge-background-color:var(--ifm-color-danger)}.breadcrumbs{margin-bottom:0;padding-left:0}.breadcrumbs__item:not(:last-child):after{background:var(--ifm-breadcrumb-separator) center;content:" ";display:inline-block;filter:var(--ifm-breadcrumb-separator-filter);height:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier));margin:0 var(--ifm-breadcrumb-spacing);opacity:.5;width:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier))}.breadcrumbs__item--active .breadcrumbs__link{background:var(--ifm-breadcrumb-item-background-active);color:var(--ifm-breadcrumb-color-active)}.breadcrumbs__link{border-radius:var(--ifm-breadcrumb-border-radius);font-size:calc(1rem*var(--ifm-breadcrumb-size-multiplier));padding:calc(var(--ifm-breadcrumb-padding-vertical)*var(--ifm-breadcrumb-size-multiplier)) calc(var(--ifm-breadcrumb-padding-horizontal)*var(--ifm-breadcrumb-size-multiplier));transition-duration:var(--ifm-transition-fast);transition-property:background,color}.breadcrumbs__link:any-link:hover,.breadcrumbs__link:link:hover,.breadcrumbs__link:visited:hover,area[href].breadcrumbs__link:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs--sm{--ifm-breadcrumb-size-multiplier:0.8}.breadcrumbs--lg{--ifm-breadcrumb-size-multiplier:1.2}.button{background-color:var(--ifm-button-background-color);border:var(--ifm-button-border-width) solid var(--ifm-button-border-color);border-radius:var(--ifm-button-border-radius);cursor:pointer;font-size:calc(.875rem*var(--ifm-button-size-multiplier));font-weight:var(--ifm-button-font-weight);line-height:1.5;padding:calc(var(--ifm-button-padding-vertical)*var(--ifm-button-size-multiplier)) calc(var(--ifm-button-padding-horizontal)*var(--ifm-button-size-multiplier));text-align:center;transition-duration:var(--ifm-button-transition-duration);transition-property:color,background,border-color;-webkit-user-select:none;user-select:none}.button,.button:hover{color:var(--ifm-button-color)}.button--outline{--ifm-button-color:var(--ifm-button-border-color)}.button--outline:hover{--ifm-button-background-color:var(--ifm-button-border-color)}.button--link{--ifm-button-border-color:#0000;color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}.button--link.button--active,.button--link:active,.button--link:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button.disabled,.button:disabled,.button[disabled]{opacity:.65;pointer-events:none}.button--sm{--ifm-button-size-multiplier:0.8}.button--lg{--ifm-button-size-multiplier:1.35}.button--block{display:block;width:100%}.button.button--secondary{color:var(--ifm-color-gray-900)}:where(.button--primary){--ifm-button-background-color:var(--ifm-color-primary);--ifm-button-border-color:var(--ifm-color-primary)}:where(.button--primary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-primary-dark);--ifm-button-border-color:var(--ifm-color-primary-dark)}.button--primary.button--active,.button--primary:active{--ifm-button-background-color:var(--ifm-color-primary-darker);--ifm-button-border-color:var(--ifm-color-primary-darker)}:where(.button--secondary){--ifm-button-background-color:var(--ifm-color-secondary);--ifm-button-border-color:var(--ifm-color-secondary)}:where(.button--secondary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-secondary-dark);--ifm-button-border-color:var(--ifm-color-secondary-dark)}.button--secondary.button--active,.button--secondary:active{--ifm-button-background-color:var(--ifm-color-secondary-darker);--ifm-button-border-color:var(--ifm-color-secondary-darker)}:where(.button--success){--ifm-button-background-color:var(--ifm-color-success);--ifm-button-border-color:var(--ifm-color-success)}:where(.button--success):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-success-dark);--ifm-button-border-color:var(--ifm-color-success-dark)}.button--success.button--active,.button--success:active{--ifm-button-background-color:var(--ifm-color-success-darker);--ifm-button-border-color:var(--ifm-color-success-darker)}:where(.button--info){--ifm-button-background-color:var(--ifm-color-info);--ifm-button-border-color:var(--ifm-color-info)}:where(.button--info):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-info-dark);--ifm-button-border-color:var(--ifm-color-info-dark)}.button--info.button--active,.button--info:active{--ifm-button-background-color:var(--ifm-color-info-darker);--ifm-button-border-color:var(--ifm-color-info-darker)}:where(.button--warning){--ifm-button-background-color:var(--ifm-color-warning);--ifm-button-border-color:var(--ifm-color-warning)}:where(.button--warning):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-warning-dark);--ifm-button-border-color:var(--ifm-color-warning-dark)}.button--warning.button--active,.button--warning:active{--ifm-button-background-color:var(--ifm-color-warning-darker);--ifm-button-border-color:var(--ifm-color-warning-darker)}:where(.button--danger){--ifm-button-background-color:var(--ifm-color-danger);--ifm-button-border-color:var(--ifm-color-danger)}:where(.button--danger):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-danger-dark);--ifm-button-border-color:var(--ifm-color-danger-dark)}.button--danger.button--active,.button--danger:active{--ifm-button-background-color:var(--ifm-color-danger-darker);--ifm-button-border-color:var(--ifm-color-danger-darker)}.button-group{display:inline-flex;gap:var(--ifm-button-group-spacing)}.button-group>.button:not(:first-child){border-bottom-left-radius:0;border-top-left-radius:0}.button-group>.button:not(:last-child){border-bottom-right-radius:0;border-top-right-radius:0}.button-group--block{display:flex;justify-content:stretch}.button-group--block>.button{flex-grow:1}.card{background-color:var(--ifm-card-background-color);border-radius:var(--ifm-card-border-radius);box-shadow:var(--ifm-global-shadow-lw);display:flex;flex-direction:column;overflow:hidden}.card__image{padding-top:var(--ifm-card-vertical-spacing)}.card__image:first-child{padding-top:0}.card__body,.card__footer,.card__header{padding:var(--ifm-card-vertical-spacing) var(--ifm-card-horizontal-spacing)}.card__body:not(:last-child),.card__footer:not(:last-child),.card__header:not(:last-child){padding-bottom:0}.card__body>:last-child,.card__footer>:last-child,.card__header>:last-child{margin-bottom:0}.card__footer{margin-top:auto}.table-of-contents{font-size:.8rem;margin-bottom:0;padding:var(--ifm-toc-padding-vertical) 0}.table-of-contents,.table-of-contents ul{list-style:none;padding-left:var(--ifm-toc-padding-horizontal)}.table-of-contents li{margin:var(--ifm-toc-padding-vertical) var(--ifm-toc-padding-horizontal)}.table-of-contents__left-border{border-left:1px solid var(--ifm-toc-border-color)}.table-of-contents__link{color:var(--ifm-toc-link-color);display:block}.table-of-contents__link--active,.table-of-contents__link--active code,.table-of-contents__link:hover,.table-of-contents__link:hover code{color:var(--ifm-color-primary);text-decoration:none}.close{color:var(--ifm-color-black);float:right;font-size:1.5rem;font-weight:var(--ifm-font-weight-bold);line-height:1;opacity:.5;padding:1rem;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.close:hover{opacity:.7}.close:focus,.theme-code-block-highlighted-line .codeLineNumber_Tfdd:before{opacity:.8}.dropdown{display:inline-flex;font-weight:var(--ifm-dropdown-font-weight);position:relative;vertical-align:top}.dropdown--hoverable:hover .dropdown__menu,.dropdown--show .dropdown__menu{opacity:1;pointer-events:all;transform:translateY(-1px);visibility:visible}#nprogress,.dropdown__menu,.navbar__item.dropdown .navbar__link:not([href]){pointer-events:none}.dropdown--right .dropdown__menu{left:inherit;right:0}.dropdown--nocaret .navbar__link:after{content:none!important}.dropdown__menu{background-color:var(--ifm-dropdown-background-color);border-radius:var(--ifm-global-radius);box-shadow:var(--ifm-global-shadow-md);left:0;max-height:80vh;min-width:10rem;opacity:0;overflow-y:auto;padding:.5rem;position:absolute;top:calc(100% - var(--ifm-navbar-item-padding-vertical) + .3rem);transform:translateY(-.625rem);transition-duration:var(--ifm-transition-fast);transition-property:opacity,transform,visibility;transition-timing-function:var(--ifm-transition-timing-default);visibility:hidden;z-index:var(--ifm-z-index-dropdown)}.menu__caret,.menu__link,.menu__list-item-collapsible{border-radius:.25rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.dropdown__link{border-radius:.25rem;color:var(--ifm-dropdown-link-color);display:block;font-size:.875rem;margin-top:.2rem;padding:.25rem .5rem}.dropdown__link--active,.dropdown__link:hover{background-color:var(--ifm-dropdown-hover-background-color);color:var(--ifm-dropdown-link-color);text-decoration:none}.dropdown__link--active,.dropdown__link--active:hover{--ifm-dropdown-link-color:var(--ifm-link-color)}.dropdown>.navbar__link:after{border-color:currentcolor #0000;border-style:solid;border-width:.4em .4em 0;content:"";margin-left:.3em;position:relative;top:2px;transform:translateY(-50%)}.footer{background-color:var(--ifm-footer-background-color);color:var(--ifm-footer-color);padding:var(--ifm-footer-padding-vertical) var(--ifm-footer-padding-horizontal)}.footer--dark{--ifm-footer-background-color:#303846;--ifm-footer-color:var(--ifm-footer-link-color);--ifm-footer-link-color:var(--ifm-color-secondary);--ifm-footer-title-color:var(--ifm-color-white)}.footer__links{margin-bottom:1rem}.footer__link-item{color:var(--ifm-footer-link-color);line-height:2}.footer__link-item:hover{color:var(--ifm-footer-link-hover-color)}.footer__link-separator{margin:0 var(--ifm-footer-link-horizontal-spacing)}.footer__logo{margin-top:1rem;max-width:var(--ifm-footer-logo-max-width)}.footer__title{color:var(--ifm-footer-title-color);font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base);margin-bottom:var(--ifm-heading-margin-bottom)}.menu,.navbar__link{font-weight:var(--ifm-font-weight-semibold)}.nasa,.nasa-black,.nasa-red{font-family:nasalization}.docItemContainer_Djhp article>:first-child,.docItemContainer_Djhp header+*,.footer__item{margin-top:0}.admonitionContent_BuS1>:last-child,.collapsibleContent_i85q p:last-child,.details_lb9f>summary>p:last-child,.footer__items{margin-bottom:0}.codeBlockStandalone_MEMb,[type=checkbox]{padding:0}.hero{align-items:center;background-color:var(--ifm-hero-background-color);color:var(--ifm-hero-text-color);display:flex;padding:4rem 2rem}.hero--primary{--ifm-hero-background-color:var(--ifm-color-primary);--ifm-hero-text-color:var(--ifm-font-color-base-inverse)}.hero--dark{--ifm-hero-background-color:#303846;--ifm-hero-text-color:var(--ifm-color-white)}.hero__title{font-size:3rem}.hero__subtitle{font-size:1.5rem}.menu__list{margin:0;padding-left:0}.menu__caret,.menu__link{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu__list .menu__list{flex:0 0 100%;margin-top:.25rem;padding-left:var(--ifm-menu-link-padding-horizontal)}.menu__list-item:not(:first-child){margin-top:.25rem}.menu__list-item--collapsed .menu__list{height:0;overflow:hidden}.details_lb9f[data-collapsed=false].isBrowser_bmU9>summary:before,.details_lb9f[open]:not(.isBrowser_bmU9)>summary:before,.menu__list-item--collapsed .menu__caret:before,.menu__list-item--collapsed .menu__link--sublist:after{transform:rotate(90deg)}.menu__list-item-collapsible{display:flex;flex-wrap:wrap;position:relative}.menu__caret:hover,.menu__link:hover,.menu__list-item-collapsible--active,.menu__list-item-collapsible:hover{background:var(--ifm-menu-color-background-hover)}.menu__list-item-collapsible .menu__link--active,.menu__list-item-collapsible .menu__link:hover{background:none!important}.menu__caret,.menu__link{align-items:center;display:flex}.navbar-sidebar,.navbar-sidebar__backdrop{bottom:0;opacity:0;top:0;transition-duration:var(--ifm-transition-fast);transition-timing-function:ease-in-out;visibility:hidden;left:0}.menu__link{color:var(--ifm-menu-color);flex:1;line-height:1.25}.menu__link:hover{color:var(--ifm-menu-color);text-decoration:none}.menu__caret:before,.menu__link--sublist-caret:after{height:1.25rem;transform:rotate(180deg);transition:transform var(--ifm-transition-fast) linear;width:1.25rem;content:"";filter:var(--ifm-menu-link-sublist-icon-filter)}.menu__link--sublist-caret:after{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem;margin-left:auto;min-width:1.25rem}.menu__link--active,.menu__link--active:hover{color:var(--ifm-menu-color-active)}.navbar__brand,.navbar__link{color:var(--ifm-navbar-link-color)}.menu__link--active:not(.menu__link--sublist){background-color:var(--ifm-menu-color-background-active)}.menu__caret:before{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem}.navbar--dark,html[data-theme=dark]{--ifm-menu-link-sublist-icon-filter:invert(100%) sepia(94%) saturate(17%) hue-rotate(223deg) brightness(104%) contrast(98%)}.navbar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-navbar-shadow);height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.navbar,.navbar>.container,.navbar>.container-fluid{display:flex}.navbar--fixed-top{position:sticky;top:0;z-index:var(--ifm-z-index-fixed)}.navbar__inner{display:flex;flex-wrap:wrap;justify-content:space-between;width:100%}.navbar__brand{align-items:center;display:flex;margin-right:1rem;min-width:0}.navbar__brand:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.announcementBarContent_xLdY,.navbar__title{flex:1 1 auto}.navbar__toggle{display:none;margin-right:.5rem}.navbar__logo{flex:0 0 auto;height:2rem;margin-right:.5rem}.navbar__items{align-items:center;display:flex;flex:1;min-width:0}.navbar__items--center{flex:0 0 auto}.navbar__items--center .navbar__brand{margin:0}.navbar__items--center+.navbar__items--right{flex:1}.navbar__items--right{flex:0 0 auto;justify-content:flex-end}.navbar__items--right>:last-child{padding-right:0}.navbar__item{display:inline-block;padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.navbar__link--active,.navbar__link:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.navbar--dark,.navbar--primary{--ifm-menu-color:var(--ifm-color-gray-300);--ifm-navbar-link-color:var(--ifm-color-gray-100);--ifm-navbar-search-input-background-color:#ffffff1a;--ifm-navbar-search-input-placeholder-color:#ffffff80;color:var(--ifm-color-white)}.navbar--dark{--ifm-navbar-background-color:#242526;--ifm-menu-color-background-active:#ffffff0d;--ifm-navbar-search-input-color:var(--ifm-color-white)}.navbar--primary{--ifm-navbar-background-color:var(--ifm-color-primary);--ifm-navbar-link-hover-color:var(--ifm-color-white);--ifm-menu-color-active:var(--ifm-color-white);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-500)}.navbar__search-input{appearance:none;background:var(--ifm-navbar-search-input-background-color) var(--ifm-navbar-search-input-icon) no-repeat .75rem center/1rem 1rem;border:none;border-radius:2rem;color:var(--ifm-navbar-search-input-color);cursor:text;display:inline-block;font-size:.9rem;height:2rem;padding:0 .5rem 0 2.25rem;width:12.5rem}.navbar__search-input::placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar-sidebar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-global-shadow-md);position:fixed;transform:translate3d(-100%,0,0);transition-property:opacity,visibility,transform;width:var(--ifm-navbar-sidebar-width)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar__items{transform:translateZ(0)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar--show .navbar-sidebar__backdrop{opacity:1;visibility:visible}.navbar-sidebar__backdrop{background-color:#0009;position:fixed;right:0;transition-property:opacity,visibility}.navbar-sidebar__brand{align-items:center;box-shadow:var(--ifm-navbar-shadow);display:flex;flex:1;height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.navbar-sidebar__items{display:flex;height:calc(100% - var(--ifm-navbar-height));transition:transform var(--ifm-transition-fast) ease-in-out}.navbar-sidebar__items--show-secondary{transform:translate3d(calc((var(--ifm-navbar-sidebar-width))*-1),0,0)}.navbar-sidebar__item{flex-shrink:0;padding:.5rem;width:calc(var(--ifm-navbar-sidebar-width))}.navbar-sidebar__back{background:var(--ifm-menu-color-background-active);font-size:15px;font-weight:var(--ifm-button-font-weight);margin:0 0 .2rem -.5rem;padding:.6rem 1.5rem;position:relative;text-align:left;top:-.5rem;width:calc(100% + 1rem)}.navbar-sidebar__close{display:flex;margin-left:auto}.pagination{column-gap:var(--ifm-pagination-page-spacing);display:flex;font-size:var(--ifm-pagination-font-size);padding-left:0}.pagination--sm{--ifm-pagination-font-size:0.8rem;--ifm-pagination-padding-horizontal:0.8rem;--ifm-pagination-padding-vertical:0.2rem}.pagination--lg{--ifm-pagination-font-size:1.2rem;--ifm-pagination-padding-horizontal:1.2rem;--ifm-pagination-padding-vertical:0.3rem}.pagination__item{display:inline-flex}.pagination__item>span{padding:var(--ifm-pagination-padding-vertical)}.pagination__item--active .pagination__link{color:var(--ifm-pagination-color-active)}.pagination__item--active .pagination__link,.pagination__item:not(.pagination__item--active):hover .pagination__link{background:var(--ifm-pagination-item-active-background)}.pagination__item--disabled,.pagination__item[disabled]{opacity:.25;pointer-events:none}.pagination__link{border-radius:var(--ifm-pagination-border-radius);color:var(--ifm-font-color-base);display:inline-block;padding:var(--ifm-pagination-padding-vertical) var(--ifm-pagination-padding-horizontal);transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination__link:hover{text-decoration:none}.pagination-nav{display:grid;grid-gap:var(--ifm-spacing-horizontal);gap:var(--ifm-spacing-horizontal);grid-template-columns:repeat(2,1fr)}.pagination-nav__link{border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-pagination-nav-border-radius);display:block;height:100%;line-height:var(--ifm-heading-line-height);padding:var(--ifm-global-spacing);transition:border-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination-nav__link:hover{border-color:var(--ifm-pagination-nav-color-hover);text-decoration:none}.pagination-nav__link--next{grid-column:2/3;text-align:right}.pagination-nav__label{font-size:var(--ifm-h4-font-size);font-weight:var(--ifm-heading-font-weight);word-break:break-word}.pagination-nav__link--prev .pagination-nav__label:before{content:"« "}.pagination-nav__link--next .pagination-nav__label:after{content:" »"}.pagination-nav__sublabel{color:var(--ifm-color-content-secondary);font-size:var(--ifm-h5-font-size);font-weight:var(--ifm-font-weight-semibold);margin-bottom:.25rem}.pills__item,.tabs{font-weight:var(--ifm-font-weight-bold)}.pills{display:flex;gap:var(--ifm-pills-spacing);padding-left:0}.pills__item{border-radius:.5rem;cursor:pointer;display:inline-block;padding:.25rem 1rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pills__item--active{color:var(--ifm-pills-color-active)}.pills__item--active,.pills__item:not(.pills__item--active):hover{background:var(--ifm-pills-color-background-active)}.pills--block{justify-content:stretch}.pills--block .pills__item{flex-grow:1;text-align:center}.tabs{color:var(--ifm-tabs-color);display:flex;margin-bottom:0;overflow-x:auto;padding-left:0}.tabs__item{border-bottom:3px solid #0000;border-radius:var(--ifm-global-radius);cursor:pointer;display:inline-flex;padding:var(--ifm-tabs-padding-vertical) var(--ifm-tabs-padding-horizontal);transition:background-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.tabs__item--active{border-bottom-color:var(--ifm-tabs-color-active-border);border-bottom-left-radius:0;border-bottom-right-radius:0;color:var(--ifm-tabs-color-active)}.tabs__item:hover{background-color:var(--ifm-hover-overlay)}.tabs--block{justify-content:stretch}.tabs--block .tabs__item{flex-grow:1;justify-content:center}html[data-theme=dark]{--ifm-color-scheme:dark;--ifm-color-emphasis-0:var(--ifm-color-gray-1000);--ifm-color-emphasis-100:var(--ifm-color-gray-900);--ifm-color-emphasis-200:var(--ifm-color-gray-800);--ifm-color-emphasis-300:var(--ifm-color-gray-700);--ifm-color-emphasis-400:var(--ifm-color-gray-600);--ifm-color-emphasis-600:var(--ifm-color-gray-400);--ifm-color-emphasis-700:var(--ifm-color-gray-300);--ifm-color-emphasis-800:var(--ifm-color-gray-200);--ifm-color-emphasis-900:var(--ifm-color-gray-100);--ifm-color-emphasis-1000:var(--ifm-color-gray-0);--ifm-background-color:#1b1b1d;--ifm-background-surface-color:#242526;--ifm-hover-overlay:#ffffff0d;--ifm-color-content:#e3e3e3;--ifm-color-content-secondary:#fff;--ifm-breadcrumb-separator-filter:invert(64%) sepia(11%) saturate(0%) hue-rotate(149deg) brightness(99%) contrast(95%);--ifm-code-background:#ffffff1a;--ifm-scrollbar-track-background-color:#444;--ifm-scrollbar-thumb-background-color:#686868;--ifm-scrollbar-thumb-hover-background-color:#7a7a7a;--ifm-table-stripe-background:#ffffff12;--ifm-toc-border-color:var(--ifm-color-emphasis-200);--ifm-color-primary-contrast-background:#102445;--ifm-color-primary-contrast-foreground:#ebf2fc;--ifm-color-secondary-contrast-background:#474748;--ifm-color-secondary-contrast-foreground:#fdfdfe;--ifm-color-success-contrast-background:#003100;--ifm-color-success-contrast-foreground:#e6f6e6;--ifm-color-info-contrast-background:#193c47;--ifm-color-info-contrast-foreground:#eef9fd;--ifm-color-warning-contrast-background:#4d3800;--ifm-color-warning-contrast-foreground:#fff8e6;--ifm-color-danger-contrast-background:#4b1113;--ifm-color-danger-contrast-foreground:#ffebec}#nprogress .bar{background:var(--docusaurus-progress-bar-color);height:2px;left:0;position:fixed;top:0;width:100%;z-index:1031}#nprogress .peg{box-shadow:0 0 10px var(--docusaurus-progress-bar-color),0 0 5px var(--docusaurus-progress-bar-color);height:100%;opacity:1;position:absolute;right:0;transform:rotate(3deg) translateY(-4px);width:100px}[data-theme=dark]{--ifm-color-primary:#b2b2b3;--ifm-color-primary-dark:#a0a0a1;--ifm-color-primary-darker:#979798;--ifm-color-primary-darkest:#7c7c7e;--ifm-color-primary-light:#c4c4c5;--ifm-color-primary-lighter:#cdcdce;--ifm-color-primary-lightest:#e8e8e8}.simple-class{border:2px solid #000;border-radius:10px;color:#00f;height:1200px;padding:10px;width:1200px}.hero,.simple-class{background-image:url(/hauler-docs/assets/images/rgs-hero-bg-73cc38de749fd232a41954c4aa3ce93d.svg)}.hero{background-color:#d3d3d3;background-position:bottom;background-repeat:no-repeat}.hero__title,.nasa-black{color:#000}.hero__subtitle{color:hsla(0,3%,6%,.678)}@font-face{font-family:nasalization;src:url(/hauler-docs/assets/fonts/nasalization-4cbf2019f1f7337b2594cc91085c46b3.otf)}.nasa-red{color:red}.tag_zVej{border:1px solid var(--docusaurus-tag-list-border);transition:border var(--ifm-transition-fast)}.tag_zVej:hover{--docusaurus-tag-list-border:var(--ifm-link-color);text-decoration:none}.tagRegular_sFm0{border-radius:var(--ifm-global-radius);font-size:90%;padding:.2rem .5rem .3rem}.tagWithCount_h2kH{align-items:center;border-left:0;display:flex;padding:0 .5rem 0 1rem;position:relative}.tagWithCount_h2kH:after,.tagWithCount_h2kH:before{border:1px solid var(--docusaurus-tag-list-border);content:"";position:absolute;top:50%;transition:inherit}.tagWithCount_h2kH:before{border-bottom:0;border-right:0;height:1.18rem;right:100%;transform:translate(50%,-50%) rotate(-45deg);width:1.18rem}.tagWithCount_h2kH:after{border-radius:50%;height:.5rem;left:0;transform:translateY(-50%);width:.5rem}.tagWithCount_h2kH span{background:var(--ifm-color-secondary);border-radius:var(--ifm-global-radius);color:var(--ifm-color-black);font-size:.7rem;line-height:1.2;margin-left:.3rem;padding:.1rem .4rem}.tags_jXut{display:inline}.searchbox,.searchbox__input,.tag_QGVx{display:inline-block}.tag_QGVx{margin:0 .4rem .5rem 0}.backToTopButton_sjWU{background-color:var(--ifm-color-emphasis-200);border-radius:50%;bottom:1.3rem;box-shadow:var(--ifm-global-shadow-lw);height:3rem;opacity:0;position:fixed;right:1.3rem;transform:scale(0);transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default);visibility:hidden;width:3rem;z-index:calc(var(--ifm-z-index-fixed) - 1)}.backToTopButton_sjWU:after{background-color:var(--ifm-color-emphasis-1000);content:" ";display:inline-block;height:100%;-webkit-mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;width:100%}.backToTopButtonShow_xfvO{opacity:1;transform:scale(1);visibility:visible}.algolia-docsearch-suggestion{border-bottom-color:#3a3dd1}.algolia-docsearch-suggestion--category-header{background-color:#4b54de}.algolia-docsearch-suggestion--highlight{color:#3a33d1}.algolia-docsearch-suggestion--category-header .algolia-docsearch-suggestion--highlight{background-color:#4d47d5}.aa-cursor .algolia-docsearch-suggestion--content{color:#272296}.aa-cursor .algolia-docsearch-suggestion{background:#ebebfb}.searchbox{height:32px!important;position:relative;visibility:visible!important;width:200px}.searchbox .algolia-autocomplete{display:block;height:100%;width:100%}.searchbox__wrapper{height:100%;position:relative;width:100%;z-index:999}.searchbox__input{appearance:none;background:#fff!important;border:0;border-radius:16px;box-shadow:inset 0 0 0 1px #ccc;font-size:12px;height:100%;padding:0 26px 0 32px;transition:box-shadow .4s,background .4s;vertical-align:middle;white-space:normal;width:100%}.searchbox__reset,.searchbox__submit{font-size:inherit;-webkit-user-select:none;position:absolute}.searchbox__input::-webkit-search-cancel-button,.searchbox__input::-webkit-search-decoration,.searchbox__input::-webkit-search-results-button,.searchbox__input::-webkit-search-results-decoration{display:none}.searchbox__input:hover{box-shadow:inset 0 0 0 1px #b3b3b3}.searchbox__input:active,.searchbox__input:focus{background:#fff;box-shadow:inset 0 0 0 1px #aaa;outline:0}.searchbox__input::placeholder{color:#aaa}.searchbox__submit{background-color:#458ee100;border:0;border-radius:16px 0 0 16px;height:100%;left:0;margin:0;padding:0;right:inherit;text-align:center;top:0;user-select:none;vertical-align:middle;width:32px}.searchbox__submit:before{content:"";display:inline-block;height:100%;margin-right:-4px;vertical-align:middle}.algolia-autocomplete .ds-dropdown-menu .ds-suggestion,.dropdownNavbarItemMobile_S0Fm,.searchbox__submit:active,.searchbox__submit:hover{cursor:pointer}.searchbox__submit svg{height:14px;vertical-align:middle;width:14px;fill:#6d7e96}.searchbox__reset{background:none;border:0;cursor:pointer;display:block;margin:0;padding:0;right:8px;top:8px;user-select:none;fill:#00000080}.searchbox__reset.hide{display:none}.searchbox__reset svg{display:block;height:8px;margin:4px;width:8px}.searchbox__input:valid~.searchbox__reset{animation-duration:.15s;animation-name:a;display:block}@keyframes a{0%{opacity:0;transform:translate3d(-20%,0,0)}to{opacity:1;transform:none}}.algolia-autocomplete .ds-dropdown-menu:before{background:#373940;border-radius:2px;border-right:1px solid #373940;border-top:1px solid #373940;content:"";display:block;height:14px;position:absolute;top:-7px;transform:rotate(-45deg);width:14px;z-index:1000}.algolia-autocomplete .ds-dropdown-menu{box-shadow:0 1px 0 0 #0003,0 2px 3px 0 #0000001a}.algolia-autocomplete .ds-dropdown-menu .ds-suggestions{position:relative;z-index:1000}.algolia-autocomplete .ds-dropdown-menu [class^=ds-dataset-]{background:#fff;border-radius:4px;overflow:auto;padding:0;position:relative}.algolia-autocomplete .algolia-docsearch-suggestion{display:block;overflow:hidden;padding:0;position:relative;text-decoration:none}.algolia-autocomplete .ds-cursor .algolia-docsearch-suggestion--wrapper{background:#f1f1f1;box-shadow:inset -2px 0 0 #61dafb}.algolia-autocomplete .algolia-docsearch-suggestion--highlight{background:#ffe564;padding:.1em .05em}.algolia-autocomplete .algolia-docsearch-suggestion--category-header .algolia-docsearch-suggestion--category-header-lvl0 .algolia-docsearch-suggestion--highlight,.algolia-autocomplete .algolia-docsearch-suggestion--category-header .algolia-docsearch-suggestion--category-header-lvl1 .algolia-docsearch-suggestion--highlight{background:inherit;color:inherit}.algolia-autocomplete .algolia-docsearch-suggestion--text .algolia-docsearch-suggestion--highlight{background:inherit;box-shadow:inset 0 -2px 0 0 #458ee1cc;color:inherit;padding:0 0 1px}.algolia-autocomplete .algolia-docsearch-suggestion--content{cursor:pointer;display:block;float:right;padding:5.33333px 0 5.33333px 10.66667px;position:relative;width:70%}.algolia-autocomplete .algolia-docsearch-suggestion--content:before{background:#ececec;content:"";display:block;height:100%;left:-1px;position:absolute;top:0;width:1px}.algolia-autocomplete .algolia-docsearch-suggestion--category-header{background-color:#373940;color:#fff;display:none;font-size:14px;font-weight:700;letter-spacing:.08em;margin:0;padding:5px 8px;position:relative;text-transform:uppercase}.algolia-autocomplete .algolia-docsearch-suggestion--wrapper{background-color:#fff;float:left;padding:8px 0 0;width:100%}.algolia-autocomplete .algolia-docsearch-suggestion--subcategory-column{color:#777;display:none;float:left;font-size:.9em;padding:5.33333px 10.66667px;position:relative;text-align:right;width:30%;word-wrap:break-word}.algolia-autocomplete .algolia-docsearch-suggestion--subcategory-column:before{background:#ececec;content:"";display:block;height:100%;position:absolute;right:0;top:0;width:1px}.algolia-autocomplete .algolia-docsearch-suggestion.algolia-docsearch-suggestion__main .algolia-docsearch-suggestion--category-header,.algolia-autocomplete .algolia-docsearch-suggestion.algolia-docsearch-suggestion__secondary{display:block}.algolia-autocomplete .algolia-docsearch-suggestion--subcategory-column .algolia-docsearch-suggestion--highlight{background-color:inherit;color:inherit}.algolia-autocomplete .algolia-docsearch-suggestion--subcategory-inline{display:none}.algolia-autocomplete .algolia-docsearch-suggestion--title{color:#02060c;font-size:.9em;font-weight:700;margin-bottom:4px}.algolia-autocomplete .algolia-docsearch-suggestion--text{color:#63676d;display:block;font-size:.85em;line-height:1.2em;padding-right:2px}.algolia-autocomplete .algolia-docsearch-suggestion--version{color:#a6aab1;display:block;font-size:.65em;padding-right:2px;padding-top:2px}.algolia-autocomplete .algolia-docsearch-suggestion--no-results{background-color:#373940;font-size:1.2em;margin-top:-8px;padding:8px 0;text-align:center;width:100%}.algolia-autocomplete .algolia-docsearch-suggestion--no-results .algolia-docsearch-suggestion--text{color:#fff;margin-top:4px}#__docusaurus-base-url-issue-banner-container,.algolia-autocomplete .algolia-docsearch-suggestion--no-results:before,.docSidebarContainer_YfHR,.navbarSearchContainer_Bca1:empty,.sidebarLogo_isFc,.themedComponent_mlkZ,[data-theme=dark] .lightToggleIcon_pyhR,[data-theme=light] .darkToggleIcon_wfgR,html[data-announcement-bar-initially-dismissed=true] .announcementBar_mb4j{display:none}.algolia-autocomplete .algolia-docsearch-suggestion code{background-color:#ebebeb;border:none;border-radius:3px;color:#222;font-family:source-code-pro,Menlo,Monaco,Consolas,Courier New,monospace;font-size:90%;padding:1px 5px}.algolia-autocomplete .algolia-docsearch-suggestion code .algolia-docsearch-suggestion--highlight{background:none}.algolia-autocomplete .algolia-docsearch-suggestion.algolia-docsearch-suggestion__main .algolia-docsearch-suggestion--category-header{color:#fff;display:block}.algolia-autocomplete .algolia-docsearch-suggestion.algolia-docsearch-suggestion__secondary .algolia-docsearch-suggestion--subcategory-column,.tocCollapsibleContent_vkbj a{display:block}.algolia-autocomplete .algolia-docsearch-footer{background-color:#fff;float:right;font-size:0;height:30px;line-height:0;width:100%;z-index:2000}.algolia-autocomplete .algolia-docsearch-footer--logo{background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 130 18'%3E%3Cg fill='none' fill-rule='evenodd'%3E%3Cpath fill='url(%2523a)' d='M59.4.02h13.3a2.37 2.37 0 0 1 2.38 2.37V15.6a2.37 2.37 0 0 1-2.38 2.36H59.4a2.37 2.37 0 0 1-2.38-2.36V2.38A2.37 2.37 0 0 1 59.4.02'/%3E%3Cpath fill='%2523FFF' d='M66.26 4.56c-2.82 0-5.1 2.27-5.1 5.08 0 2.8 2.28 5.07 5.1 5.07 2.8 0 5.1-2.26 5.1-5.07 0-2.8-2.28-5.07-5.1-5.07zm0 8.65c-2 0-3.6-1.6-3.6-3.56 0-1.97 1.6-3.58 3.6-3.58 1.98 0 3.6 1.6 3.6 3.58a3.58 3.58 0 0 1-3.6 3.57zm0-6.4v2.66c0 .07.08.13.15.1l2.4-1.24c.04-.02.06-.1.03-.14a2.96 2.96 0 0 0-2.46-1.5.1.1 0 0 0-.1.1zm-3.33-1.96-.3-.3a.78.78 0 0 0-1.12 0l-.36.36a.77.77 0 0 0 0 1.1l.3.3c.05.05.13.04.17 0 .2-.25.4-.5.6-.7.23-.23.46-.43.7-.6.07-.04.07-.1.03-.16zm5-.8V3.4a.78.78 0 0 0-.78-.78h-1.83a.78.78 0 0 0-.78.78v.63c0 .07.06.12.14.1a5.7 5.7 0 0 1 1.58-.22c.52 0 1.04.07 1.54.2a.1.1 0 0 0 .13-.1z'/%3E%3Cpath fill='%2523182359' d='M102.16 13.76c0 1.46-.37 2.52-1.12 3.2-.75.67-1.9 1-3.44 1-.56 0-1.74-.1-2.67-.3l.34-1.7c.78.17 1.82.2 2.36.2.86 0 1.48-.16 1.84-.5.37-.36.55-.88.55-1.57v-.35a6 6 0 0 1-.84.3 4.2 4.2 0 0 1-1.2.17 4.5 4.5 0 0 1-1.6-.28 3.4 3.4 0 0 1-1.26-.82 3.7 3.7 0 0 1-.8-1.35c-.2-.54-.3-1.5-.3-2.2 0-.67.1-1.5.3-2.06a3.9 3.9 0 0 1 .9-1.43 4.1 4.1 0 0 1 1.45-.92 5.3 5.3 0 0 1 1.94-.37c.7 0 1.35.1 1.97.2a16 16 0 0 1 1.6.33v8.46zm-5.95-4.2c0 .9.2 1.88.6 2.3.4.4.9.62 1.53.62q.51 0 .96-.15a2.8 2.8 0 0 0 .73-.33V6.7a8.5 8.5 0 0 0-1.42-.17c-.76-.02-1.36.3-1.77.8-.4.5-.62 1.4-.62 2.23zm16.13 0c0 .72-.1 1.26-.32 1.85a4.4 4.4 0 0 1-.9 1.53c-.38.42-.85.75-1.4.98-.54.24-1.4.37-1.8.37-.43 0-1.27-.13-1.8-.36a4.1 4.1 0 0 1-1.4-.97 4.5 4.5 0 0 1-.92-1.52 5 5 0 0 1-.33-1.84c0-.72.1-1.4.32-2s.53-1.1.92-1.5c.4-.43.86-.75 1.4-.98a4.55 4.55 0 0 1 1.78-.34 4.7 4.7 0 0 1 1.8.34c.54.23 1 .55 1.4.97q.57.63.9 1.5c.23.6.35 1.3.35 2zm-2.2 0c0-.92-.2-1.7-.6-2.22-.38-.54-.94-.8-1.64-.8-.72 0-1.27.26-1.67.8s-.58 1.3-.58 2.22c0 .93.2 1.56.6 2.1.38.54.94.8 1.64.8s1.25-.26 1.65-.8c.4-.55.6-1.17.6-2.1m6.97 4.7c-3.5.02-3.5-2.8-3.5-3.27L113.57.92l2.15-.34v10c0 .25 0 1.87 1.37 1.88v1.8zm3.77 0h-2.15v-9.2l2.15-.33v9.54zM119.8 3.74c.7 0 1.3-.58 1.3-1.3 0-.7-.58-1.3-1.3-1.3-.73 0-1.3.6-1.3 1.3 0 .72.58 1.3 1.3 1.3m6.43 1c.7 0 1.3.1 1.78.27.5.18.88.42 1.17.73.28.3.5.74.6 1.18.13.46.2.95.2 1.5v5.47a25 25 0 0 1-1.5.25q-1.005.15-2.25.15a6.8 6.8 0 0 1-1.52-.16 3.2 3.2 0 0 1-1.18-.5 2.46 2.46 0 0 1-.76-.9c-.18-.37-.27-.9-.27-1.44 0-.52.1-.85.3-1.2.2-.37.48-.67.83-.9a3.6 3.6 0 0 1 1.23-.5 7 7 0 0 1 2.2-.1l.83.16V8.4c0-.25-.03-.48-.1-.7a1.5 1.5 0 0 0-.3-.58c-.15-.18-.34-.3-.58-.4a2.5 2.5 0 0 0-.92-.17c-.5 0-.94.06-1.35.13-.4.08-.75.16-1 .25l-.27-1.74c.27-.1.67-.18 1.2-.28a9.3 9.3 0 0 1 1.65-.14zm.18 7.74c.66 0 1.15-.04 1.5-.1V10.2a5.1 5.1 0 0 0-2-.1c-.23.03-.45.1-.64.2a1.17 1.17 0 0 0-.47.38c-.13.17-.18.26-.18.52 0 .5.17.8.5.98.32.2.74.3 1.3.3zM84.1 4.8c.72 0 1.3.08 1.8.26.48.17.87.42 1.15.73.3.3.5.72.6 1.17.14.45.2.94.2 1.47v5.48a25 25 0 0 1-1.5.26c-.67.1-1.42.14-2.25.14a6.8 6.8 0 0 1-1.52-.16 3.2 3.2 0 0 1-1.18-.5 2.46 2.46 0 0 1-.76-.9c-.18-.38-.27-.9-.27-1.44 0-.53.1-.86.3-1.22s.5-.65.84-.88a3.6 3.6 0 0 1 1.24-.5 7 7 0 0 1 2.2-.1q.39.045.84.15v-.35c0-.24-.03-.48-.1-.7a1.5 1.5 0 0 0-.3-.58c-.15-.17-.34-.3-.58-.4a2.5 2.5 0 0 0-.9-.15c-.5 0-.96.05-1.37.12-.4.07-.75.15-1 .24l-.26-1.75c.27-.08.67-.17 1.18-.26a9 9 0 0 1 1.66-.15zm.2 7.73c.65 0 1.14-.04 1.48-.1v-2.17a5.1 5.1 0 0 0-1.98-.1c-.24.03-.46.1-.65.18a1.17 1.17 0 0 0-.47.4c-.12.17-.17.26-.17.52 0 .5.18.8.5.98.32.2.75.3 1.3.3zm8.68 1.74c-3.5 0-3.5-2.82-3.5-3.28L89.45.92 91.6.6v10c0 .25 0 1.87 1.38 1.88v1.8z'/%3E%3Cpath fill='%25231D3657' d='M5.03 11.03c0 .7-.26 1.24-.76 1.64q-.75.6-2.1.6c-.88 0-1.6-.14-2.17-.42v-1.2c.36.16.74.3 1.14.38.4.1.78.15 1.13.15.5 0 .88-.1 1.12-.3a.94.94 0 0 0 .35-.77.98.98 0 0 0-.33-.74c-.22-.2-.68-.44-1.37-.72-.72-.3-1.22-.62-1.52-1C.23 8.27.1 7.82.1 7.3c0-.65.22-1.17.7-1.55.46-.37 1.08-.56 1.86-.56.76 0 1.5.16 2.25.48l-.4 1.05c-.7-.3-1.32-.44-1.87-.44-.4 0-.73.08-.94.26a.9.9 0 0 0-.33.72c0 .2.04.38.12.52.08.15.22.3.42.4.2.14.55.3 1.06.52.58.24 1 .47 1.27.67s.47.44.6.7c.12.26.18.57.18.92zM9 13.27c-.92 0-1.64-.27-2.16-.8-.52-.55-.78-1.3-.78-2.24 0-.97.24-1.73.72-2.3.5-.54 1.15-.82 2-.82.78 0 1.4.25 1.85.72.46.48.7 1.14.7 1.97v.67H7.35c0 .58.17 1.02.46 1.33.3.3.7.47 1.24.47.36 0 .68-.04.98-.1a5 5 0 0 0 .98-.33v1.02a3.9 3.9 0 0 1-.94.32 5.7 5.7 0 0 1-1.08.1zm-.22-5.2c-.4 0-.73.12-.97.38s-.37.62-.42 1.1h2.7c0-.48-.13-.85-.36-1.1-.23-.26-.54-.38-.94-.38zm7.7 5.1-.26-.84h-.05c-.28.36-.57.6-.86.74-.28.13-.65.2-1.1.2-.6 0-1.05-.16-1.38-.48-.32-.32-.5-.77-.5-1.34 0-.62.24-1.08.7-1.4.45-.3 1.14-.47 2.07-.5l1.02-.03V9.2c0-.37-.1-.65-.27-.84-.17-.2-.45-.28-.82-.28-.3 0-.6.04-.88.13a7 7 0 0 0-.8.33l-.4-.9a4.4 4.4 0 0 1 1.05-.4 5 5 0 0 1 1.08-.12c.76 0 1.33.18 1.7.5q.6.495.6 1.56v4h-.9zm-1.9-.87c.47 0 .83-.13 1.1-.38.3-.26.43-.62.43-1.08v-.52l-.76.03c-.6.03-1.02.13-1.3.3s-.4.45-.4.82c0 .26.08.47.24.6.16.16.4.23.7.23zm7.57-5.2c.25 0 .46.03.62.06l-.12 1.18a2.4 2.4 0 0 0-.56-.06c-.5 0-.92.16-1.24.5-.3.32-.47.75-.47 1.27v3.1h-1.27V7.23h1l.16 1.05h.05c.2-.36.45-.64.77-.85a1.83 1.83 0 0 1 1.02-.3zm4.12 6.17c-.9 0-1.58-.27-2.05-.8-.47-.52-.7-1.27-.7-2.25 0-1 .24-1.77.73-2.3.5-.54 1.2-.8 2.12-.8.63 0 1.2.1 1.7.34l-.4 1c-.52-.2-.96-.3-1.3-.3-1.04 0-1.55.68-1.55 2.05 0 .67.13 1.17.38 1.5.26.34.64.5 1.13.5a3.23 3.23 0 0 0 1.6-.4v1.1a2.5 2.5 0 0 1-.73.28 4.4 4.4 0 0 1-.93.08m8.28-.1h-1.27V9.5c0-.45-.1-.8-.28-1.02-.18-.23-.47-.34-.88-.34-.53 0-.9.16-1.16.48-.25.3-.38.85-.38 1.6v2.94h-1.26V4.8h1.26v2.12c0 .34-.02.7-.06 1.1h.08a1.76 1.76 0 0 1 .72-.67c.3-.16.66-.24 1.07-.24 1.43 0 2.15.74 2.15 2.2v3.86zM42.2 7.1c.74 0 1.32.28 1.73.82.4.53.62 1.3.62 2.26 0 .97-.2 1.73-.63 2.27-.42.54-1 .82-1.75.82s-1.33-.27-1.75-.8h-.08l-.23.7h-.94V4.8h1.26v2l-.02.64-.03.56h.05c.4-.6 1-.9 1.78-.9zm-.33 1.04c-.5 0-.88.15-1.1.45s-.34.8-.35 1.5v.08c0 .72.12 1.24.35 1.57.23.32.6.48 1.12.48.44 0 .78-.17 1-.53.24-.35.36-.87.36-1.53 0-1.35-.47-2.03-1.4-2.03zm3.24-.92h1.4l1.2 3.37c.18.47.3.92.36 1.34h.04l.18-.72 1.37-4H51l-2.53 6.73c-.46 1.23-1.23 1.85-2.3 1.85-.3 0-.56-.03-.83-.1v-1c.2.05.4.08.65.08.6 0 1.03-.36 1.28-1.06l.22-.56-2.4-5.94z'/%3E%3C/g%3E%3C/svg%3E");background-position:50%;background-repeat:no-repeat;background-size:100%;display:block;height:100%;margin-left:auto;margin-right:5px;overflow:hidden;text-indent:-9000px;width:110px}html[data-theme=dark] .algolia-docsearch-footer,html[data-theme=dark] .algolia-docsearch-suggestion--category-header,html[data-theme=dark] .algolia-docsearch-suggestion--wrapper{background:var(--ifm-background-color)!important;color:var(--ifm-font-color-base)!important}html[data-theme=dark] .algolia-docsearch-suggestion--title{color:var(--ifm-font-color-base)!important}html[data-theme=dark] .ds-cursor .algolia-docsearch-suggestion--wrapper{background:var(--ifm-background-surface-color)!important}mark{background-color:#add8e6}.skipToContent_fXgn{background-color:var(--ifm-background-surface-color);color:var(--ifm-color-emphasis-900);left:100%;padding:calc(var(--ifm-global-spacing)/2) var(--ifm-global-spacing);position:fixed;top:1rem;z-index:calc(var(--ifm-z-index-fixed) + 1)}.skipToContent_fXgn:focus{box-shadow:var(--ifm-global-shadow-md);left:1rem}.closeButton_CVFx{line-height:0;padding:0}.content_knG7{font-size:85%;padding:5px 0;text-align:center}.content_knG7 a{color:inherit;text-decoration:underline}.announcementBar_mb4j{align-items:center;background-color:var(--ifm-color-white);border-bottom:1px solid var(--ifm-color-emphasis-100);color:var(--ifm-color-black);display:flex;height:var(--docusaurus-announcement-bar-height)}.announcementBarPlaceholder_vyr4{flex:0 0 10px}.announcementBarClose_gvF7{align-self:stretch;flex:0 0 30px}.toggle_vylO{height:2rem;width:2rem}.toggleButton_gllP{align-items:center;border-radius:50%;display:flex;height:100%;justify-content:center;transition:background var(--ifm-transition-fast);width:100%}.toggleButton_gllP:hover{background:var(--ifm-color-emphasis-200)}.toggleButtonDisabled_aARS{cursor:not-allowed}.darkNavbarColorModeToggle_X3D1:hover{background:var(--ifm-color-gray-800)}[data-theme=dark] .themedComponent--dark_xIcU,[data-theme=light] .themedComponent--light_NVdE,html:not([data-theme]) .themedComponent--light_NVdE{display:initial}[data-theme=dark]:root{--docusaurus-collapse-button-bg:#ffffff0d;--docusaurus-collapse-button-bg-hover:#ffffff1a}.collapseSidebarButton_PEFL{display:none;margin:0}.iconExternalLink_nPIU{margin-left:.3rem}.docMainContainer_TBSr,.docRoot_UBD9{display:flex;width:100%}.docsWrapper_hBAB{display:flex;flex:1 0 auto}.iconLanguage_nlXk{margin-right:5px;vertical-align:text-bottom}.navbarHideable_m1mJ{transition:transform var(--ifm-transition-fast) ease}.navbarHidden_jGov{transform:translate3d(0,calc(-100% - 2px),0)}.errorBoundaryError_a6uf{color:red;white-space:pre-wrap}.errorBoundaryFallback_VBag{color:red;padding:.55rem}.buttonGroup__atx button,.codeBlockContainer_Ckt0{background:var(--prism-background-color);color:var(--prism-color)}.footerLogoLink_BH7S{opacity:.5;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.footerLogoLink_BH7S:hover,.hash-link:focus,:hover>.hash-link{opacity:1}.anchorWithStickyNavbar_LWe7{scroll-margin-top:calc(var(--ifm-navbar-height) + .5rem)}.anchorWithHideOnScrollNavbar_WYt5{scroll-margin-top:.5rem}.hash-link{opacity:0;padding-left:.5rem;transition:opacity var(--ifm-transition-fast);-webkit-user-select:none;user-select:none}.hash-link:before{content:"#"}.mainWrapper_z2l0{display:flex;flex:1 0 auto;flex-direction:column}.docusaurus-mt-lg{margin-top:3rem}#__docusaurus{display:flex;flex-direction:column;min-height:100%}.features_t9lD{align-items:center;display:flex;padding:2rem 0;width:100%}.featureSvg_GfXr{height:200px;width:200px}.heroBanner_qdFl{overflow:hidden;padding:4rem 0;position:relative;text-align:center}.buttons_AeoN{align-items:center;display:flex;justify-content:center}.codeBlockContainer_Ckt0{border-radius:var(--ifm-code-border-radius);box-shadow:var(--ifm-global-shadow-lw);margin-bottom:var(--ifm-leading)}.codeBlockContent_biex{border-radius:inherit;direction:ltr;position:relative}.codeBlockTitle_Ktv7{border-bottom:1px solid var(--ifm-color-emphasis-300);border-top-left-radius:inherit;border-top-right-radius:inherit;font-size:var(--ifm-code-font-size);font-weight:500;padding:.75rem var(--ifm-pre-padding)}.codeBlock_bY9V{--ifm-pre-background:var(--prism-background-color);margin:0;padding:0}.codeBlockTitle_Ktv7+.codeBlockContent_biex .codeBlock_bY9V{border-top-left-radius:0;border-top-right-radius:0}.codeBlockLines_e6Vv{float:left;font:inherit;min-width:100%;padding:var(--ifm-pre-padding)}.codeBlockLinesWithNumbering_o6Pm{display:table;padding:var(--ifm-pre-padding) 0}.buttonGroup__atx{column-gap:.2rem;display:flex;position:absolute;right:calc(var(--ifm-pre-padding)/2);top:calc(var(--ifm-pre-padding)/2)}.buttonGroup__atx button{align-items:center;border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-global-radius);display:flex;line-height:0;opacity:0;padding:.4rem;transition:opacity var(--ifm-transition-fast) ease-in-out}.buttonGroup__atx button:focus-visible,.buttonGroup__atx button:hover{opacity:1!important}.theme-code-block:hover .buttonGroup__atx button{opacity:.4}:where(:root){--docusaurus-highlighted-code-line-bg:#484d5b}:where([data-theme=dark]){--docusaurus-highlighted-code-line-bg:#646464}.theme-code-block-highlighted-line{background-color:var(--docusaurus-highlighted-code-line-bg);display:block;margin:0 calc(var(--ifm-pre-padding)*-1);padding:0 var(--ifm-pre-padding)}.codeLine_lJS_{counter-increment:a;display:table-row}.codeLineNumber_Tfdd{background:var(--ifm-pre-background);display:table-cell;left:0;overflow-wrap:normal;padding:0 var(--ifm-pre-padding);position:sticky;text-align:right;width:1%}.codeLineNumber_Tfdd:before{content:counter(a);opacity:.4}.codeLineContent_feaV{padding-right:var(--ifm-pre-padding)}.theme-code-block:hover .copyButtonCopied_obH4{opacity:1!important}.copyButtonIcons_eSgA{height:1.125rem;position:relative;width:1.125rem}.copyButtonIcon_y97N,.copyButtonSuccessIcon_LjdS{left:0;position:absolute;top:0;fill:currentColor;height:inherit;opacity:inherit;transition:all var(--ifm-transition-fast) ease;width:inherit}.copyButtonSuccessIcon_LjdS{color:#00d600;left:50%;opacity:0;top:50%;transform:translate(-50%,-50%) scale(.33)}.copyButtonCopied_obH4 .copyButtonIcon_y97N{opacity:0;transform:scale(.33)}.copyButtonCopied_obH4 .copyButtonSuccessIcon_LjdS{opacity:1;transform:translate(-50%,-50%) scale(1);transition-delay:75ms}.wordWrapButtonIcon_Bwma{height:1.2rem;width:1.2rem}.iconEdit_Z9Sw{margin-right:.3em;vertical-align:sub}.details_lb9f{--docusaurus-details-summary-arrow-size:0.38rem;--docusaurus-details-transition:transform 200ms ease;--docusaurus-details-decoration-color:grey}.details_lb9f>summary{cursor:pointer;padding-left:1rem;position:relative}.details_lb9f>summary::-webkit-details-marker{display:none}.details_lb9f>summary:before{border-color:#0000 #0000 #0000 var(--docusaurus-details-decoration-color);border-style:solid;border-width:var(--docusaurus-details-summary-arrow-size);content:"";left:0;position:absolute;top:.45rem;transform:rotate(0);transform-origin:calc(var(--docusaurus-details-summary-arrow-size)/2) 50%;transition:var(--docusaurus-details-transition)}.collapsibleContent_i85q{border-top:1px solid var(--docusaurus-details-decoration-color);margin-top:1rem;padding-top:1rem}.lastUpdated_JAkA{font-size:smaller;font-style:italic;margin-top:.2rem}.tocCollapsibleButton_TO0P{align-items:center;display:flex;font-size:inherit;justify-content:space-between;padding:.4rem .8rem;width:100%}.tocCollapsibleButton_TO0P:after{background:var(--ifm-menu-link-sublist-icon) 50% 50%/2rem 2rem no-repeat;content:"";filter:var(--ifm-menu-link-sublist-icon-filter);height:1.25rem;transform:rotate(180deg);transition:transform var(--ifm-transition-fast);width:1.25rem}.tocCollapsibleButtonExpanded_MG3E:after,.tocCollapsibleExpanded_sAul{transform:none}.tocCollapsible_ETCw{background-color:var(--ifm-menu-color-background-active);border-radius:var(--ifm-global-radius);margin:1rem 0}.tocCollapsibleContent_vkbj>ul{border-left:none;border-top:1px solid var(--ifm-color-emphasis-300);font-size:15px;padding:.2rem 0}.tocCollapsibleContent_vkbj ul li{margin:.4rem .8rem}.details_b_Ee{--docusaurus-details-decoration-color:var(--ifm-alert-border-color);--docusaurus-details-transition:transform var(--ifm-transition-fast) ease;border:1px solid var(--ifm-alert-border-color);margin:0 0 var(--ifm-spacing-vertical)}:not(.containsTaskList_mC6p>li)>.containsTaskList_mC6p{padding-left:0}.img_ev3q{height:auto}.tableOfContents_bqdL{max-height:calc(100vh - var(--ifm-navbar-height) - 2rem);overflow-y:auto;position:sticky;top:calc(var(--ifm-navbar-height) + 1rem)}.admonition_xJq3{margin-bottom:1em}.admonitionHeading_Gvgb{font:var(--ifm-heading-font-weight) var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family)}.admonitionHeading_Gvgb:not(:last-child){margin-bottom:.3rem}.admonitionHeading_Gvgb code{text-transform:none}.admonitionIcon_Rf37{display:inline-block;margin-right:.4em;vertical-align:middle}.admonitionIcon_Rf37 svg{display:inline-block;height:1.6em;width:1.6em;fill:var(--ifm-alert-foreground-color)}.breadcrumbHomeIcon_YNFT{height:1.1rem;position:relative;top:1px;vertical-align:top;width:1.1rem}.breadcrumbsContainer_Z_bl{--ifm-breadcrumb-size-multiplier:0.8;margin-bottom:.8rem}.mdxPageWrapper_j9I6{justify-content:center}@media (min-width:601px){.algolia-autocomplete.algolia-autocomplete-right .ds-dropdown-menu{left:inherit!important;right:0!important}.algolia-autocomplete.algolia-autocomplete-right .ds-dropdown-menu:before{right:48px}.algolia-autocomplete .ds-dropdown-menu{background:#0000;border:none;border-radius:4px;height:auto;margin:6px 0 0;max-width:600px;min-width:500px;padding:0;position:relative;text-align:left;top:-6px;z-index:999}}@media (min-width:768px){.algolia-docsearch-suggestion{border-bottom-color:#7671df}.algolia-docsearch-suggestion--subcategory-column{border-right-color:#7671df;color:#4e4726}}@media (min-width:997px){.collapseSidebarButton_PEFL,.expandButton_TmdG{background-color:var(--docusaurus-collapse-button-bg)}:root{--docusaurus-announcement-bar-height:30px}.announcementBarClose_gvF7,.announcementBarPlaceholder_vyr4{flex-basis:50px}.collapseSidebarButton_PEFL{border:1px solid var(--ifm-toc-border-color);border-radius:0;bottom:0;display:block!important;height:40px;position:sticky}.collapseSidebarButtonIcon_kv0_{margin-top:4px;transform:rotate(180deg)}.expandButtonIcon_i1dp,[dir=rtl] .collapseSidebarButtonIcon_kv0_{transform:rotate(0)}.collapseSidebarButton_PEFL:focus,.collapseSidebarButton_PEFL:hover,.expandButton_TmdG:focus,.expandButton_TmdG:hover{background-color:var(--docusaurus-collapse-button-bg-hover)}.menuHtmlItem_M9Kj{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu_SIkG{flex-grow:1;padding:.5rem}@supports (scrollbar-gutter:stable){.menu_SIkG{padding:.5rem 0 .5rem .5rem;scrollbar-gutter:stable}}.menuWithAnnouncementBar_GW3s{margin-bottom:var(--docusaurus-announcement-bar-height)}.sidebar_njMd{display:flex;flex-direction:column;height:100%;padding-top:var(--ifm-navbar-height);width:var(--doc-sidebar-width)}.sidebarWithHideableNavbar_wUlq{padding-top:0}.sidebarHidden_VK0M{opacity:0;visibility:hidden}.sidebarLogo_isFc{align-items:center;color:inherit!important;display:flex!important;margin:0 var(--ifm-navbar-padding-horizontal);max-height:var(--ifm-navbar-height);min-height:var(--ifm-navbar-height);text-decoration:none!important}.sidebarLogo_isFc img{height:2rem;margin-right:.5rem}.expandButton_TmdG{align-items:center;display:flex;height:100%;justify-content:center;position:absolute;right:0;top:0;transition:background-color var(--ifm-transition-fast) ease;width:100%}[dir=rtl] .expandButtonIcon_i1dp{transform:rotate(180deg)}.docSidebarContainer_YfHR{border-right:1px solid var(--ifm-toc-border-color);clip-path:inset(0);display:block;margin-top:calc(var(--ifm-navbar-height)*-1);transition:width var(--ifm-transition-fast) ease;width:var(--doc-sidebar-width);will-change:width}.docSidebarContainerHidden_DPk8{cursor:pointer;width:var(--doc-sidebar-hidden-width)}.sidebarViewport_aRkj{height:100%;max-height:100vh;position:sticky;top:0}.docMainContainer_TBSr{flex-grow:1;max-width:calc(100% - var(--doc-sidebar-width))}.docMainContainerEnhanced_lQrH{max-width:calc(100% - var(--doc-sidebar-hidden-width))}.docItemWrapperEnhanced_JWYK{max-width:calc(var(--ifm-container-width) + var(--doc-sidebar-width))!important}.navbarSearchContainer_Bca1{padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.lastUpdated_JAkA{text-align:right}.tocMobile_ITEo{display:none}.docItemCol_VOVn{max-width:75%!important}}@media (min-width:1440px){.container{max-width:var(--ifm-container-width-xl)}}@media (max-width:996px){.col{--ifm-col-width:100%;flex-basis:var(--ifm-col-width);margin-left:0}.footer{--ifm-footer-padding-horizontal:0}.colorModeToggle_DEke,.footer__link-separator,.navbar__item,.tableOfContents_bqdL{display:none}.footer__col{margin-bottom:calc(var(--ifm-spacing-vertical)*3)}.footer__link-item{display:block}.hero{padding-left:0;padding-right:0}.navbar>.container,.navbar>.container-fluid{padding:0}.navbar__toggle{display:inherit}.navbar__search-input{width:9rem}.pills--block,.tabs--block{flex-direction:column}.navbarSearchContainer_Bca1{position:absolute;right:var(--ifm-navbar-padding-horizontal)}.docItemContainer_F8PC{padding:0 .3rem}}@media screen and (max-width:996px){.heroBanner_qdFl{padding:2rem}}@media (max-width:600px){.algolia-autocomplete .ds-dropdown-menu{display:block;left:auto!important;max-height:calc(100% - 5rem);max-width:calc(100% - 2rem);position:fixed!important;right:1rem!important;top:50px!important;width:600px;z-index:100}.algolia-autocomplete .ds-dropdown-menu:before{right:6rem}}@media (max-width:576px){.markdown h1:first-child{--ifm-h1-font-size:2rem}.markdown>h2{--ifm-h2-font-size:1.5rem}.markdown>h3{--ifm-h3-font-size:1.25rem}}@media (hover:hover){.backToTopButton_sjWU:hover{background-color:var(--ifm-color-emphasis-300)}}@media (pointer:fine){.thin-scrollbar{scrollbar-width:thin}.thin-scrollbar::-webkit-scrollbar{height:var(--ifm-scrollbar-size);width:var(--ifm-scrollbar-size)}.thin-scrollbar::-webkit-scrollbar-track{background:var(--ifm-scrollbar-track-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb{background:var(--ifm-scrollbar-thumb-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb:hover{background:var(--ifm-scrollbar-thumb-hover-background-color)}}@media (prefers-reduced-motion:reduce){:root{--ifm-transition-fast:0ms;--ifm-transition-slow:0ms}}@media print{.announcementBar_mb4j,.footer,.menu,.navbar,.pagination-nav,.table-of-contents,.tocMobile_ITEo{display:none}.tabs{page-break-inside:avoid}.codeBlockLines_e6Vv{white-space:pre-wrap}} \ No newline at end of file +.col,.container{padding:0 var(--ifm-spacing-horizontal);width:100%}.markdown>h2,.markdown>h3,.markdown>h4,.markdown>h5,.markdown>h6{margin-bottom:calc(var(--ifm-heading-vertical-rhythm-bottom)*var(--ifm-leading))}body,ol ol,ol ul,ul ol,ul ul{margin:0}blockquote,pre{margin:0 0 var(--ifm-spacing-vertical)}.breadcrumbs__link,.button{transition-timing-function:var(--ifm-transition-timing-default)}.button,code{vertical-align:middle}.button--outline.button--active,.button--outline:active,.button--outline:hover,:root{--ifm-button-color:var(--ifm-font-color-base-inverse)}.menu__link:hover,a{transition:color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.navbar--dark,:root{--ifm-navbar-link-hover-color:var(--ifm-color-primary)}.menu,.navbar-sidebar{overflow-x:hidden}:root,html[data-theme=dark]{--ifm-color-emphasis-500:var(--ifm-color-gray-500)}.button,.dropdown__link,.searchbox,.text--truncate{white-space:nowrap}*,.algolia-autocomplete .ds-dropdown-menu *,.searchbox,.searchbox__input{box-sizing:border-box}.searchbox__reset:focus,.searchbox__submit:focus,body:not(.navigation-with-keyboard) :not(input):focus{outline:0}pre,table{overflow:auto}.markdown li,body{word-wrap:break-word}.toggleButton_gllP,html{-webkit-tap-highlight-color:transparent}.clean-list,.containsTaskList_mC6p,.details_lb9f>summary,.dropdown__menu,.menu__list{list-style:none}:root{--ifm-color-scheme:light;--ifm-dark-value:10%;--ifm-darker-value:15%;--ifm-darkest-value:30%;--ifm-light-value:15%;--ifm-lighter-value:30%;--ifm-lightest-value:50%;--ifm-contrast-background-value:90%;--ifm-contrast-foreground-value:70%;--ifm-contrast-background-dark-value:70%;--ifm-contrast-foreground-dark-value:90%;--ifm-color-primary:#3578e5;--ifm-color-secondary:#ebedf0;--ifm-color-success:#00a400;--ifm-color-info:#54c7ec;--ifm-color-warning:#ffba00;--ifm-color-danger:#fa383e;--ifm-color-primary-dark:#306cce;--ifm-color-primary-darker:#2d66c3;--ifm-color-primary-darkest:#2554a0;--ifm-color-primary-light:#538ce9;--ifm-color-primary-lighter:#72a1ed;--ifm-color-primary-lightest:#9abcf2;--ifm-color-primary-contrast-background:#ebf2fc;--ifm-color-primary-contrast-foreground:#102445;--ifm-color-secondary-dark:#d4d5d8;--ifm-color-secondary-darker:#c8c9cc;--ifm-color-secondary-darkest:#a4a6a8;--ifm-color-secondary-light:#eef0f2;--ifm-color-secondary-lighter:#f1f2f5;--ifm-color-secondary-lightest:#f5f6f8;--ifm-color-secondary-contrast-background:#fdfdfe;--ifm-color-secondary-contrast-foreground:#474748;--ifm-color-success-dark:#009400;--ifm-color-success-darker:#008b00;--ifm-color-success-darkest:#007300;--ifm-color-success-light:#26b226;--ifm-color-success-lighter:#4dbf4d;--ifm-color-success-lightest:#80d280;--ifm-color-success-contrast-background:#e6f6e6;--ifm-color-success-contrast-foreground:#003100;--ifm-color-info-dark:#4cb3d4;--ifm-color-info-darker:#47a9c9;--ifm-color-info-darkest:#3b8ba5;--ifm-color-info-light:#6ecfef;--ifm-color-info-lighter:#87d8f2;--ifm-color-info-lightest:#aae3f6;--ifm-color-info-contrast-background:#eef9fd;--ifm-color-info-contrast-foreground:#193c47;--ifm-color-warning-dark:#e6a700;--ifm-color-warning-darker:#d99e00;--ifm-color-warning-darkest:#b38200;--ifm-color-warning-light:#ffc426;--ifm-color-warning-lighter:#ffcf4d;--ifm-color-warning-lightest:#ffdd80;--ifm-color-warning-contrast-background:#fff8e6;--ifm-color-warning-contrast-foreground:#4d3800;--ifm-color-danger-dark:#e13238;--ifm-color-danger-darker:#d53035;--ifm-color-danger-darkest:#af272b;--ifm-color-danger-light:#fb565b;--ifm-color-danger-lighter:#fb7478;--ifm-color-danger-lightest:#fd9c9f;--ifm-color-danger-contrast-background:#ffebec;--ifm-color-danger-contrast-foreground:#4b1113;--ifm-color-white:#fff;--ifm-color-black:#000;--ifm-color-gray-0:var(--ifm-color-white);--ifm-color-gray-100:#f5f6f7;--ifm-color-gray-200:#ebedf0;--ifm-color-gray-300:#dadde1;--ifm-color-gray-400:#ccd0d5;--ifm-color-gray-500:#bec3c9;--ifm-color-gray-600:#8d949e;--ifm-color-gray-700:#606770;--ifm-color-gray-800:#444950;--ifm-color-gray-900:#1c1e21;--ifm-color-gray-1000:var(--ifm-color-black);--ifm-color-emphasis-0:var(--ifm-color-gray-0);--ifm-color-emphasis-100:var(--ifm-color-gray-100);--ifm-color-emphasis-200:var(--ifm-color-gray-200);--ifm-color-emphasis-300:var(--ifm-color-gray-300);--ifm-color-emphasis-400:var(--ifm-color-gray-400);--ifm-color-emphasis-600:var(--ifm-color-gray-600);--ifm-color-emphasis-700:var(--ifm-color-gray-700);--ifm-color-emphasis-800:var(--ifm-color-gray-800);--ifm-color-emphasis-900:var(--ifm-color-gray-900);--ifm-color-emphasis-1000:var(--ifm-color-gray-1000);--ifm-color-content:var(--ifm-color-emphasis-900);--ifm-color-content-inverse:var(--ifm-color-emphasis-0);--ifm-color-content-secondary:#525860;--ifm-background-color:#0000;--ifm-background-surface-color:var(--ifm-color-content-inverse);--ifm-global-border-width:1px;--ifm-global-radius:0.4rem;--ifm-hover-overlay:#0000000d;--ifm-font-color-base:var(--ifm-color-content);--ifm-font-color-base-inverse:var(--ifm-color-content-inverse);--ifm-font-color-secondary:var(--ifm-color-content-secondary);--ifm-font-family-base:system-ui,-apple-system,Segoe UI,Roboto,Ubuntu,Cantarell,Noto Sans,sans-serif,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";--ifm-font-family-monospace:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;--ifm-font-size-base:100%;--ifm-font-weight-light:300;--ifm-font-weight-normal:400;--ifm-font-weight-semibold:500;--ifm-font-weight-bold:700;--ifm-font-weight-base:var(--ifm-font-weight-normal);--ifm-line-height-base:1.65;--ifm-global-spacing:1rem;--ifm-spacing-vertical:var(--ifm-global-spacing);--ifm-spacing-horizontal:var(--ifm-global-spacing);--ifm-transition-fast:200ms;--ifm-transition-slow:400ms;--ifm-transition-timing-default:cubic-bezier(0.08,0.52,0.52,1);--ifm-global-shadow-lw:0 1px 2px 0 #0000001a;--ifm-global-shadow-md:0 5px 40px #0003;--ifm-global-shadow-tl:0 12px 28px 0 #0003,0 2px 4px 0 #0000001a;--ifm-z-index-dropdown:100;--ifm-z-index-fixed:200;--ifm-z-index-overlay:400;--ifm-container-width:1140px;--ifm-container-width-xl:1320px;--ifm-code-background:#f6f7f8;--ifm-code-border-radius:var(--ifm-global-radius);--ifm-code-font-size:90%;--ifm-code-padding-horizontal:0.1rem;--ifm-code-padding-vertical:0.1rem;--ifm-pre-background:var(--ifm-code-background);--ifm-pre-border-radius:var(--ifm-code-border-radius);--ifm-pre-color:inherit;--ifm-pre-line-height:1.45;--ifm-pre-padding:1rem;--ifm-heading-color:inherit;--ifm-heading-margin-top:0;--ifm-heading-margin-bottom:var(--ifm-spacing-vertical);--ifm-heading-font-family:var(--ifm-font-family-base);--ifm-heading-font-weight:var(--ifm-font-weight-bold);--ifm-heading-line-height:1.25;--ifm-h1-font-size:2rem;--ifm-h2-font-size:1.5rem;--ifm-h3-font-size:1.25rem;--ifm-h4-font-size:1rem;--ifm-h5-font-size:0.875rem;--ifm-h6-font-size:0.85rem;--ifm-image-alignment-padding:1.25rem;--ifm-leading-desktop:1.25;--ifm-leading:calc(var(--ifm-leading-desktop)*1rem);--ifm-list-left-padding:2rem;--ifm-list-margin:1rem;--ifm-list-item-margin:0.25rem;--ifm-list-paragraph-margin:1rem;--ifm-table-cell-padding:0.75rem;--ifm-table-background:#0000;--ifm-table-stripe-background:#00000008;--ifm-table-border-width:1px;--ifm-table-border-color:var(--ifm-color-emphasis-300);--ifm-table-head-background:inherit;--ifm-table-head-color:inherit;--ifm-table-head-font-weight:var(--ifm-font-weight-bold);--ifm-table-cell-color:inherit;--ifm-link-color:var(--ifm-color-primary);--ifm-link-decoration:none;--ifm-link-hover-color:var(--ifm-link-color);--ifm-link-hover-decoration:underline;--ifm-paragraph-margin-bottom:var(--ifm-leading);--ifm-blockquote-font-size:var(--ifm-font-size-base);--ifm-blockquote-border-left-width:2px;--ifm-blockquote-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-blockquote-padding-vertical:0;--ifm-blockquote-shadow:none;--ifm-blockquote-color:var(--ifm-color-emphasis-800);--ifm-blockquote-border-color:var(--ifm-color-emphasis-300);--ifm-hr-background-color:var(--ifm-color-emphasis-500);--ifm-hr-height:1px;--ifm-hr-margin-vertical:1.5rem;--ifm-scrollbar-size:7px;--ifm-scrollbar-track-background-color:#f1f1f1;--ifm-scrollbar-thumb-background-color:silver;--ifm-scrollbar-thumb-hover-background-color:#a7a7a7;--ifm-alert-background-color:inherit;--ifm-alert-border-color:inherit;--ifm-alert-border-radius:var(--ifm-global-radius);--ifm-alert-border-width:0px;--ifm-alert-border-left-width:5px;--ifm-alert-color:var(--ifm-font-color-base);--ifm-alert-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-alert-padding-vertical:var(--ifm-spacing-vertical);--ifm-alert-shadow:var(--ifm-global-shadow-lw);--ifm-avatar-intro-margin:1rem;--ifm-avatar-intro-alignment:inherit;--ifm-avatar-photo-size:3rem;--ifm-badge-background-color:inherit;--ifm-badge-border-color:inherit;--ifm-badge-border-radius:var(--ifm-global-radius);--ifm-badge-border-width:var(--ifm-global-border-width);--ifm-badge-color:var(--ifm-color-white);--ifm-badge-padding-horizontal:calc(var(--ifm-spacing-horizontal)*0.5);--ifm-badge-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-breadcrumb-border-radius:1.5rem;--ifm-breadcrumb-spacing:0.5rem;--ifm-breadcrumb-color-active:var(--ifm-color-primary);--ifm-breadcrumb-item-background-active:var(--ifm-hover-overlay);--ifm-breadcrumb-padding-horizontal:0.8rem;--ifm-breadcrumb-padding-vertical:0.4rem;--ifm-breadcrumb-size-multiplier:1;--ifm-breadcrumb-separator:url('data:image/svg+xml;utf8,');--ifm-breadcrumb-separator-filter:none;--ifm-breadcrumb-separator-size:0.5rem;--ifm-breadcrumb-separator-size-multiplier:1.25;--ifm-button-background-color:inherit;--ifm-button-border-color:var(--ifm-button-background-color);--ifm-button-border-width:var(--ifm-global-border-width);--ifm-button-font-weight:var(--ifm-font-weight-bold);--ifm-button-padding-horizontal:1.5rem;--ifm-button-padding-vertical:0.375rem;--ifm-button-size-multiplier:1;--ifm-button-transition-duration:var(--ifm-transition-fast);--ifm-button-border-radius:calc(var(--ifm-global-radius)*var(--ifm-button-size-multiplier));--ifm-button-group-spacing:2px;--ifm-card-background-color:var(--ifm-background-surface-color);--ifm-card-border-radius:calc(var(--ifm-global-radius)*2);--ifm-card-horizontal-spacing:var(--ifm-global-spacing);--ifm-card-vertical-spacing:var(--ifm-global-spacing);--ifm-toc-border-color:var(--ifm-color-emphasis-300);--ifm-toc-link-color:var(--ifm-color-content-secondary);--ifm-toc-padding-vertical:0.5rem;--ifm-toc-padding-horizontal:0.5rem;--ifm-dropdown-background-color:var(--ifm-background-surface-color);--ifm-dropdown-font-weight:var(--ifm-font-weight-semibold);--ifm-dropdown-link-color:var(--ifm-font-color-base);--ifm-dropdown-hover-background-color:var(--ifm-hover-overlay);--ifm-footer-background-color:var(--ifm-color-emphasis-100);--ifm-footer-color:inherit;--ifm-footer-link-color:var(--ifm-color-emphasis-700);--ifm-footer-link-hover-color:var(--ifm-color-primary);--ifm-footer-link-horizontal-spacing:0.5rem;--ifm-footer-padding-horizontal:calc(var(--ifm-spacing-horizontal)*2);--ifm-footer-padding-vertical:calc(var(--ifm-spacing-vertical)*2);--ifm-footer-title-color:inherit;--ifm-footer-logo-max-width:min(30rem,90vw);--ifm-hero-background-color:var(--ifm-background-surface-color);--ifm-hero-text-color:var(--ifm-color-emphasis-800);--ifm-menu-color:var(--ifm-color-emphasis-700);--ifm-menu-color-active:var(--ifm-color-primary);--ifm-menu-color-background-active:var(--ifm-hover-overlay);--ifm-menu-color-background-hover:var(--ifm-hover-overlay);--ifm-menu-link-padding-horizontal:0.75rem;--ifm-menu-link-padding-vertical:0.375rem;--ifm-menu-link-sublist-icon:url('data:image/svg+xml;utf8,');--ifm-menu-link-sublist-icon-filter:none;--ifm-navbar-background-color:var(--ifm-background-surface-color);--ifm-navbar-height:3.75rem;--ifm-navbar-item-padding-horizontal:0.75rem;--ifm-navbar-item-padding-vertical:0.25rem;--ifm-navbar-link-color:var(--ifm-font-color-base);--ifm-navbar-link-active-color:var(--ifm-link-color);--ifm-navbar-padding-horizontal:var(--ifm-spacing-horizontal);--ifm-navbar-padding-vertical:calc(var(--ifm-spacing-vertical)*0.5);--ifm-navbar-shadow:var(--ifm-global-shadow-lw);--ifm-navbar-search-input-background-color:var(--ifm-color-emphasis-200);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-800);--ifm-navbar-search-input-placeholder-color:var(--ifm-color-emphasis-500);--ifm-navbar-search-input-icon:url('data:image/svg+xml;utf8,');--ifm-navbar-sidebar-width:83vw;--ifm-pagination-border-radius:var(--ifm-global-radius);--ifm-pagination-color-active:var(--ifm-color-primary);--ifm-pagination-font-size:1rem;--ifm-pagination-item-active-background:var(--ifm-hover-overlay);--ifm-pagination-page-spacing:0.2em;--ifm-pagination-padding-horizontal:calc(var(--ifm-spacing-horizontal)*1);--ifm-pagination-padding-vertical:calc(var(--ifm-spacing-vertical)*0.25);--ifm-pagination-nav-border-radius:var(--ifm-global-radius);--ifm-pagination-nav-color-hover:var(--ifm-color-primary);--ifm-pills-color-active:var(--ifm-color-primary);--ifm-pills-color-background-active:var(--ifm-hover-overlay);--ifm-pills-spacing:0.125rem;--ifm-tabs-color:var(--ifm-font-color-secondary);--ifm-tabs-color-active:var(--ifm-color-primary);--ifm-tabs-color-active-border:var(--ifm-tabs-color-active);--ifm-tabs-padding-horizontal:1rem;--ifm-tabs-padding-vertical:1rem;--docusaurus-progress-bar-color:var(--ifm-color-primary);--ifm-color-primary:#2453ff;--ifm-color-primary-dark:#2453ff;--ifm-color-primary-darker:#2453ff;--ifm-color-primary-darkest:#2453ff;--ifm-color-primary-light:#2453ff;--ifm-color-primary-lighter:#2453ff;--ifm-color-primary-lightest:#2453ff;--ifm-code-font-size:95%;--docusaurus-highlighted-code-line-bg:#0000001a;--docusaurus-tag-list-border:var(--ifm-color-emphasis-300);--docusaurus-announcement-bar-height:auto;--docusaurus-collapse-button-bg:#0000;--docusaurus-collapse-button-bg-hover:#0000001a;--doc-sidebar-width:300px;--doc-sidebar-hidden-width:30px}.badge--danger,.badge--info,.badge--primary,.badge--secondary,.badge--success,.badge--warning{--ifm-badge-border-color:var(--ifm-badge-background-color)}.button--link,.button--outline{--ifm-button-background-color:#0000}html{background-color:var(--ifm-background-color);color:var(--ifm-font-color-base);color-scheme:var(--ifm-color-scheme);font:var(--ifm-font-size-base)/var(--ifm-line-height-base) var(--ifm-font-family-base);-webkit-font-smoothing:antialiased;text-rendering:optimizelegibility;-webkit-text-size-adjust:100%;text-size-adjust:100%}iframe{border:0;color-scheme:auto}.container{margin:0 auto;max-width:var(--ifm-container-width)}.container--fluid{max-width:inherit}.row{display:flex;flex-wrap:wrap;margin:0 calc(var(--ifm-spacing-horizontal)*-1)}.margin-bottom--none,.margin-vert--none,.markdown>:last-child{margin-bottom:0!important}.margin-top--none,.margin-vert--none{margin-top:0!important}.row--no-gutters{margin-left:0;margin-right:0}.margin-horiz--none,.margin-right--none{margin-right:0!important}.row--no-gutters>.col{padding-left:0;padding-right:0}.row--align-top{align-items:flex-start}.row--align-bottom{align-items:flex-end}.menuExternalLink_NmtK,.row--align-center{align-items:center}.row--align-stretch{align-items:stretch}.row--align-baseline{align-items:baseline}.col{--ifm-col-width:100%;flex:1 0;margin-left:0;max-width:var(--ifm-col-width)}.padding-bottom--none,.padding-vert--none{padding-bottom:0!important}.padding-top--none,.padding-vert--none{padding-top:0!important}.padding-horiz--none,.padding-left--none{padding-left:0!important}.padding-horiz--none,.padding-right--none{padding-right:0!important}.col[class*=col--]{flex:0 0 var(--ifm-col-width)}.col--1{--ifm-col-width:8.33333%}.col--offset-1{margin-left:8.33333%}.col--2{--ifm-col-width:16.66667%}.col--offset-2{margin-left:16.66667%}.col--3{--ifm-col-width:25%}.col--offset-3{margin-left:25%}.col--4{--ifm-col-width:33.33333%}.col--offset-4{margin-left:33.33333%}.col--5{--ifm-col-width:41.66667%}.col--offset-5{margin-left:41.66667%}.col--6{--ifm-col-width:50%}.col--offset-6{margin-left:50%}.col--7{--ifm-col-width:58.33333%}.col--offset-7{margin-left:58.33333%}.col--8{--ifm-col-width:66.66667%}.col--offset-8{margin-left:66.66667%}.col--9{--ifm-col-width:75%}.col--offset-9{margin-left:75%}.col--10{--ifm-col-width:83.33333%}.col--offset-10{margin-left:83.33333%}.col--11{--ifm-col-width:91.66667%}.col--offset-11{margin-left:91.66667%}.col--12{--ifm-col-width:100%}.col--offset-12{margin-left:100%}.margin-horiz--none,.margin-left--none{margin-left:0!important}.margin--none{margin:0!important}.margin-bottom--xs,.margin-vert--xs{margin-bottom:.25rem!important}.margin-top--xs,.margin-vert--xs{margin-top:.25rem!important}.margin-horiz--xs,.margin-left--xs{margin-left:.25rem!important}.margin-horiz--xs,.margin-right--xs{margin-right:.25rem!important}.margin--xs{margin:.25rem!important}.margin-bottom--sm,.margin-vert--sm{margin-bottom:.5rem!important}.margin-top--sm,.margin-vert--sm{margin-top:.5rem!important}.margin-horiz--sm,.margin-left--sm{margin-left:.5rem!important}.margin-horiz--sm,.margin-right--sm{margin-right:.5rem!important}.margin--sm{margin:.5rem!important}.margin-bottom--md,.margin-vert--md{margin-bottom:1rem!important}.margin-top--md,.margin-vert--md{margin-top:1rem!important}.margin-horiz--md,.margin-left--md{margin-left:1rem!important}.margin-horiz--md,.margin-right--md{margin-right:1rem!important}.margin--md{margin:1rem!important}.margin-bottom--lg,.margin-vert--lg{margin-bottom:2rem!important}.margin-top--lg,.margin-vert--lg{margin-top:2rem!important}.margin-horiz--lg,.margin-left--lg{margin-left:2rem!important}.margin-horiz--lg,.margin-right--lg{margin-right:2rem!important}.margin--lg{margin:2rem!important}.margin-bottom--xl,.margin-vert--xl{margin-bottom:5rem!important}.margin-top--xl,.margin-vert--xl{margin-top:5rem!important}.margin-horiz--xl,.margin-left--xl{margin-left:5rem!important}.margin-horiz--xl,.margin-right--xl{margin-right:5rem!important}.margin--xl{margin:5rem!important}.padding--none{padding:0!important}.padding-bottom--xs,.padding-vert--xs{padding-bottom:.25rem!important}.padding-top--xs,.padding-vert--xs{padding-top:.25rem!important}.padding-horiz--xs,.padding-left--xs{padding-left:.25rem!important}.padding-horiz--xs,.padding-right--xs{padding-right:.25rem!important}.padding--xs{padding:.25rem!important}.padding-bottom--sm,.padding-vert--sm{padding-bottom:.5rem!important}.padding-top--sm,.padding-vert--sm{padding-top:.5rem!important}.padding-horiz--sm,.padding-left--sm{padding-left:.5rem!important}.padding-horiz--sm,.padding-right--sm{padding-right:.5rem!important}.padding--sm{padding:.5rem!important}.padding-bottom--md,.padding-vert--md{padding-bottom:1rem!important}.padding-top--md,.padding-vert--md{padding-top:1rem!important}.padding-horiz--md,.padding-left--md{padding-left:1rem!important}.padding-horiz--md,.padding-right--md{padding-right:1rem!important}.padding--md{padding:1rem!important}.padding-bottom--lg,.padding-vert--lg{padding-bottom:2rem!important}.padding-top--lg,.padding-vert--lg{padding-top:2rem!important}.padding-horiz--lg,.padding-left--lg{padding-left:2rem!important}.padding-horiz--lg,.padding-right--lg{padding-right:2rem!important}.padding--lg{padding:2rem!important}.padding-bottom--xl,.padding-vert--xl{padding-bottom:5rem!important}.padding-top--xl,.padding-vert--xl{padding-top:5rem!important}.padding-horiz--xl,.padding-left--xl{padding-left:5rem!important}.padding-horiz--xl,.padding-right--xl{padding-right:5rem!important}.padding--xl{padding:5rem!important}code{background-color:var(--ifm-code-background);border:.1rem solid #0000001a;border-radius:var(--ifm-code-border-radius);font-family:var(--ifm-font-family-monospace);font-size:var(--ifm-code-font-size);padding:var(--ifm-code-padding-vertical) var(--ifm-code-padding-horizontal)}a code{color:inherit}pre{background-color:var(--ifm-pre-background);border-radius:var(--ifm-pre-border-radius);color:var(--ifm-pre-color);font:var(--ifm-code-font-size)/var(--ifm-pre-line-height) var(--ifm-font-family-monospace);padding:var(--ifm-pre-padding)}pre code{background-color:initial;border:none;font-size:100%;line-height:inherit;padding:0}kbd{background-color:var(--ifm-color-emphasis-0);border:1px solid var(--ifm-color-emphasis-400);border-radius:.2rem;box-shadow:inset 0 -1px 0 var(--ifm-color-emphasis-400);color:var(--ifm-color-emphasis-800);font:80% var(--ifm-font-family-monospace);padding:.15rem .3rem}h1,h2,h3,h4,h5,h6{color:var(--ifm-heading-color);font-family:var(--ifm-heading-font-family);font-weight:var(--ifm-heading-font-weight);line-height:var(--ifm-heading-line-height);margin:var(--ifm-heading-margin-top) 0 var(--ifm-heading-margin-bottom) 0}h1{font-size:var(--ifm-h1-font-size)}h2{font-size:var(--ifm-h2-font-size)}h3{font-size:var(--ifm-h3-font-size)}h4{font-size:var(--ifm-h4-font-size)}h5{font-size:var(--ifm-h5-font-size)}h6{font-size:var(--ifm-h6-font-size)}img{max-width:100%}img[align=right]{padding-left:var(--image-alignment-padding)}img[align=left]{padding-right:var(--image-alignment-padding)}.markdown{--ifm-h1-vertical-rhythm-top:3;--ifm-h2-vertical-rhythm-top:2;--ifm-h3-vertical-rhythm-top:1.5;--ifm-heading-vertical-rhythm-top:1.25;--ifm-h1-vertical-rhythm-bottom:1.25;--ifm-heading-vertical-rhythm-bottom:1}.markdown:after,.markdown:before{content:"";display:table}.markdown:after{clear:both}.markdown h1:first-child{--ifm-h1-font-size:3rem;margin-bottom:calc(var(--ifm-h1-vertical-rhythm-bottom)*var(--ifm-leading))}.markdown>h2{--ifm-h2-font-size:2rem;margin-top:calc(var(--ifm-h2-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h3{--ifm-h3-font-size:1.5rem;margin-top:calc(var(--ifm-h3-vertical-rhythm-top)*var(--ifm-leading))}.markdown>h4,.markdown>h5,.markdown>h6{margin-top:calc(var(--ifm-heading-vertical-rhythm-top)*var(--ifm-leading))}.markdown>p,.markdown>pre,.markdown>ul{margin-bottom:var(--ifm-leading)}.markdown li>p{margin-top:var(--ifm-list-paragraph-margin)}.markdown li+li{margin-top:var(--ifm-list-item-margin)}ol,ul{margin:0 0 var(--ifm-list-margin);padding-left:var(--ifm-list-left-padding)}ol ol,ul ol{list-style-type:lower-roman}ol ol ol,ol ul ol,ul ol ol,ul ul ol{list-style-type:lower-alpha}table{border-collapse:collapse;display:block;margin-bottom:var(--ifm-spacing-vertical)}table thead tr{border-bottom:2px solid var(--ifm-table-border-color)}table thead,table tr:nth-child(2n){background-color:var(--ifm-table-stripe-background)}table tr{background-color:var(--ifm-table-background);border-top:var(--ifm-table-border-width) solid var(--ifm-table-border-color)}table td,table th{border:var(--ifm-table-border-width) solid var(--ifm-table-border-color);padding:var(--ifm-table-cell-padding)}table th{background-color:var(--ifm-table-head-background);color:var(--ifm-table-head-color);font-weight:var(--ifm-table-head-font-weight)}table td{color:var(--ifm-table-cell-color)}strong{font-weight:var(--ifm-font-weight-bold)}a{color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}a:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button:hover,.text--no-decoration,.text--no-decoration:hover,a:not([href]){text-decoration:none}p{margin:0 0 var(--ifm-paragraph-margin-bottom)}blockquote{border-left:var(--ifm-blockquote-border-left-width) solid var(--ifm-blockquote-border-color);box-shadow:var(--ifm-blockquote-shadow);color:var(--ifm-blockquote-color);font-size:var(--ifm-blockquote-font-size);padding:var(--ifm-blockquote-padding-vertical) var(--ifm-blockquote-padding-horizontal)}blockquote>:first-child{margin-top:0}blockquote>:last-child{margin-bottom:0}hr{background-color:var(--ifm-hr-background-color);border:0;height:var(--ifm-hr-height);margin:var(--ifm-hr-margin-vertical) 0}.shadow--lw{box-shadow:var(--ifm-global-shadow-lw)!important}.shadow--md{box-shadow:var(--ifm-global-shadow-md)!important}.shadow--tl{box-shadow:var(--ifm-global-shadow-tl)!important}.text--primary,.wordWrapButtonEnabled_EoeP .wordWrapButtonIcon_Bwma{color:var(--ifm-color-primary)}.text--secondary{color:var(--ifm-color-secondary)}.text--success{color:var(--ifm-color-success)}.text--info{color:var(--ifm-color-info)}.text--warning{color:var(--ifm-color-warning)}.text--danger{color:var(--ifm-color-danger)}.text--center{text-align:center}.text--left{text-align:left}.text--justify{text-align:justify}.text--right{text-align:right}.text--capitalize{text-transform:capitalize}.text--lowercase{text-transform:lowercase}.admonitionHeading_Gvgb,.alert__heading,.text--uppercase{text-transform:uppercase}.text--light{font-weight:var(--ifm-font-weight-light)}.text--normal{font-weight:var(--ifm-font-weight-normal)}.text--semibold{font-weight:var(--ifm-font-weight-semibold)}.text--bold{font-weight:var(--ifm-font-weight-bold)}.text--italic{font-style:italic}.text--truncate{overflow:hidden;text-overflow:ellipsis}.text--break{word-wrap:break-word!important;word-break:break-word!important}.clean-btn{background:none;border:none;color:inherit;cursor:pointer;font-family:inherit;padding:0}.alert,.alert .close{color:var(--ifm-alert-foreground-color)}.clean-list{padding-left:0}.alert--primary{--ifm-alert-background-color:var(--ifm-color-primary-contrast-background);--ifm-alert-background-color-highlight:#3578e526;--ifm-alert-foreground-color:var(--ifm-color-primary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-primary-dark)}.alert--secondary{--ifm-alert-background-color:var(--ifm-color-secondary-contrast-background);--ifm-alert-background-color-highlight:#ebedf026;--ifm-alert-foreground-color:var(--ifm-color-secondary-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-secondary-dark)}.alert--success{--ifm-alert-background-color:var(--ifm-color-success-contrast-background);--ifm-alert-background-color-highlight:#00a40026;--ifm-alert-foreground-color:var(--ifm-color-success-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-success-dark)}.alert--info{--ifm-alert-background-color:var(--ifm-color-info-contrast-background);--ifm-alert-background-color-highlight:#54c7ec26;--ifm-alert-foreground-color:var(--ifm-color-info-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-info-dark)}.alert--warning{--ifm-alert-background-color:var(--ifm-color-warning-contrast-background);--ifm-alert-background-color-highlight:#ffba0026;--ifm-alert-foreground-color:var(--ifm-color-warning-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-warning-dark)}.alert--danger{--ifm-alert-background-color:var(--ifm-color-danger-contrast-background);--ifm-alert-background-color-highlight:#fa383e26;--ifm-alert-foreground-color:var(--ifm-color-danger-contrast-foreground);--ifm-alert-border-color:var(--ifm-color-danger-dark)}.alert{--ifm-code-background:var(--ifm-alert-background-color-highlight);--ifm-link-color:var(--ifm-alert-foreground-color);--ifm-link-hover-color:var(--ifm-alert-foreground-color);--ifm-link-decoration:underline;--ifm-tabs-color:var(--ifm-alert-foreground-color);--ifm-tabs-color-active:var(--ifm-alert-foreground-color);--ifm-tabs-color-active-border:var(--ifm-alert-border-color);background-color:var(--ifm-alert-background-color);border:var(--ifm-alert-border-width) solid var(--ifm-alert-border-color);border-left-width:var(--ifm-alert-border-left-width);border-radius:var(--ifm-alert-border-radius);box-shadow:var(--ifm-alert-shadow);padding:var(--ifm-alert-padding-vertical) var(--ifm-alert-padding-horizontal)}.alert__heading{align-items:center;display:flex;font:700 var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family);margin-bottom:.5rem}.alert__icon{display:inline-flex;margin-right:.4em}.alert__icon svg{fill:var(--ifm-alert-foreground-color);stroke:var(--ifm-alert-foreground-color);stroke-width:0}.alert .close{margin:calc(var(--ifm-alert-padding-vertical)*-1) calc(var(--ifm-alert-padding-horizontal)*-1) 0 0;opacity:.75}.alert .close:focus,.alert .close:hover{opacity:1}.alert a{text-decoration-color:var(--ifm-alert-border-color)}.alert a:hover{text-decoration-thickness:2px}.avatar{column-gap:var(--ifm-avatar-intro-margin);display:flex}.avatar__photo{border-radius:50%;display:block;height:var(--ifm-avatar-photo-size);overflow:hidden;width:var(--ifm-avatar-photo-size)}.card--full-height,.navbar__logo img,body,html{height:100%}.avatar__photo--sm{--ifm-avatar-photo-size:2rem}.avatar__photo--lg{--ifm-avatar-photo-size:4rem}.avatar__photo--xl{--ifm-avatar-photo-size:6rem}.avatar__intro{display:flex;flex:1 1;flex-direction:column;justify-content:center;text-align:var(--ifm-avatar-intro-alignment)}.badge,.breadcrumbs__item,.breadcrumbs__link,.button,.dropdown>.navbar__link:after{display:inline-block}.avatar__name{font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base)}.avatar__subtitle{margin-top:.25rem}.avatar--vertical{--ifm-avatar-intro-alignment:center;--ifm-avatar-intro-margin:0.5rem;align-items:center;flex-direction:column}.badge{background-color:var(--ifm-badge-background-color);border:var(--ifm-badge-border-width) solid var(--ifm-badge-border-color);border-radius:var(--ifm-badge-border-radius);color:var(--ifm-badge-color);font-size:75%;font-weight:var(--ifm-font-weight-bold);line-height:1;padding:var(--ifm-badge-padding-vertical) var(--ifm-badge-padding-horizontal)}.badge--primary{--ifm-badge-background-color:var(--ifm-color-primary)}.badge--secondary{--ifm-badge-background-color:var(--ifm-color-secondary);color:var(--ifm-color-black)}.breadcrumbs__link,.button.button--secondary.button--outline:not(.button--active):not(:hover){color:var(--ifm-font-color-base)}.badge--success{--ifm-badge-background-color:var(--ifm-color-success)}.badge--info{--ifm-badge-background-color:var(--ifm-color-info)}.badge--warning{--ifm-badge-background-color:var(--ifm-color-warning)}.badge--danger{--ifm-badge-background-color:var(--ifm-color-danger)}.breadcrumbs{margin-bottom:0;padding-left:0}.breadcrumbs__item:not(:last-child):after{background:var(--ifm-breadcrumb-separator) center;content:" ";display:inline-block;filter:var(--ifm-breadcrumb-separator-filter);height:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier));margin:0 var(--ifm-breadcrumb-spacing);opacity:.5;width:calc(var(--ifm-breadcrumb-separator-size)*var(--ifm-breadcrumb-size-multiplier)*var(--ifm-breadcrumb-separator-size-multiplier))}.breadcrumbs__item--active .breadcrumbs__link{background:var(--ifm-breadcrumb-item-background-active);color:var(--ifm-breadcrumb-color-active)}.breadcrumbs__link{border-radius:var(--ifm-breadcrumb-border-radius);font-size:calc(1rem*var(--ifm-breadcrumb-size-multiplier));padding:calc(var(--ifm-breadcrumb-padding-vertical)*var(--ifm-breadcrumb-size-multiplier)) calc(var(--ifm-breadcrumb-padding-horizontal)*var(--ifm-breadcrumb-size-multiplier));transition-duration:var(--ifm-transition-fast);transition-property:background,color}.breadcrumbs__link:any-link:hover,.breadcrumbs__link:link:hover,.breadcrumbs__link:visited:hover,area[href].breadcrumbs__link:hover{background:var(--ifm-breadcrumb-item-background-active);text-decoration:none}.breadcrumbs--sm{--ifm-breadcrumb-size-multiplier:0.8}.breadcrumbs--lg{--ifm-breadcrumb-size-multiplier:1.2}.button{background-color:var(--ifm-button-background-color);border:var(--ifm-button-border-width) solid var(--ifm-button-border-color);border-radius:var(--ifm-button-border-radius);cursor:pointer;font-size:calc(.875rem*var(--ifm-button-size-multiplier));font-weight:var(--ifm-button-font-weight);line-height:1.5;padding:calc(var(--ifm-button-padding-vertical)*var(--ifm-button-size-multiplier)) calc(var(--ifm-button-padding-horizontal)*var(--ifm-button-size-multiplier));text-align:center;transition-duration:var(--ifm-button-transition-duration);transition-property:color,background,border-color;-webkit-user-select:none;user-select:none}.button,.button:hover{color:var(--ifm-button-color)}.button--outline{--ifm-button-color:var(--ifm-button-border-color)}.button--outline:hover{--ifm-button-background-color:var(--ifm-button-border-color)}.button--link{--ifm-button-border-color:#0000;color:var(--ifm-link-color);text-decoration:var(--ifm-link-decoration)}.button--link.button--active,.button--link:active,.button--link:hover{color:var(--ifm-link-hover-color);text-decoration:var(--ifm-link-hover-decoration)}.button.disabled,.button:disabled,.button[disabled]{opacity:.65;pointer-events:none}.button--sm{--ifm-button-size-multiplier:0.8}.button--lg{--ifm-button-size-multiplier:1.35}.button--block{display:block;width:100%}.button.button--secondary{color:var(--ifm-color-gray-900)}:where(.button--primary){--ifm-button-background-color:var(--ifm-color-primary);--ifm-button-border-color:var(--ifm-color-primary)}:where(.button--primary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-primary-dark);--ifm-button-border-color:var(--ifm-color-primary-dark)}.button--primary.button--active,.button--primary:active{--ifm-button-background-color:var(--ifm-color-primary-darker);--ifm-button-border-color:var(--ifm-color-primary-darker)}:where(.button--secondary){--ifm-button-background-color:var(--ifm-color-secondary);--ifm-button-border-color:var(--ifm-color-secondary)}:where(.button--secondary):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-secondary-dark);--ifm-button-border-color:var(--ifm-color-secondary-dark)}.button--secondary.button--active,.button--secondary:active{--ifm-button-background-color:var(--ifm-color-secondary-darker);--ifm-button-border-color:var(--ifm-color-secondary-darker)}:where(.button--success){--ifm-button-background-color:var(--ifm-color-success);--ifm-button-border-color:var(--ifm-color-success)}:where(.button--success):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-success-dark);--ifm-button-border-color:var(--ifm-color-success-dark)}.button--success.button--active,.button--success:active{--ifm-button-background-color:var(--ifm-color-success-darker);--ifm-button-border-color:var(--ifm-color-success-darker)}:where(.button--info){--ifm-button-background-color:var(--ifm-color-info);--ifm-button-border-color:var(--ifm-color-info)}:where(.button--info):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-info-dark);--ifm-button-border-color:var(--ifm-color-info-dark)}.button--info.button--active,.button--info:active{--ifm-button-background-color:var(--ifm-color-info-darker);--ifm-button-border-color:var(--ifm-color-info-darker)}:where(.button--warning){--ifm-button-background-color:var(--ifm-color-warning);--ifm-button-border-color:var(--ifm-color-warning)}:where(.button--warning):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-warning-dark);--ifm-button-border-color:var(--ifm-color-warning-dark)}.button--warning.button--active,.button--warning:active{--ifm-button-background-color:var(--ifm-color-warning-darker);--ifm-button-border-color:var(--ifm-color-warning-darker)}:where(.button--danger){--ifm-button-background-color:var(--ifm-color-danger);--ifm-button-border-color:var(--ifm-color-danger)}:where(.button--danger):not(.button--outline):hover{--ifm-button-background-color:var(--ifm-color-danger-dark);--ifm-button-border-color:var(--ifm-color-danger-dark)}.button--danger.button--active,.button--danger:active{--ifm-button-background-color:var(--ifm-color-danger-darker);--ifm-button-border-color:var(--ifm-color-danger-darker)}.button-group{display:inline-flex;gap:var(--ifm-button-group-spacing)}.button-group>.button:not(:first-child){border-bottom-left-radius:0;border-top-left-radius:0}.button-group>.button:not(:last-child){border-bottom-right-radius:0;border-top-right-radius:0}.button-group--block{display:flex;justify-content:stretch}.button-group--block>.button{flex-grow:1}.card{background-color:var(--ifm-card-background-color);border-radius:var(--ifm-card-border-radius);box-shadow:var(--ifm-global-shadow-lw);display:flex;flex-direction:column;overflow:hidden}.card__image{padding-top:var(--ifm-card-vertical-spacing)}.card__image:first-child{padding-top:0}.card__body,.card__footer,.card__header{padding:var(--ifm-card-vertical-spacing) var(--ifm-card-horizontal-spacing)}.card__body:not(:last-child),.card__footer:not(:last-child),.card__header:not(:last-child){padding-bottom:0}.card__body>:last-child,.card__footer>:last-child,.card__header>:last-child{margin-bottom:0}.card__footer{margin-top:auto}.table-of-contents{font-size:.8rem;margin-bottom:0;padding:var(--ifm-toc-padding-vertical) 0}.table-of-contents,.table-of-contents ul{list-style:none;padding-left:var(--ifm-toc-padding-horizontal)}.table-of-contents li{margin:var(--ifm-toc-padding-vertical) var(--ifm-toc-padding-horizontal)}.table-of-contents__left-border{border-left:1px solid var(--ifm-toc-border-color)}.table-of-contents__link{color:var(--ifm-toc-link-color);display:block}.table-of-contents__link--active,.table-of-contents__link--active code,.table-of-contents__link:hover,.table-of-contents__link:hover code{color:var(--ifm-color-primary);text-decoration:none}.close{color:var(--ifm-color-black);float:right;font-size:1.5rem;font-weight:var(--ifm-font-weight-bold);line-height:1;opacity:.5;padding:1rem;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.close:hover{opacity:.7}.close:focus,.theme-code-block-highlighted-line .codeLineNumber_Tfdd:before{opacity:.8}.dropdown{display:inline-flex;font-weight:var(--ifm-dropdown-font-weight);position:relative;vertical-align:top}.dropdown--hoverable:hover .dropdown__menu,.dropdown--show .dropdown__menu{opacity:1;pointer-events:all;transform:translateY(-1px);visibility:visible}#nprogress,.dropdown__menu,.navbar__item.dropdown .navbar__link:not([href]){pointer-events:none}.dropdown--right .dropdown__menu{left:inherit;right:0}.dropdown--nocaret .navbar__link:after{content:none!important}.dropdown__menu{background-color:var(--ifm-dropdown-background-color);border-radius:var(--ifm-global-radius);box-shadow:var(--ifm-global-shadow-md);left:0;max-height:80vh;min-width:10rem;opacity:0;overflow-y:auto;padding:.5rem;position:absolute;top:calc(100% - var(--ifm-navbar-item-padding-vertical) + .3rem);transform:translateY(-.625rem);transition-duration:var(--ifm-transition-fast);transition-property:opacity,transform,visibility;transition-timing-function:var(--ifm-transition-timing-default);visibility:hidden;z-index:var(--ifm-z-index-dropdown)}.menu__caret,.menu__link,.menu__list-item-collapsible{border-radius:.25rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.dropdown__link{border-radius:.25rem;color:var(--ifm-dropdown-link-color);display:block;font-size:.875rem;margin-top:.2rem;padding:.25rem .5rem}.dropdown__link--active,.dropdown__link:hover{background-color:var(--ifm-dropdown-hover-background-color);color:var(--ifm-dropdown-link-color);text-decoration:none}.dropdown__link--active,.dropdown__link--active:hover{--ifm-dropdown-link-color:var(--ifm-link-color)}.dropdown>.navbar__link:after{border-color:currentcolor #0000;border-style:solid;border-width:.4em .4em 0;content:"";margin-left:.3em;position:relative;top:2px;transform:translateY(-50%)}.footer{background-color:var(--ifm-footer-background-color);color:var(--ifm-footer-color);padding:var(--ifm-footer-padding-vertical) var(--ifm-footer-padding-horizontal)}.footer--dark{--ifm-footer-background-color:#303846;--ifm-footer-color:var(--ifm-footer-link-color);--ifm-footer-link-color:var(--ifm-color-secondary);--ifm-footer-title-color:var(--ifm-color-white)}.footer__links{margin-bottom:1rem}.footer__link-item{color:var(--ifm-footer-link-color);line-height:2}.footer__link-item:hover{color:var(--ifm-footer-link-hover-color)}.footer__link-separator{margin:0 var(--ifm-footer-link-horizontal-spacing)}.footer__logo{margin-top:1rem;max-width:var(--ifm-footer-logo-max-width)}.footer__title{color:var(--ifm-footer-title-color);font:700 var(--ifm-h4-font-size)/var(--ifm-heading-line-height) var(--ifm-font-family-base);margin-bottom:var(--ifm-heading-margin-bottom)}.menu,.navbar__link{font-weight:var(--ifm-font-weight-semibold)}.nasa,.nasa-black,.nasa-red{font-family:nasalization}.docItemContainer_Djhp article>:first-child,.docItemContainer_Djhp header+*,.footer__item{margin-top:0}.admonitionContent_BuS1>:last-child,.collapsibleContent_i85q p:last-child,.details_lb9f>summary>p:last-child,.footer__items{margin-bottom:0}.codeBlockStandalone_MEMb,[type=checkbox]{padding:0}.hero{align-items:center;background-color:var(--ifm-hero-background-color);color:var(--ifm-hero-text-color);display:flex;padding:4rem 2rem}.hero--primary{--ifm-hero-background-color:var(--ifm-color-primary);--ifm-hero-text-color:var(--ifm-font-color-base-inverse)}.hero--dark{--ifm-hero-background-color:#303846;--ifm-hero-text-color:var(--ifm-color-white)}.hero__title{font-size:3rem}.hero__subtitle{font-size:1.5rem}.menu__list{margin:0;padding-left:0}.menu__caret,.menu__link{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu__list .menu__list{flex:0 0 100%;margin-top:.25rem;padding-left:var(--ifm-menu-link-padding-horizontal)}.menu__list-item:not(:first-child){margin-top:.25rem}.menu__list-item--collapsed .menu__list{height:0;overflow:hidden}.details_lb9f[data-collapsed=false].isBrowser_bmU9>summary:before,.details_lb9f[open]:not(.isBrowser_bmU9)>summary:before,.menu__list-item--collapsed .menu__caret:before,.menu__list-item--collapsed .menu__link--sublist:after{transform:rotate(90deg)}.menu__list-item-collapsible{display:flex;flex-wrap:wrap;position:relative}.menu__caret:hover,.menu__link:hover,.menu__list-item-collapsible--active,.menu__list-item-collapsible:hover{background:var(--ifm-menu-color-background-hover)}.menu__list-item-collapsible .menu__link--active,.menu__list-item-collapsible .menu__link:hover{background:none!important}.menu__caret,.menu__link{align-items:center;display:flex}.navbar-sidebar,.navbar-sidebar__backdrop{bottom:0;opacity:0;top:0;transition-duration:var(--ifm-transition-fast);transition-timing-function:ease-in-out;visibility:hidden;left:0}.menu__link{color:var(--ifm-menu-color);flex:1;line-height:1.25}.menu__link:hover{color:var(--ifm-menu-color);text-decoration:none}.menu__caret:before,.menu__link--sublist-caret:after{height:1.25rem;transform:rotate(180deg);transition:transform var(--ifm-transition-fast) linear;width:1.25rem;content:"";filter:var(--ifm-menu-link-sublist-icon-filter)}.menu__link--sublist-caret:after{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem;margin-left:auto;min-width:1.25rem}.menu__link--active,.menu__link--active:hover{color:var(--ifm-menu-color-active)}.navbar__brand,.navbar__link{color:var(--ifm-navbar-link-color)}.menu__link--active:not(.menu__link--sublist){background-color:var(--ifm-menu-color-background-active)}.menu__caret:before{background:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem}.navbar--dark,html[data-theme=dark]{--ifm-menu-link-sublist-icon-filter:invert(100%) sepia(94%) saturate(17%) hue-rotate(223deg) brightness(104%) contrast(98%)}.navbar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-navbar-shadow);height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.navbar,.navbar>.container,.navbar>.container-fluid{display:flex}.navbar--fixed-top{position:sticky;top:0;z-index:var(--ifm-z-index-fixed)}.navbar__inner{display:flex;flex-wrap:wrap;justify-content:space-between;width:100%}.navbar__brand{align-items:center;display:flex;margin-right:1rem;min-width:0}.navbar__brand:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.announcementBarContent_xLdY,.navbar__title{flex:1 1 auto}.navbar__toggle{display:none;margin-right:.5rem}.navbar__logo{flex:0 0 auto;height:2rem;margin-right:.5rem}.navbar__items{align-items:center;display:flex;flex:1;min-width:0}.navbar__items--center{flex:0 0 auto}.navbar__items--center .navbar__brand{margin:0}.navbar__items--center+.navbar__items--right{flex:1}.navbar__items--right{flex:0 0 auto;justify-content:flex-end}.navbar__items--right>:last-child{padding-right:0}.navbar__item{display:inline-block;padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.navbar__link--active,.navbar__link:hover{color:var(--ifm-navbar-link-hover-color);text-decoration:none}.navbar--dark,.navbar--primary{--ifm-menu-color:var(--ifm-color-gray-300);--ifm-navbar-link-color:var(--ifm-color-gray-100);--ifm-navbar-search-input-background-color:#ffffff1a;--ifm-navbar-search-input-placeholder-color:#ffffff80;color:var(--ifm-color-white)}.navbar--dark{--ifm-navbar-background-color:#242526;--ifm-menu-color-background-active:#ffffff0d;--ifm-navbar-search-input-color:var(--ifm-color-white)}.navbar--primary{--ifm-navbar-background-color:var(--ifm-color-primary);--ifm-navbar-link-hover-color:var(--ifm-color-white);--ifm-menu-color-active:var(--ifm-color-white);--ifm-navbar-search-input-color:var(--ifm-color-emphasis-500)}.navbar__search-input{appearance:none;background:var(--ifm-navbar-search-input-background-color) var(--ifm-navbar-search-input-icon) no-repeat .75rem center/1rem 1rem;border:none;border-radius:2rem;color:var(--ifm-navbar-search-input-color);cursor:text;display:inline-block;font-size:.9rem;height:2rem;padding:0 .5rem 0 2.25rem;width:12.5rem}.navbar__search-input::placeholder{color:var(--ifm-navbar-search-input-placeholder-color)}.navbar-sidebar{background-color:var(--ifm-navbar-background-color);box-shadow:var(--ifm-global-shadow-md);position:fixed;transform:translate3d(-100%,0,0);transition-property:opacity,visibility,transform;width:var(--ifm-navbar-sidebar-width)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar__items{transform:translateZ(0)}.navbar-sidebar--show .navbar-sidebar,.navbar-sidebar--show .navbar-sidebar__backdrop{opacity:1;visibility:visible}.navbar-sidebar__backdrop{background-color:#0009;position:fixed;right:0;transition-property:opacity,visibility}.navbar-sidebar__brand{align-items:center;box-shadow:var(--ifm-navbar-shadow);display:flex;flex:1;height:var(--ifm-navbar-height);padding:var(--ifm-navbar-padding-vertical) var(--ifm-navbar-padding-horizontal)}.navbar-sidebar__items{display:flex;height:calc(100% - var(--ifm-navbar-height));transition:transform var(--ifm-transition-fast) ease-in-out}.navbar-sidebar__items--show-secondary{transform:translate3d(calc((var(--ifm-navbar-sidebar-width))*-1),0,0)}.navbar-sidebar__item{flex-shrink:0;padding:.5rem;width:calc(var(--ifm-navbar-sidebar-width))}.navbar-sidebar__back{background:var(--ifm-menu-color-background-active);font-size:15px;font-weight:var(--ifm-button-font-weight);margin:0 0 .2rem -.5rem;padding:.6rem 1.5rem;position:relative;text-align:left;top:-.5rem;width:calc(100% + 1rem)}.navbar-sidebar__close{display:flex;margin-left:auto}.pagination{column-gap:var(--ifm-pagination-page-spacing);display:flex;font-size:var(--ifm-pagination-font-size);padding-left:0}.pagination--sm{--ifm-pagination-font-size:0.8rem;--ifm-pagination-padding-horizontal:0.8rem;--ifm-pagination-padding-vertical:0.2rem}.pagination--lg{--ifm-pagination-font-size:1.2rem;--ifm-pagination-padding-horizontal:1.2rem;--ifm-pagination-padding-vertical:0.3rem}.pagination__item{display:inline-flex}.pagination__item>span{padding:var(--ifm-pagination-padding-vertical)}.pagination__item--active .pagination__link{color:var(--ifm-pagination-color-active)}.pagination__item--active .pagination__link,.pagination__item:not(.pagination__item--active):hover .pagination__link{background:var(--ifm-pagination-item-active-background)}.pagination__item--disabled,.pagination__item[disabled]{opacity:.25;pointer-events:none}.pagination__link{border-radius:var(--ifm-pagination-border-radius);color:var(--ifm-font-color-base);display:inline-block;padding:var(--ifm-pagination-padding-vertical) var(--ifm-pagination-padding-horizontal);transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination__link:hover{text-decoration:none}.pagination-nav{display:grid;grid-gap:var(--ifm-spacing-horizontal);gap:var(--ifm-spacing-horizontal);grid-template-columns:repeat(2,1fr)}.pagination-nav__link{border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-pagination-nav-border-radius);display:block;height:100%;line-height:var(--ifm-heading-line-height);padding:var(--ifm-global-spacing);transition:border-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pagination-nav__link:hover{border-color:var(--ifm-pagination-nav-color-hover);text-decoration:none}.pagination-nav__link--next{grid-column:2/3;text-align:right}.pagination-nav__label{font-size:var(--ifm-h4-font-size);font-weight:var(--ifm-heading-font-weight);word-break:break-word}.pagination-nav__link--prev .pagination-nav__label:before{content:"« "}.pagination-nav__link--next .pagination-nav__label:after{content:" »"}.pagination-nav__sublabel{color:var(--ifm-color-content-secondary);font-size:var(--ifm-h5-font-size);font-weight:var(--ifm-font-weight-semibold);margin-bottom:.25rem}.pills__item,.tabs{font-weight:var(--ifm-font-weight-bold)}.pills{display:flex;gap:var(--ifm-pills-spacing);padding-left:0}.pills__item{border-radius:.5rem;cursor:pointer;display:inline-block;padding:.25rem 1rem;transition:background var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.pills__item--active{color:var(--ifm-pills-color-active)}.pills__item--active,.pills__item:not(.pills__item--active):hover{background:var(--ifm-pills-color-background-active)}.pills--block{justify-content:stretch}.pills--block .pills__item{flex-grow:1;text-align:center}.tabs{color:var(--ifm-tabs-color);display:flex;margin-bottom:0;overflow-x:auto;padding-left:0}.tabs__item{border-bottom:3px solid #0000;border-radius:var(--ifm-global-radius);cursor:pointer;display:inline-flex;padding:var(--ifm-tabs-padding-vertical) var(--ifm-tabs-padding-horizontal);transition:background-color var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.tabs__item--active{border-bottom-color:var(--ifm-tabs-color-active-border);border-bottom-left-radius:0;border-bottom-right-radius:0;color:var(--ifm-tabs-color-active)}.tabs__item:hover{background-color:var(--ifm-hover-overlay)}.tabs--block{justify-content:stretch}.tabs--block .tabs__item{flex-grow:1;justify-content:center}html[data-theme=dark]{--ifm-color-scheme:dark;--ifm-color-emphasis-0:var(--ifm-color-gray-1000);--ifm-color-emphasis-100:var(--ifm-color-gray-900);--ifm-color-emphasis-200:var(--ifm-color-gray-800);--ifm-color-emphasis-300:var(--ifm-color-gray-700);--ifm-color-emphasis-400:var(--ifm-color-gray-600);--ifm-color-emphasis-600:var(--ifm-color-gray-400);--ifm-color-emphasis-700:var(--ifm-color-gray-300);--ifm-color-emphasis-800:var(--ifm-color-gray-200);--ifm-color-emphasis-900:var(--ifm-color-gray-100);--ifm-color-emphasis-1000:var(--ifm-color-gray-0);--ifm-background-color:#1b1b1d;--ifm-background-surface-color:#242526;--ifm-hover-overlay:#ffffff0d;--ifm-color-content:#e3e3e3;--ifm-color-content-secondary:#fff;--ifm-breadcrumb-separator-filter:invert(64%) sepia(11%) saturate(0%) hue-rotate(149deg) brightness(99%) contrast(95%);--ifm-code-background:#ffffff1a;--ifm-scrollbar-track-background-color:#444;--ifm-scrollbar-thumb-background-color:#686868;--ifm-scrollbar-thumb-hover-background-color:#7a7a7a;--ifm-table-stripe-background:#ffffff12;--ifm-toc-border-color:var(--ifm-color-emphasis-200);--ifm-color-primary-contrast-background:#102445;--ifm-color-primary-contrast-foreground:#ebf2fc;--ifm-color-secondary-contrast-background:#474748;--ifm-color-secondary-contrast-foreground:#fdfdfe;--ifm-color-success-contrast-background:#003100;--ifm-color-success-contrast-foreground:#e6f6e6;--ifm-color-info-contrast-background:#193c47;--ifm-color-info-contrast-foreground:#eef9fd;--ifm-color-warning-contrast-background:#4d3800;--ifm-color-warning-contrast-foreground:#fff8e6;--ifm-color-danger-contrast-background:#4b1113;--ifm-color-danger-contrast-foreground:#ffebec}#nprogress .bar{background:var(--docusaurus-progress-bar-color);height:2px;left:0;position:fixed;top:0;width:100%;z-index:1031}#nprogress .peg{box-shadow:0 0 10px var(--docusaurus-progress-bar-color),0 0 5px var(--docusaurus-progress-bar-color);height:100%;opacity:1;position:absolute;right:0;transform:rotate(3deg) translateY(-4px);width:100px}[data-theme=dark]{--ifm-color-primary:#b2b2b3;--ifm-color-primary-dark:#a0a0a1;--ifm-color-primary-darker:#979798;--ifm-color-primary-darkest:#7c7c7e;--ifm-color-primary-light:#c4c4c5;--ifm-color-primary-lighter:#cdcdce;--ifm-color-primary-lightest:#e8e8e8}.simple-class{border:2px solid #000;border-radius:10px;color:#00f;height:1200px;padding:10px;width:1200px}.hero,.simple-class{background-image:url(/assets/images/rgs-hero-bg-73cc38de749fd232a41954c4aa3ce93d.svg)}.hero{background-color:#d3d3d3;background-position:bottom;background-repeat:no-repeat}.hero__title,.nasa-black{color:#000}.hero__subtitle{color:hsla(0,3%,6%,.678)}@font-face{font-family:nasalization;src:url(/assets/fonts/nasalization-4cbf2019f1f7337b2594cc91085c46b3.otf)}.nasa-red{color:red}.tag_zVej{border:1px solid var(--docusaurus-tag-list-border);transition:border var(--ifm-transition-fast)}.tag_zVej:hover{--docusaurus-tag-list-border:var(--ifm-link-color);text-decoration:none}.tagRegular_sFm0{border-radius:var(--ifm-global-radius);font-size:90%;padding:.2rem .5rem .3rem}.tagWithCount_h2kH{align-items:center;border-left:0;display:flex;padding:0 .5rem 0 1rem;position:relative}.tagWithCount_h2kH:after,.tagWithCount_h2kH:before{border:1px solid var(--docusaurus-tag-list-border);content:"";position:absolute;top:50%;transition:inherit}.tagWithCount_h2kH:before{border-bottom:0;border-right:0;height:1.18rem;right:100%;transform:translate(50%,-50%) rotate(-45deg);width:1.18rem}.tagWithCount_h2kH:after{border-radius:50%;height:.5rem;left:0;transform:translateY(-50%);width:.5rem}.tagWithCount_h2kH span{background:var(--ifm-color-secondary);border-radius:var(--ifm-global-radius);color:var(--ifm-color-black);font-size:.7rem;line-height:1.2;margin-left:.3rem;padding:.1rem .4rem}.tags_jXut{display:inline}.searchbox,.searchbox__input,.tag_QGVx{display:inline-block}.tag_QGVx{margin:0 .4rem .5rem 0}.backToTopButton_sjWU{background-color:var(--ifm-color-emphasis-200);border-radius:50%;bottom:1.3rem;box-shadow:var(--ifm-global-shadow-lw);height:3rem;opacity:0;position:fixed;right:1.3rem;transform:scale(0);transition:all var(--ifm-transition-fast) var(--ifm-transition-timing-default);visibility:hidden;width:3rem;z-index:calc(var(--ifm-z-index-fixed) - 1)}.backToTopButton_sjWU:after{background-color:var(--ifm-color-emphasis-1000);content:" ";display:inline-block;height:100%;-webkit-mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;mask:var(--ifm-menu-link-sublist-icon) 50%/2rem 2rem no-repeat;width:100%}.backToTopButtonShow_xfvO{opacity:1;transform:scale(1);visibility:visible}.algolia-docsearch-suggestion{border-bottom-color:#3a3dd1}.algolia-docsearch-suggestion--category-header{background-color:#4b54de}.algolia-docsearch-suggestion--highlight{color:#3a33d1}.algolia-docsearch-suggestion--category-header .algolia-docsearch-suggestion--highlight{background-color:#4d47d5}.aa-cursor .algolia-docsearch-suggestion--content{color:#272296}.aa-cursor .algolia-docsearch-suggestion{background:#ebebfb}.searchbox{height:32px!important;position:relative;visibility:visible!important;width:200px}.searchbox .algolia-autocomplete{display:block;height:100%;width:100%}.searchbox__wrapper{height:100%;position:relative;width:100%;z-index:999}.searchbox__input{appearance:none;background:#fff!important;border:0;border-radius:16px;box-shadow:inset 0 0 0 1px #ccc;font-size:12px;height:100%;padding:0 26px 0 32px;transition:box-shadow .4s,background .4s;vertical-align:middle;white-space:normal;width:100%}.searchbox__reset,.searchbox__submit{font-size:inherit;-webkit-user-select:none;position:absolute}.searchbox__input::-webkit-search-cancel-button,.searchbox__input::-webkit-search-decoration,.searchbox__input::-webkit-search-results-button,.searchbox__input::-webkit-search-results-decoration{display:none}.searchbox__input:hover{box-shadow:inset 0 0 0 1px #b3b3b3}.searchbox__input:active,.searchbox__input:focus{background:#fff;box-shadow:inset 0 0 0 1px #aaa;outline:0}.searchbox__input::placeholder{color:#aaa}.searchbox__submit{background-color:#458ee100;border:0;border-radius:16px 0 0 16px;height:100%;left:0;margin:0;padding:0;right:inherit;text-align:center;top:0;user-select:none;vertical-align:middle;width:32px}.searchbox__submit:before{content:"";display:inline-block;height:100%;margin-right:-4px;vertical-align:middle}.algolia-autocomplete .ds-dropdown-menu .ds-suggestion,.dropdownNavbarItemMobile_S0Fm,.searchbox__submit:active,.searchbox__submit:hover{cursor:pointer}.searchbox__submit svg{height:14px;vertical-align:middle;width:14px;fill:#6d7e96}.searchbox__reset{background:none;border:0;cursor:pointer;display:block;margin:0;padding:0;right:8px;top:8px;user-select:none;fill:#00000080}.searchbox__reset.hide{display:none}.searchbox__reset svg{display:block;height:8px;margin:4px;width:8px}.searchbox__input:valid~.searchbox__reset{animation-duration:.15s;animation-name:a;display:block}@keyframes a{0%{opacity:0;transform:translate3d(-20%,0,0)}to{opacity:1;transform:none}}.algolia-autocomplete .ds-dropdown-menu:before{background:#373940;border-radius:2px;border-right:1px solid #373940;border-top:1px solid #373940;content:"";display:block;height:14px;position:absolute;top:-7px;transform:rotate(-45deg);width:14px;z-index:1000}.algolia-autocomplete .ds-dropdown-menu{box-shadow:0 1px 0 0 #0003,0 2px 3px 0 #0000001a}.algolia-autocomplete .ds-dropdown-menu .ds-suggestions{position:relative;z-index:1000}.algolia-autocomplete .ds-dropdown-menu [class^=ds-dataset-]{background:#fff;border-radius:4px;overflow:auto;padding:0;position:relative}.algolia-autocomplete .algolia-docsearch-suggestion{display:block;overflow:hidden;padding:0;position:relative;text-decoration:none}.algolia-autocomplete .ds-cursor .algolia-docsearch-suggestion--wrapper{background:#f1f1f1;box-shadow:inset -2px 0 0 #61dafb}.algolia-autocomplete .algolia-docsearch-suggestion--highlight{background:#ffe564;padding:.1em .05em}.algolia-autocomplete .algolia-docsearch-suggestion--category-header .algolia-docsearch-suggestion--category-header-lvl0 .algolia-docsearch-suggestion--highlight,.algolia-autocomplete .algolia-docsearch-suggestion--category-header .algolia-docsearch-suggestion--category-header-lvl1 .algolia-docsearch-suggestion--highlight{background:inherit;color:inherit}.algolia-autocomplete .algolia-docsearch-suggestion--text .algolia-docsearch-suggestion--highlight{background:inherit;box-shadow:inset 0 -2px 0 0 #458ee1cc;color:inherit;padding:0 0 1px}.algolia-autocomplete .algolia-docsearch-suggestion--content{cursor:pointer;display:block;float:right;padding:5.33333px 0 5.33333px 10.66667px;position:relative;width:70%}.algolia-autocomplete .algolia-docsearch-suggestion--content:before{background:#ececec;content:"";display:block;height:100%;left:-1px;position:absolute;top:0;width:1px}.algolia-autocomplete .algolia-docsearch-suggestion--category-header{background-color:#373940;color:#fff;display:none;font-size:14px;font-weight:700;letter-spacing:.08em;margin:0;padding:5px 8px;position:relative;text-transform:uppercase}.algolia-autocomplete .algolia-docsearch-suggestion--wrapper{background-color:#fff;float:left;padding:8px 0 0;width:100%}.algolia-autocomplete .algolia-docsearch-suggestion--subcategory-column{color:#777;display:none;float:left;font-size:.9em;padding:5.33333px 10.66667px;position:relative;text-align:right;width:30%;word-wrap:break-word}.algolia-autocomplete .algolia-docsearch-suggestion--subcategory-column:before{background:#ececec;content:"";display:block;height:100%;position:absolute;right:0;top:0;width:1px}.algolia-autocomplete .algolia-docsearch-suggestion.algolia-docsearch-suggestion__main .algolia-docsearch-suggestion--category-header,.algolia-autocomplete .algolia-docsearch-suggestion.algolia-docsearch-suggestion__secondary{display:block}.algolia-autocomplete .algolia-docsearch-suggestion--subcategory-column .algolia-docsearch-suggestion--highlight{background-color:inherit;color:inherit}.algolia-autocomplete .algolia-docsearch-suggestion--subcategory-inline{display:none}.algolia-autocomplete .algolia-docsearch-suggestion--title{color:#02060c;font-size:.9em;font-weight:700;margin-bottom:4px}.algolia-autocomplete .algolia-docsearch-suggestion--text{color:#63676d;display:block;font-size:.85em;line-height:1.2em;padding-right:2px}.algolia-autocomplete .algolia-docsearch-suggestion--version{color:#a6aab1;display:block;font-size:.65em;padding-right:2px;padding-top:2px}.algolia-autocomplete .algolia-docsearch-suggestion--no-results{background-color:#373940;font-size:1.2em;margin-top:-8px;padding:8px 0;text-align:center;width:100%}.algolia-autocomplete .algolia-docsearch-suggestion--no-results .algolia-docsearch-suggestion--text{color:#fff;margin-top:4px}#__docusaurus-base-url-issue-banner-container,.algolia-autocomplete .algolia-docsearch-suggestion--no-results:before,.docSidebarContainer_YfHR,.navbarSearchContainer_Bca1:empty,.sidebarLogo_isFc,.themedComponent_mlkZ,[data-theme=dark] .lightToggleIcon_pyhR,[data-theme=light] .darkToggleIcon_wfgR,html[data-announcement-bar-initially-dismissed=true] .announcementBar_mb4j{display:none}.algolia-autocomplete .algolia-docsearch-suggestion code{background-color:#ebebeb;border:none;border-radius:3px;color:#222;font-family:source-code-pro,Menlo,Monaco,Consolas,Courier New,monospace;font-size:90%;padding:1px 5px}.algolia-autocomplete .algolia-docsearch-suggestion code .algolia-docsearch-suggestion--highlight{background:none}.algolia-autocomplete .algolia-docsearch-suggestion.algolia-docsearch-suggestion__main .algolia-docsearch-suggestion--category-header{color:#fff;display:block}.algolia-autocomplete .algolia-docsearch-suggestion.algolia-docsearch-suggestion__secondary .algolia-docsearch-suggestion--subcategory-column,.tocCollapsibleContent_vkbj a{display:block}.algolia-autocomplete .algolia-docsearch-footer{background-color:#fff;float:right;font-size:0;height:30px;line-height:0;width:100%;z-index:2000}.algolia-autocomplete .algolia-docsearch-footer--logo{background-image:url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 130 18'%3E%3Cg fill='none' fill-rule='evenodd'%3E%3Cpath fill='url(%2523a)' d='M59.4.02h13.3a2.37 2.37 0 0 1 2.38 2.37V15.6a2.37 2.37 0 0 1-2.38 2.36H59.4a2.37 2.37 0 0 1-2.38-2.36V2.38A2.37 2.37 0 0 1 59.4.02'/%3E%3Cpath fill='%2523FFF' d='M66.26 4.56c-2.82 0-5.1 2.27-5.1 5.08 0 2.8 2.28 5.07 5.1 5.07 2.8 0 5.1-2.26 5.1-5.07 0-2.8-2.28-5.07-5.1-5.07zm0 8.65c-2 0-3.6-1.6-3.6-3.56 0-1.97 1.6-3.58 3.6-3.58 1.98 0 3.6 1.6 3.6 3.58a3.58 3.58 0 0 1-3.6 3.57zm0-6.4v2.66c0 .07.08.13.15.1l2.4-1.24c.04-.02.06-.1.03-.14a2.96 2.96 0 0 0-2.46-1.5.1.1 0 0 0-.1.1zm-3.33-1.96-.3-.3a.78.78 0 0 0-1.12 0l-.36.36a.77.77 0 0 0 0 1.1l.3.3c.05.05.13.04.17 0 .2-.25.4-.5.6-.7.23-.23.46-.43.7-.6.07-.04.07-.1.03-.16zm5-.8V3.4a.78.78 0 0 0-.78-.78h-1.83a.78.78 0 0 0-.78.78v.63c0 .07.06.12.14.1a5.7 5.7 0 0 1 1.58-.22c.52 0 1.04.07 1.54.2a.1.1 0 0 0 .13-.1z'/%3E%3Cpath fill='%2523182359' d='M102.16 13.76c0 1.46-.37 2.52-1.12 3.2-.75.67-1.9 1-3.44 1-.56 0-1.74-.1-2.67-.3l.34-1.7c.78.17 1.82.2 2.36.2.86 0 1.48-.16 1.84-.5.37-.36.55-.88.55-1.57v-.35a6 6 0 0 1-.84.3 4.2 4.2 0 0 1-1.2.17 4.5 4.5 0 0 1-1.6-.28 3.4 3.4 0 0 1-1.26-.82 3.7 3.7 0 0 1-.8-1.35c-.2-.54-.3-1.5-.3-2.2 0-.67.1-1.5.3-2.06a3.9 3.9 0 0 1 .9-1.43 4.1 4.1 0 0 1 1.45-.92 5.3 5.3 0 0 1 1.94-.37c.7 0 1.35.1 1.97.2a16 16 0 0 1 1.6.33v8.46zm-5.95-4.2c0 .9.2 1.88.6 2.3.4.4.9.62 1.53.62q.51 0 .96-.15a2.8 2.8 0 0 0 .73-.33V6.7a8.5 8.5 0 0 0-1.42-.17c-.76-.02-1.36.3-1.77.8-.4.5-.62 1.4-.62 2.23zm16.13 0c0 .72-.1 1.26-.32 1.85a4.4 4.4 0 0 1-.9 1.53c-.38.42-.85.75-1.4.98-.54.24-1.4.37-1.8.37-.43 0-1.27-.13-1.8-.36a4.1 4.1 0 0 1-1.4-.97 4.5 4.5 0 0 1-.92-1.52 5 5 0 0 1-.33-1.84c0-.72.1-1.4.32-2s.53-1.1.92-1.5c.4-.43.86-.75 1.4-.98a4.55 4.55 0 0 1 1.78-.34 4.7 4.7 0 0 1 1.8.34c.54.23 1 .55 1.4.97q.57.63.9 1.5c.23.6.35 1.3.35 2zm-2.2 0c0-.92-.2-1.7-.6-2.22-.38-.54-.94-.8-1.64-.8-.72 0-1.27.26-1.67.8s-.58 1.3-.58 2.22c0 .93.2 1.56.6 2.1.38.54.94.8 1.64.8s1.25-.26 1.65-.8c.4-.55.6-1.17.6-2.1m6.97 4.7c-3.5.02-3.5-2.8-3.5-3.27L113.57.92l2.15-.34v10c0 .25 0 1.87 1.37 1.88v1.8zm3.77 0h-2.15v-9.2l2.15-.33v9.54zM119.8 3.74c.7 0 1.3-.58 1.3-1.3 0-.7-.58-1.3-1.3-1.3-.73 0-1.3.6-1.3 1.3 0 .72.58 1.3 1.3 1.3m6.43 1c.7 0 1.3.1 1.78.27.5.18.88.42 1.17.73.28.3.5.74.6 1.18.13.46.2.95.2 1.5v5.47a25 25 0 0 1-1.5.25q-1.005.15-2.25.15a6.8 6.8 0 0 1-1.52-.16 3.2 3.2 0 0 1-1.18-.5 2.46 2.46 0 0 1-.76-.9c-.18-.37-.27-.9-.27-1.44 0-.52.1-.85.3-1.2.2-.37.48-.67.83-.9a3.6 3.6 0 0 1 1.23-.5 7 7 0 0 1 2.2-.1l.83.16V8.4c0-.25-.03-.48-.1-.7a1.5 1.5 0 0 0-.3-.58c-.15-.18-.34-.3-.58-.4a2.5 2.5 0 0 0-.92-.17c-.5 0-.94.06-1.35.13-.4.08-.75.16-1 .25l-.27-1.74c.27-.1.67-.18 1.2-.28a9.3 9.3 0 0 1 1.65-.14zm.18 7.74c.66 0 1.15-.04 1.5-.1V10.2a5.1 5.1 0 0 0-2-.1c-.23.03-.45.1-.64.2a1.17 1.17 0 0 0-.47.38c-.13.17-.18.26-.18.52 0 .5.17.8.5.98.32.2.74.3 1.3.3zM84.1 4.8c.72 0 1.3.08 1.8.26.48.17.87.42 1.15.73.3.3.5.72.6 1.17.14.45.2.94.2 1.47v5.48a25 25 0 0 1-1.5.26c-.67.1-1.42.14-2.25.14a6.8 6.8 0 0 1-1.52-.16 3.2 3.2 0 0 1-1.18-.5 2.46 2.46 0 0 1-.76-.9c-.18-.38-.27-.9-.27-1.44 0-.53.1-.86.3-1.22s.5-.65.84-.88a3.6 3.6 0 0 1 1.24-.5 7 7 0 0 1 2.2-.1q.39.045.84.15v-.35c0-.24-.03-.48-.1-.7a1.5 1.5 0 0 0-.3-.58c-.15-.17-.34-.3-.58-.4a2.5 2.5 0 0 0-.9-.15c-.5 0-.96.05-1.37.12-.4.07-.75.15-1 .24l-.26-1.75c.27-.08.67-.17 1.18-.26a9 9 0 0 1 1.66-.15zm.2 7.73c.65 0 1.14-.04 1.48-.1v-2.17a5.1 5.1 0 0 0-1.98-.1c-.24.03-.46.1-.65.18a1.17 1.17 0 0 0-.47.4c-.12.17-.17.26-.17.52 0 .5.18.8.5.98.32.2.75.3 1.3.3zm8.68 1.74c-3.5 0-3.5-2.82-3.5-3.28L89.45.92 91.6.6v10c0 .25 0 1.87 1.38 1.88v1.8z'/%3E%3Cpath fill='%25231D3657' d='M5.03 11.03c0 .7-.26 1.24-.76 1.64q-.75.6-2.1.6c-.88 0-1.6-.14-2.17-.42v-1.2c.36.16.74.3 1.14.38.4.1.78.15 1.13.15.5 0 .88-.1 1.12-.3a.94.94 0 0 0 .35-.77.98.98 0 0 0-.33-.74c-.22-.2-.68-.44-1.37-.72-.72-.3-1.22-.62-1.52-1C.23 8.27.1 7.82.1 7.3c0-.65.22-1.17.7-1.55.46-.37 1.08-.56 1.86-.56.76 0 1.5.16 2.25.48l-.4 1.05c-.7-.3-1.32-.44-1.87-.44-.4 0-.73.08-.94.26a.9.9 0 0 0-.33.72c0 .2.04.38.12.52.08.15.22.3.42.4.2.14.55.3 1.06.52.58.24 1 .47 1.27.67s.47.44.6.7c.12.26.18.57.18.92zM9 13.27c-.92 0-1.64-.27-2.16-.8-.52-.55-.78-1.3-.78-2.24 0-.97.24-1.73.72-2.3.5-.54 1.15-.82 2-.82.78 0 1.4.25 1.85.72.46.48.7 1.14.7 1.97v.67H7.35c0 .58.17 1.02.46 1.33.3.3.7.47 1.24.47.36 0 .68-.04.98-.1a5 5 0 0 0 .98-.33v1.02a3.9 3.9 0 0 1-.94.32 5.7 5.7 0 0 1-1.08.1zm-.22-5.2c-.4 0-.73.12-.97.38s-.37.62-.42 1.1h2.7c0-.48-.13-.85-.36-1.1-.23-.26-.54-.38-.94-.38zm7.7 5.1-.26-.84h-.05c-.28.36-.57.6-.86.74-.28.13-.65.2-1.1.2-.6 0-1.05-.16-1.38-.48-.32-.32-.5-.77-.5-1.34 0-.62.24-1.08.7-1.4.45-.3 1.14-.47 2.07-.5l1.02-.03V9.2c0-.37-.1-.65-.27-.84-.17-.2-.45-.28-.82-.28-.3 0-.6.04-.88.13a7 7 0 0 0-.8.33l-.4-.9a4.4 4.4 0 0 1 1.05-.4 5 5 0 0 1 1.08-.12c.76 0 1.33.18 1.7.5q.6.495.6 1.56v4h-.9zm-1.9-.87c.47 0 .83-.13 1.1-.38.3-.26.43-.62.43-1.08v-.52l-.76.03c-.6.03-1.02.13-1.3.3s-.4.45-.4.82c0 .26.08.47.24.6.16.16.4.23.7.23zm7.57-5.2c.25 0 .46.03.62.06l-.12 1.18a2.4 2.4 0 0 0-.56-.06c-.5 0-.92.16-1.24.5-.3.32-.47.75-.47 1.27v3.1h-1.27V7.23h1l.16 1.05h.05c.2-.36.45-.64.77-.85a1.83 1.83 0 0 1 1.02-.3zm4.12 6.17c-.9 0-1.58-.27-2.05-.8-.47-.52-.7-1.27-.7-2.25 0-1 .24-1.77.73-2.3.5-.54 1.2-.8 2.12-.8.63 0 1.2.1 1.7.34l-.4 1c-.52-.2-.96-.3-1.3-.3-1.04 0-1.55.68-1.55 2.05 0 .67.13 1.17.38 1.5.26.34.64.5 1.13.5a3.23 3.23 0 0 0 1.6-.4v1.1a2.5 2.5 0 0 1-.73.28 4.4 4.4 0 0 1-.93.08m8.28-.1h-1.27V9.5c0-.45-.1-.8-.28-1.02-.18-.23-.47-.34-.88-.34-.53 0-.9.16-1.16.48-.25.3-.38.85-.38 1.6v2.94h-1.26V4.8h1.26v2.12c0 .34-.02.7-.06 1.1h.08a1.76 1.76 0 0 1 .72-.67c.3-.16.66-.24 1.07-.24 1.43 0 2.15.74 2.15 2.2v3.86zM42.2 7.1c.74 0 1.32.28 1.73.82.4.53.62 1.3.62 2.26 0 .97-.2 1.73-.63 2.27-.42.54-1 .82-1.75.82s-1.33-.27-1.75-.8h-.08l-.23.7h-.94V4.8h1.26v2l-.02.64-.03.56h.05c.4-.6 1-.9 1.78-.9zm-.33 1.04c-.5 0-.88.15-1.1.45s-.34.8-.35 1.5v.08c0 .72.12 1.24.35 1.57.23.32.6.48 1.12.48.44 0 .78-.17 1-.53.24-.35.36-.87.36-1.53 0-1.35-.47-2.03-1.4-2.03zm3.24-.92h1.4l1.2 3.37c.18.47.3.92.36 1.34h.04l.18-.72 1.37-4H51l-2.53 6.73c-.46 1.23-1.23 1.85-2.3 1.85-.3 0-.56-.03-.83-.1v-1c.2.05.4.08.65.08.6 0 1.03-.36 1.28-1.06l.22-.56-2.4-5.94z'/%3E%3C/g%3E%3C/svg%3E");background-position:50%;background-repeat:no-repeat;background-size:100%;display:block;height:100%;margin-left:auto;margin-right:5px;overflow:hidden;text-indent:-9000px;width:110px}html[data-theme=dark] .algolia-docsearch-footer,html[data-theme=dark] .algolia-docsearch-suggestion--category-header,html[data-theme=dark] .algolia-docsearch-suggestion--wrapper{background:var(--ifm-background-color)!important;color:var(--ifm-font-color-base)!important}html[data-theme=dark] .algolia-docsearch-suggestion--title{color:var(--ifm-font-color-base)!important}html[data-theme=dark] .ds-cursor .algolia-docsearch-suggestion--wrapper{background:var(--ifm-background-surface-color)!important}mark{background-color:#add8e6}.skipToContent_fXgn{background-color:var(--ifm-background-surface-color);color:var(--ifm-color-emphasis-900);left:100%;padding:calc(var(--ifm-global-spacing)/2) var(--ifm-global-spacing);position:fixed;top:1rem;z-index:calc(var(--ifm-z-index-fixed) + 1)}.skipToContent_fXgn:focus{box-shadow:var(--ifm-global-shadow-md);left:1rem}.closeButton_CVFx{line-height:0;padding:0}.content_knG7{font-size:85%;padding:5px 0;text-align:center}.content_knG7 a{color:inherit;text-decoration:underline}.announcementBar_mb4j{align-items:center;background-color:var(--ifm-color-white);border-bottom:1px solid var(--ifm-color-emphasis-100);color:var(--ifm-color-black);display:flex;height:var(--docusaurus-announcement-bar-height)}.announcementBarPlaceholder_vyr4{flex:0 0 10px}.announcementBarClose_gvF7{align-self:stretch;flex:0 0 30px}.toggle_vylO{height:2rem;width:2rem}.toggleButton_gllP{align-items:center;border-radius:50%;display:flex;height:100%;justify-content:center;transition:background var(--ifm-transition-fast);width:100%}.toggleButton_gllP:hover{background:var(--ifm-color-emphasis-200)}.toggleButtonDisabled_aARS{cursor:not-allowed}.darkNavbarColorModeToggle_X3D1:hover{background:var(--ifm-color-gray-800)}[data-theme=dark] .themedComponent--dark_xIcU,[data-theme=light] .themedComponent--light_NVdE,html:not([data-theme]) .themedComponent--light_NVdE{display:initial}[data-theme=dark]:root{--docusaurus-collapse-button-bg:#ffffff0d;--docusaurus-collapse-button-bg-hover:#ffffff1a}.collapseSidebarButton_PEFL{display:none;margin:0}.iconExternalLink_nPIU{margin-left:.3rem}.docMainContainer_TBSr,.docRoot_UBD9{display:flex;width:100%}.docsWrapper_hBAB{display:flex;flex:1 0 auto}.iconLanguage_nlXk{margin-right:5px;vertical-align:text-bottom}.navbarHideable_m1mJ{transition:transform var(--ifm-transition-fast) ease}.navbarHidden_jGov{transform:translate3d(0,calc(-100% - 2px),0)}.errorBoundaryError_a6uf{color:red;white-space:pre-wrap}.errorBoundaryFallback_VBag{color:red;padding:.55rem}.buttonGroup__atx button,.codeBlockContainer_Ckt0{background:var(--prism-background-color);color:var(--prism-color)}.footerLogoLink_BH7S{opacity:.5;transition:opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default)}.footerLogoLink_BH7S:hover,.hash-link:focus,:hover>.hash-link{opacity:1}.anchorWithStickyNavbar_LWe7{scroll-margin-top:calc(var(--ifm-navbar-height) + .5rem)}.anchorWithHideOnScrollNavbar_WYt5{scroll-margin-top:.5rem}.hash-link{opacity:0;padding-left:.5rem;transition:opacity var(--ifm-transition-fast);-webkit-user-select:none;user-select:none}.hash-link:before{content:"#"}.mainWrapper_z2l0{display:flex;flex:1 0 auto;flex-direction:column}.docusaurus-mt-lg{margin-top:3rem}#__docusaurus{display:flex;flex-direction:column;min-height:100%}.features_t9lD{align-items:center;display:flex;padding:2rem 0;width:100%}.featureSvg_GfXr{height:200px;width:200px}.heroBanner_qdFl{overflow:hidden;padding:4rem 0;position:relative;text-align:center}.buttons_AeoN{align-items:center;display:flex;justify-content:center}.codeBlockContainer_Ckt0{border-radius:var(--ifm-code-border-radius);box-shadow:var(--ifm-global-shadow-lw);margin-bottom:var(--ifm-leading)}.codeBlockContent_biex{border-radius:inherit;direction:ltr;position:relative}.codeBlockTitle_Ktv7{border-bottom:1px solid var(--ifm-color-emphasis-300);border-top-left-radius:inherit;border-top-right-radius:inherit;font-size:var(--ifm-code-font-size);font-weight:500;padding:.75rem var(--ifm-pre-padding)}.codeBlock_bY9V{--ifm-pre-background:var(--prism-background-color);margin:0;padding:0}.codeBlockTitle_Ktv7+.codeBlockContent_biex .codeBlock_bY9V{border-top-left-radius:0;border-top-right-radius:0}.codeBlockLines_e6Vv{float:left;font:inherit;min-width:100%;padding:var(--ifm-pre-padding)}.codeBlockLinesWithNumbering_o6Pm{display:table;padding:var(--ifm-pre-padding) 0}.buttonGroup__atx{column-gap:.2rem;display:flex;position:absolute;right:calc(var(--ifm-pre-padding)/2);top:calc(var(--ifm-pre-padding)/2)}.buttonGroup__atx button{align-items:center;border:1px solid var(--ifm-color-emphasis-300);border-radius:var(--ifm-global-radius);display:flex;line-height:0;opacity:0;padding:.4rem;transition:opacity var(--ifm-transition-fast) ease-in-out}.buttonGroup__atx button:focus-visible,.buttonGroup__atx button:hover{opacity:1!important}.theme-code-block:hover .buttonGroup__atx button{opacity:.4}:where(:root){--docusaurus-highlighted-code-line-bg:#484d5b}:where([data-theme=dark]){--docusaurus-highlighted-code-line-bg:#646464}.theme-code-block-highlighted-line{background-color:var(--docusaurus-highlighted-code-line-bg);display:block;margin:0 calc(var(--ifm-pre-padding)*-1);padding:0 var(--ifm-pre-padding)}.codeLine_lJS_{counter-increment:a;display:table-row}.codeLineNumber_Tfdd{background:var(--ifm-pre-background);display:table-cell;left:0;overflow-wrap:normal;padding:0 var(--ifm-pre-padding);position:sticky;text-align:right;width:1%}.codeLineNumber_Tfdd:before{content:counter(a);opacity:.4}.codeLineContent_feaV{padding-right:var(--ifm-pre-padding)}.theme-code-block:hover .copyButtonCopied_obH4{opacity:1!important}.copyButtonIcons_eSgA{height:1.125rem;position:relative;width:1.125rem}.copyButtonIcon_y97N,.copyButtonSuccessIcon_LjdS{left:0;position:absolute;top:0;fill:currentColor;height:inherit;opacity:inherit;transition:all var(--ifm-transition-fast) ease;width:inherit}.copyButtonSuccessIcon_LjdS{color:#00d600;left:50%;opacity:0;top:50%;transform:translate(-50%,-50%) scale(.33)}.copyButtonCopied_obH4 .copyButtonIcon_y97N{opacity:0;transform:scale(.33)}.copyButtonCopied_obH4 .copyButtonSuccessIcon_LjdS{opacity:1;transform:translate(-50%,-50%) scale(1);transition-delay:75ms}.wordWrapButtonIcon_Bwma{height:1.2rem;width:1.2rem}.iconEdit_Z9Sw{margin-right:.3em;vertical-align:sub}.details_lb9f{--docusaurus-details-summary-arrow-size:0.38rem;--docusaurus-details-transition:transform 200ms ease;--docusaurus-details-decoration-color:grey}.details_lb9f>summary{cursor:pointer;padding-left:1rem;position:relative}.details_lb9f>summary::-webkit-details-marker{display:none}.details_lb9f>summary:before{border-color:#0000 #0000 #0000 var(--docusaurus-details-decoration-color);border-style:solid;border-width:var(--docusaurus-details-summary-arrow-size);content:"";left:0;position:absolute;top:.45rem;transform:rotate(0);transform-origin:calc(var(--docusaurus-details-summary-arrow-size)/2) 50%;transition:var(--docusaurus-details-transition)}.collapsibleContent_i85q{border-top:1px solid var(--docusaurus-details-decoration-color);margin-top:1rem;padding-top:1rem}.lastUpdated_JAkA{font-size:smaller;font-style:italic;margin-top:.2rem}.tocCollapsibleButton_TO0P{align-items:center;display:flex;font-size:inherit;justify-content:space-between;padding:.4rem .8rem;width:100%}.tocCollapsibleButton_TO0P:after{background:var(--ifm-menu-link-sublist-icon) 50% 50%/2rem 2rem no-repeat;content:"";filter:var(--ifm-menu-link-sublist-icon-filter);height:1.25rem;transform:rotate(180deg);transition:transform var(--ifm-transition-fast);width:1.25rem}.tocCollapsibleButtonExpanded_MG3E:after,.tocCollapsibleExpanded_sAul{transform:none}.tocCollapsible_ETCw{background-color:var(--ifm-menu-color-background-active);border-radius:var(--ifm-global-radius);margin:1rem 0}.tocCollapsibleContent_vkbj>ul{border-left:none;border-top:1px solid var(--ifm-color-emphasis-300);font-size:15px;padding:.2rem 0}.tocCollapsibleContent_vkbj ul li{margin:.4rem .8rem}.details_b_Ee{--docusaurus-details-decoration-color:var(--ifm-alert-border-color);--docusaurus-details-transition:transform var(--ifm-transition-fast) ease;border:1px solid var(--ifm-alert-border-color);margin:0 0 var(--ifm-spacing-vertical)}:not(.containsTaskList_mC6p>li)>.containsTaskList_mC6p{padding-left:0}.img_ev3q{height:auto}.tableOfContents_bqdL{max-height:calc(100vh - var(--ifm-navbar-height) - 2rem);overflow-y:auto;position:sticky;top:calc(var(--ifm-navbar-height) + 1rem)}.admonition_xJq3{margin-bottom:1em}.admonitionHeading_Gvgb{font:var(--ifm-heading-font-weight) var(--ifm-h5-font-size)/var(--ifm-heading-line-height) var(--ifm-heading-font-family)}.admonitionHeading_Gvgb:not(:last-child){margin-bottom:.3rem}.admonitionHeading_Gvgb code{text-transform:none}.admonitionIcon_Rf37{display:inline-block;margin-right:.4em;vertical-align:middle}.admonitionIcon_Rf37 svg{display:inline-block;height:1.6em;width:1.6em;fill:var(--ifm-alert-foreground-color)}.breadcrumbHomeIcon_YNFT{height:1.1rem;position:relative;top:1px;vertical-align:top;width:1.1rem}.breadcrumbsContainer_Z_bl{--ifm-breadcrumb-size-multiplier:0.8;margin-bottom:.8rem}.mdxPageWrapper_j9I6{justify-content:center}@media (min-width:601px){.algolia-autocomplete.algolia-autocomplete-right .ds-dropdown-menu{left:inherit!important;right:0!important}.algolia-autocomplete.algolia-autocomplete-right .ds-dropdown-menu:before{right:48px}.algolia-autocomplete .ds-dropdown-menu{background:#0000;border:none;border-radius:4px;height:auto;margin:6px 0 0;max-width:600px;min-width:500px;padding:0;position:relative;text-align:left;top:-6px;z-index:999}}@media (min-width:768px){.algolia-docsearch-suggestion{border-bottom-color:#7671df}.algolia-docsearch-suggestion--subcategory-column{border-right-color:#7671df;color:#4e4726}}@media (min-width:997px){.collapseSidebarButton_PEFL,.expandButton_TmdG{background-color:var(--docusaurus-collapse-button-bg)}:root{--docusaurus-announcement-bar-height:30px}.announcementBarClose_gvF7,.announcementBarPlaceholder_vyr4{flex-basis:50px}.collapseSidebarButton_PEFL{border:1px solid var(--ifm-toc-border-color);border-radius:0;bottom:0;display:block!important;height:40px;position:sticky}.collapseSidebarButtonIcon_kv0_{margin-top:4px;transform:rotate(180deg)}.expandButtonIcon_i1dp,[dir=rtl] .collapseSidebarButtonIcon_kv0_{transform:rotate(0)}.collapseSidebarButton_PEFL:focus,.collapseSidebarButton_PEFL:hover,.expandButton_TmdG:focus,.expandButton_TmdG:hover{background-color:var(--docusaurus-collapse-button-bg-hover)}.menuHtmlItem_M9Kj{padding:var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal)}.menu_SIkG{flex-grow:1;padding:.5rem}@supports (scrollbar-gutter:stable){.menu_SIkG{padding:.5rem 0 .5rem .5rem;scrollbar-gutter:stable}}.menuWithAnnouncementBar_GW3s{margin-bottom:var(--docusaurus-announcement-bar-height)}.sidebar_njMd{display:flex;flex-direction:column;height:100%;padding-top:var(--ifm-navbar-height);width:var(--doc-sidebar-width)}.sidebarWithHideableNavbar_wUlq{padding-top:0}.sidebarHidden_VK0M{opacity:0;visibility:hidden}.sidebarLogo_isFc{align-items:center;color:inherit!important;display:flex!important;margin:0 var(--ifm-navbar-padding-horizontal);max-height:var(--ifm-navbar-height);min-height:var(--ifm-navbar-height);text-decoration:none!important}.sidebarLogo_isFc img{height:2rem;margin-right:.5rem}.expandButton_TmdG{align-items:center;display:flex;height:100%;justify-content:center;position:absolute;right:0;top:0;transition:background-color var(--ifm-transition-fast) ease;width:100%}[dir=rtl] .expandButtonIcon_i1dp{transform:rotate(180deg)}.docSidebarContainer_YfHR{border-right:1px solid var(--ifm-toc-border-color);clip-path:inset(0);display:block;margin-top:calc(var(--ifm-navbar-height)*-1);transition:width var(--ifm-transition-fast) ease;width:var(--doc-sidebar-width);will-change:width}.docSidebarContainerHidden_DPk8{cursor:pointer;width:var(--doc-sidebar-hidden-width)}.sidebarViewport_aRkj{height:100%;max-height:100vh;position:sticky;top:0}.docMainContainer_TBSr{flex-grow:1;max-width:calc(100% - var(--doc-sidebar-width))}.docMainContainerEnhanced_lQrH{max-width:calc(100% - var(--doc-sidebar-hidden-width))}.docItemWrapperEnhanced_JWYK{max-width:calc(var(--ifm-container-width) + var(--doc-sidebar-width))!important}.navbarSearchContainer_Bca1{padding:var(--ifm-navbar-item-padding-vertical) var(--ifm-navbar-item-padding-horizontal)}.lastUpdated_JAkA{text-align:right}.tocMobile_ITEo{display:none}.docItemCol_VOVn{max-width:75%!important}}@media (min-width:1440px){.container{max-width:var(--ifm-container-width-xl)}}@media (max-width:996px){.col{--ifm-col-width:100%;flex-basis:var(--ifm-col-width);margin-left:0}.footer{--ifm-footer-padding-horizontal:0}.colorModeToggle_DEke,.footer__link-separator,.navbar__item,.tableOfContents_bqdL{display:none}.footer__col{margin-bottom:calc(var(--ifm-spacing-vertical)*3)}.footer__link-item{display:block}.hero{padding-left:0;padding-right:0}.navbar>.container,.navbar>.container-fluid{padding:0}.navbar__toggle{display:inherit}.navbar__search-input{width:9rem}.pills--block,.tabs--block{flex-direction:column}.navbarSearchContainer_Bca1{position:absolute;right:var(--ifm-navbar-padding-horizontal)}.docItemContainer_F8PC{padding:0 .3rem}}@media screen and (max-width:996px){.heroBanner_qdFl{padding:2rem}}@media (max-width:600px){.algolia-autocomplete .ds-dropdown-menu{display:block;left:auto!important;max-height:calc(100% - 5rem);max-width:calc(100% - 2rem);position:fixed!important;right:1rem!important;top:50px!important;width:600px;z-index:100}.algolia-autocomplete .ds-dropdown-menu:before{right:6rem}}@media (max-width:576px){.markdown h1:first-child{--ifm-h1-font-size:2rem}.markdown>h2{--ifm-h2-font-size:1.5rem}.markdown>h3{--ifm-h3-font-size:1.25rem}}@media (hover:hover){.backToTopButton_sjWU:hover{background-color:var(--ifm-color-emphasis-300)}}@media (pointer:fine){.thin-scrollbar{scrollbar-width:thin}.thin-scrollbar::-webkit-scrollbar{height:var(--ifm-scrollbar-size);width:var(--ifm-scrollbar-size)}.thin-scrollbar::-webkit-scrollbar-track{background:var(--ifm-scrollbar-track-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb{background:var(--ifm-scrollbar-thumb-background-color);border-radius:10px}.thin-scrollbar::-webkit-scrollbar-thumb:hover{background:var(--ifm-scrollbar-thumb-hover-background-color)}}@media (prefers-reduced-motion:reduce){:root{--ifm-transition-fast:0ms;--ifm-transition-slow:0ms}}@media print{.announcementBar_mb4j,.footer,.menu,.navbar,.pagination-nav,.table-of-contents,.tocMobile_ITEo{display:none}.tabs{page-break-inside:avoid}.codeBlockLines_e6Vv{white-space:pre-wrap}} \ No newline at end of file diff --git a/assets/js/0039f7b2.9187ea54.js b/assets/js/0039f7b2.9187ea54.js deleted file mode 100644 index 485937988..000000000 --- a/assets/js/0039f7b2.9187ea54.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3750],{1525:(r,e,o)=>{o.r(e),o.d(e,{assets:()=>c,contentTitle:()=>n,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var t=o(4848),a=o(8453);const i={title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},n=void 0,s={id:"airgap-workflow",title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",source:"@site/versioned_docs/version-0.4.3/airgap-workflow.md",sourceDirName:".",slug:"/airgap-workflow",permalink:"/hauler-docs/docs/0.4.3/airgap-workflow",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.3/airgap-workflow.md",tags:[],version:"0.4.3",frontMatter:{title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},sidebar:"haulerSidebar",previous:{title:"Core Concepts",permalink:"/hauler-docs/docs/0.4.3/core-concepts"},next:{title:"Quickstart",permalink:"/hauler-docs/docs/0.4.3/introduction/quickstart"}},c={},l=[{value:"Workflow Diagram",id:"workflow-diagram",level:2}];function d(r){const e={h2:"h2",img:"img",p:"p",...(0,a.R)(),...r.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h2,{id:"workflow-diagram",children:"Workflow Diagram"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.img,{alt:"hauler-workflow-diagram",src:o(8010).A+"",width:"2883",height:"1013"})}),"\n",(0,t.jsx)(e.p,{children:"Airgap Workflow Documentation pending a future release!"})]})}function u(r={}){const{wrapper:e}={...(0,a.R)(),...r.components};return e?(0,t.jsx)(e,{...r,children:(0,t.jsx)(d,{...r})}):d(r)}},8010:(r,e,o)=>{o.d(e,{A:()=>t});const t=o.p+"assets/images/hauler-workflow-diagram-a0761cc99fb86b21c4ca1a7d8a31dfc4.png"},8453:(r,e,o)=>{o.d(e,{R:()=>n,x:()=>s});var t=o(6540);const a={},i=t.createContext(a);function n(r){const e=t.useContext(i);return t.useMemo((function(){return"function"==typeof r?r(e):{...e,...r}}),[e,r])}function s(r){let e;return e=r.disableParentContext?"function"==typeof r.components?r.components(a):r.components||a:n(r.components),t.createElement(i.Provider,{value:e},r.children)}}}]); \ No newline at end of file diff --git a/assets/js/0039f7b2.de8e06bf.js b/assets/js/0039f7b2.de8e06bf.js new file mode 100644 index 000000000..164117110 --- /dev/null +++ b/assets/js/0039f7b2.de8e06bf.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3750],{1525:(o,r,e)=>{e.r(r),e.d(r,{assets:()=>l,contentTitle:()=>n,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>c});var t=e(4848),a=e(8453);const i={title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},n=void 0,s={id:"airgap-workflow",title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",source:"@site/versioned_docs/version-0.4.3/airgap-workflow.md",sourceDirName:".",slug:"/airgap-workflow",permalink:"/docs/0.4.3/airgap-workflow",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.3/airgap-workflow.md",tags:[],version:"0.4.3",frontMatter:{title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},sidebar:"haulerSidebar",previous:{title:"Core Concepts",permalink:"/docs/0.4.3/core-concepts"},next:{title:"Quickstart",permalink:"/docs/0.4.3/introduction/quickstart"}},l={},c=[{value:"Workflow Diagram",id:"workflow-diagram",level:2}];function d(o){const r={h2:"h2",img:"img",p:"p",...(0,a.R)(),...o.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h2,{id:"workflow-diagram",children:"Workflow Diagram"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.img,{alt:"hauler-workflow-diagram",src:e(8010).A+"",width:"2883",height:"1013"})}),"\n",(0,t.jsx)(r.p,{children:"Airgap Workflow Documentation pending a future release!"})]})}function u(o={}){const{wrapper:r}={...(0,a.R)(),...o.components};return r?(0,t.jsx)(r,{...o,children:(0,t.jsx)(d,{...o})}):d(o)}},8010:(o,r,e)=>{e.d(r,{A:()=>t});const t=e.p+"assets/images/hauler-workflow-diagram-a0761cc99fb86b21c4ca1a7d8a31dfc4.png"},8453:(o,r,e)=>{e.d(r,{R:()=>n,x:()=>s});var t=e(6540);const a={},i=t.createContext(a);function n(o){const r=t.useContext(i);return t.useMemo((function(){return"function"==typeof o?o(r):{...r,...o}}),[r,o])}function s(o){let r;return r=o.disableParentContext?"function"==typeof o.components?o.components(a):o.components||a:n(o.components),t.createElement(i.Provider,{value:r},o.children)}}}]); \ No newline at end of file diff --git a/assets/js/015db4fe.8ca88741.js b/assets/js/015db4fe.8ca88741.js new file mode 100644 index 000000000..309bf30d2 --- /dev/null +++ b/assets/js/015db4fe.8ca88741.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9940],{9368:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>l,contentTitle:()=>s,default:()=>p,frontMatter:()=>r,metadata:()=>o,toc:()=>c});var i=a(4848),t=a(8453);const r={title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},s=void 0,o={id:"airgap-workflow",title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",source:"@site/docs/airgap-workflow.md",sourceDirName:".",slug:"/airgap-workflow",permalink:"/docs/next/airgap-workflow",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/docs/airgap-workflow.md",tags:[],version:"current",frontMatter:{title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},sidebar:"haulerSidebar",previous:{title:"Core Concepts",permalink:"/docs/next/core-concepts"},next:{title:"Quickstart",permalink:"/docs/next/introduction/quickstart"}},l={},c=[{value:"Workflow Diagram",id:"workflow-diagram",level:2},{value:"What's an Airgap?",id:"whats-an-airgap",level:2},{value:"Example Use Cases",id:"example-use-cases",level:3},{value:"Challenges of an Airgap",id:"challenges-of-an-airgap",level:2}];function d(e){const n={h2:"h2",h3:"h3",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"workflow-diagram",children:"Workflow Diagram"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"hauler-workflow-diagram",src:a(8010).A+"",width:"2883",height:"1013"})}),"\n",(0,i.jsx)(n.h2,{id:"whats-an-airgap",children:"What's an Airgap?"}),"\n",(0,i.jsx)(n.p,{children:"An airgap is a highly secure environment that is physically isolated from external connectivity (usually the internet), ensuring complete isolation from other environments by preventing unauthorized access or data transfers."}),"\n",(0,i.jsx)(n.h3,{id:"example-use-cases",children:"Example Use Cases"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Government and Military:"})," These airgaps protect sensitive government and military information and critical defense infrastructure, ensuring that classified data remains secure and inaccessible to unauthorized entities."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Critical Infrastructure:"})," These airgaps secure power grids, water supply systems, and transportation networks from cyber threats, shielding them from potential disruptions and ensuring their continuous operation."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Financial Institutions:"})," These airgaps safeguard financial transactions and customer data from cyberattacks, maintaining the trust and integrity of financial systems."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Research Facilities:"})," These airgaps protect valuable research data, intellectual property, and proprietary information, preserving the integrity and confidentiality of research efforts."]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"challenges-of-an-airgap",children:"Challenges of an Airgap"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Data Transfers:"})," Transferring data in and out of an airgapped system is complex due to the lack of network connectivity, often necessitating the use of physical media, trusted intermediaries, and meticulous approval processes to ensure data security."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Usability vs. Security Balance:"})," Balancing security with usability in airgapped environments can be intricate, as the limited convenience poses challenges for user interactions and system operations."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Maintenance Complexity:"})," Regular system updates, package and dependency updates, and overall maintenance can be challenging in airgapped systems, as the limited network connectivity complicates the process, requiring meticulous planning and execution."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Costly Implementation:"})," Implementing and maintaining airgapped systems can be costly, demanding specialized workflows, protocols, and security measures to uphold the system's integrity and security."]}),"\n"]})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},8010:(e,n,a)=>{a.d(n,{A:()=>i});const i=a.p+"assets/images/hauler-workflow-diagram-a0761cc99fb86b21c4ca1a7d8a31dfc4.png"},8453:(e,n,a)=>{a.d(n,{R:()=>s,x:()=>o});var i=a(6540);const t={},r=i.createContext(t);function s(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/015db4fe.e68b269c.js b/assets/js/015db4fe.e68b269c.js deleted file mode 100644 index f755a506e..000000000 --- a/assets/js/015db4fe.e68b269c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9940],{9368:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>l,contentTitle:()=>s,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>c});var i=a(4848),r=a(8453);const t={title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},s=void 0,o={id:"airgap-workflow",title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",source:"@site/docs/airgap-workflow.md",sourceDirName:".",slug:"/airgap-workflow",permalink:"/hauler-docs/docs/next/airgap-workflow",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/docs/airgap-workflow.md",tags:[],version:"current",frontMatter:{title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},sidebar:"haulerSidebar",previous:{title:"Core Concepts",permalink:"/hauler-docs/docs/next/core-concepts"},next:{title:"Quickstart",permalink:"/hauler-docs/docs/next/introduction/quickstart"}},l={},c=[{value:"Workflow Diagram",id:"workflow-diagram",level:2},{value:"What's an Airgap?",id:"whats-an-airgap",level:2},{value:"Example Use Cases",id:"example-use-cases",level:3},{value:"Challenges of an Airgap",id:"challenges-of-an-airgap",level:2}];function d(e){const n={h2:"h2",h3:"h3",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"workflow-diagram",children:"Workflow Diagram"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"hauler-workflow-diagram",src:a(8010).A+"",width:"2883",height:"1013"})}),"\n",(0,i.jsx)(n.h2,{id:"whats-an-airgap",children:"What's an Airgap?"}),"\n",(0,i.jsx)(n.p,{children:"An airgap is a highly secure environment that is physically isolated from external connectivity (usually the internet), ensuring complete isolation from other environments by preventing unauthorized access or data transfers."}),"\n",(0,i.jsx)(n.h3,{id:"example-use-cases",children:"Example Use Cases"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Government and Military:"})," These airgaps protect sensitive government and military information and critical defense infrastructure, ensuring that classified data remains secure and inaccessible to unauthorized entities."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Critical Infrastructure:"})," These airgaps secure power grids, water supply systems, and transportation networks from cyber threats, shielding them from potential disruptions and ensuring their continuous operation."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Financial Institutions:"})," These airgaps safeguard financial transactions and customer data from cyberattacks, maintaining the trust and integrity of financial systems."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Research Facilities:"})," These airgaps protect valuable research data, intellectual property, and proprietary information, preserving the integrity and confidentiality of research efforts."]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"challenges-of-an-airgap",children:"Challenges of an Airgap"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Data Transfers:"})," Transferring data in and out of an airgapped system is complex due to the lack of network connectivity, often necessitating the use of physical media, trusted intermediaries, and meticulous approval processes to ensure data security."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Usability vs. Security Balance:"})," Balancing security with usability in airgapped environments can be intricate, as the limited convenience poses challenges for user interactions and system operations."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Maintenance Complexity:"})," Regular system updates, package and dependency updates, and overall maintenance can be challenging in airgapped systems, as the limited network connectivity complicates the process, requiring meticulous planning and execution."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Costly Implementation:"})," Implementing and maintaining airgapped systems can be costly, demanding specialized workflows, protocols, and security measures to uphold the system's integrity and security."]}),"\n"]})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},8010:(e,n,a)=>{a.d(n,{A:()=>i});const i=a.p+"assets/images/hauler-workflow-diagram-a0761cc99fb86b21c4ca1a7d8a31dfc4.png"},8453:(e,n,a)=>{a.d(n,{R:()=>s,x:()=>o});var i=a(6540);const r={},t=i.createContext(r);function s(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/016e5590.19542418.js b/assets/js/016e5590.19542418.js new file mode 100644 index 000000000..2b0a88f83 --- /dev/null +++ b/assets/js/016e5590.19542418.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3732],{7590:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>a,contentTitle:()=>l,default:()=>d,frontMatter:()=>n,metadata:()=>o,toc:()=>u});var i=s(4848),t=s(8453);const n={title:"Hauler Fileserver",description:"Hauler Fileserver Documentation",sidebar_label:"Hauler Fileserver"},l=void 0,o={id:"guides-references/utilities/fileserver",title:"Hauler Fileserver",description:"Hauler Fileserver Documentation",source:"@site/versioned_docs/version-1.0.x/guides-references/utilities/fileserver.md",sourceDirName:"guides-references/utilities",slug:"/guides-references/utilities/fileserver",permalink:"/docs/guides-references/utilities/fileserver",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/utilities/fileserver.md",tags:[],version:"1.0.x",frontMatter:{title:"Hauler Fileserver",description:"Hauler Fileserver Documentation",sidebar_label:"Hauler Fileserver"},sidebar:"haulerSidebar",previous:{title:"Hauler Registry",permalink:"/docs/guides-references/utilities/registry"},next:{title:"Hauler Manifests",permalink:"/docs/guides-references/manifests"}},a={},u=[{value:"Overview",id:"overview",level:2},{value:"Example Commands for the Hauler Fileserver",id:"example-commands-for-the-hauler-fileserver",level:2}];function c(e){const r={code:"code",h2:"h2",p:"p",pre:"pre",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(r.h2,{id:"overview",children:"Overview"}),"\n",(0,i.jsx)(r.p,{children:"Hauler Fileserver docs are pending a future release!"}),"\n",(0,i.jsx)(r.h2,{id:"example-commands-for-the-hauler-fileserver",children:"Example Commands for the Hauler Fileserver"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-bash",children:"# serve fileserver\nhauler store serve fileserver\n\n# serve fileserver on specific port\nhauler store serve fileserver --port \n"})})]})}function d(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>l,x:()=>o});var i=s(6540);const t={},n=i.createContext(t);function l(e){const r=i.useContext(n);return i.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),i.createElement(n.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/016e5590.19a8bc47.js b/assets/js/016e5590.19a8bc47.js deleted file mode 100644 index c6c095b8c..000000000 --- a/assets/js/016e5590.19a8bc47.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3732],{7590:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>a,contentTitle:()=>l,default:()=>d,frontMatter:()=>n,metadata:()=>o,toc:()=>u});var i=s(4848),t=s(8453);const n={title:"Hauler Fileserver",description:"Hauler Fileserver Documentation",sidebar_label:"Hauler Fileserver"},l=void 0,o={id:"guides-references/utilities/fileserver",title:"Hauler Fileserver",description:"Hauler Fileserver Documentation",source:"@site/versioned_docs/version-1.0.x/guides-references/utilities/fileserver.md",sourceDirName:"guides-references/utilities",slug:"/guides-references/utilities/fileserver",permalink:"/hauler-docs/docs/guides-references/utilities/fileserver",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/utilities/fileserver.md",tags:[],version:"1.0.x",frontMatter:{title:"Hauler Fileserver",description:"Hauler Fileserver Documentation",sidebar_label:"Hauler Fileserver"},sidebar:"haulerSidebar",previous:{title:"Hauler Registry",permalink:"/hauler-docs/docs/guides-references/utilities/registry"},next:{title:"Hauler Manifests",permalink:"/hauler-docs/docs/guides-references/manifests"}},a={},u=[{value:"Overview",id:"overview",level:2},{value:"Example Commands for the Hauler Fileserver",id:"example-commands-for-the-hauler-fileserver",level:2}];function c(e){const r={code:"code",h2:"h2",p:"p",pre:"pre",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(r.h2,{id:"overview",children:"Overview"}),"\n",(0,i.jsx)(r.p,{children:"Hauler Fileserver docs are pending a future release!"}),"\n",(0,i.jsx)(r.h2,{id:"example-commands-for-the-hauler-fileserver",children:"Example Commands for the Hauler Fileserver"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-bash",children:"# serve fileserver\nhauler store serve fileserver\n\n# serve fileserver on specific port\nhauler store serve fileserver --port \n"})})]})}function d(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>l,x:()=>o});var i=s(6540);const t={},n=i.createContext(t);function l(e){const r=i.useContext(n);return i.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),i.createElement(n.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0593dd07.8ee6e999.js b/assets/js/0593dd07.8ee6e999.js new file mode 100644 index 000000000..c512c097d --- /dev/null +++ b/assets/js/0593dd07.8ee6e999.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8169],{1278:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"1.0.0","label":"1.0.0","banner":"unmaintained","badge":true,"noIndex":false,"className":"docs-version-1.0.0","isLast":false,"docsSidebars":{"haulerSidebar":[{"type":"link","label":"Introduction","href":"/docs/1.0.0/intro","docId":"intro","unlisted":false},{"type":"link","label":"Core Concepts","href":"/docs/1.0.0/core-concepts","docId":"core-concepts","unlisted":false},{"type":"link","label":"Airgap Workflow","href":"/docs/1.0.0/airgap-workflow","docId":"airgap-workflow","unlisted":false},{"type":"category","label":"Introduction","description":"Introduction Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Quickstart","href":"/docs/1.0.0/introduction/quickstart","docId":"introduction/quickstart","unlisted":false},{"type":"link","label":"Installation","href":"/docs/1.0.0/introduction/install","docId":"introduction/install","unlisted":false},{"type":"link","label":"Uninstall","href":"/docs/1.0.0/introduction/uninstall","docId":"introduction/uninstall","unlisted":false}],"collapsible":true},{"type":"category","label":"Guides & References","description":"Guides and References Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Overview","href":"/docs/1.0.0/guides-references/overview","docId":"guides-references/overview","unlisted":false},{"type":"link","label":"Hauler Manifests","href":"/docs/1.0.0/guides-references/manifests","docId":"guides-references/manifests","unlisted":false},{"type":"link","label":"Fetch Cluster Images","href":"/docs/1.0.0/guides-references/cluster-images","docId":"guides-references/cluster-images","unlisted":false},{"type":"link","label":"RGS Carbide Customers","href":"/docs/1.0.0/guides-references/carbide-customers","docId":"guides-references/carbide-customers","unlisted":false},{"type":"category","label":"Hauler Collections","description":"Guides and References for Hauler Collections","items":[{"type":"link","label":"Community Collections","href":"/docs/1.0.0/guides-references/hauler-collections/community-collections","docId":"guides-references/hauler-collections/community-collections","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Hauler Content","description":"Guides and References for Hauler Content Types","items":[{"type":"link","label":"Images","href":"/docs/1.0.0/guides-references/hauler-content/images","docId":"guides-references/hauler-content/images","unlisted":false},{"type":"link","label":"Charts","href":"/docs/1.0.0/guides-references/hauler-content/charts","docId":"guides-references/hauler-content/charts","unlisted":false},{"type":"link","label":"Files","href":"/docs/1.0.0/guides-references/hauler-content/files","docId":"guides-references/hauler-content/files","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Command Line Interface","description":"Guides and References for the Hauler Command Line","items":[{"type":"link","label":"Hauler","href":"/docs/1.0.0/guides-references/command-line/hauler","docId":"guides-references/command-line/hauler","unlisted":false},{"type":"link","label":"Hauler Store","href":"/docs/1.0.0/guides-references/command-line/hauler-store","docId":"guides-references/command-line/hauler-store","unlisted":false},{"type":"link","label":"Hauler Completion","href":"/docs/1.0.0/guides-references/command-line/hauler-completion","docId":"guides-references/command-line/hauler-completion","unlisted":false},{"type":"link","label":"Hauler Version","href":"/docs/1.0.0/guides-references/command-line/hauler-version","docId":"guides-references/command-line/hauler-version","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true},{"type":"link","label":"Known Issues/Limits","href":"/docs/1.0.0/known-limits","docId":"known-limits","unlisted":false},{"type":"link","label":"Feedback","href":"/docs/1.0.0/feedback","docId":"feedback","unlisted":false}]},"docs":{"airgap-workflow":{"id":"airgap-workflow","title":"Airgap Workflow","description":"Airgap Workflow Documentation for Hauler","sidebar":"haulerSidebar"},"core-concepts":{"id":"core-concepts","title":"Core Concepts","description":"Core Concepts Documentation for Hauler","sidebar":"haulerSidebar"},"feedback":{"id":"feedback","title":"Feedback","description":"Feedback for Hauler","sidebar":"haulerSidebar"},"guides-references/carbide-customers":{"id":"guides-references/carbide-customers","title":"RGS Carbide Customers","description":"RGS Carbide Customers Documentation","sidebar":"haulerSidebar"},"guides-references/cluster-images":{"id":"guides-references/cluster-images","title":"Fetching Cluster Images","description":"Fetching Images on a Cluster Documentation","sidebar":"haulerSidebar"},"guides-references/command-line/hauler":{"id":"guides-references/command-line/hauler","title":"Hauler (Command)","description":"Hauler CLI Reference for hauler","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-completion":{"id":"guides-references/command-line/hauler-completion","title":"Hauler Completion (Command)","description":"Hauler CLI Reference for hauler completion","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-store":{"id":"guides-references/command-line/hauler-store","title":"Hauler Store (Command)","description":"Hauler CLI Reference for hauler store","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-version":{"id":"guides-references/command-line/hauler-version","title":"Hauler Version (Command)","description":"Hauler CLI Reference for hauler version","sidebar":"haulerSidebar"},"guides-references/hauler-collections/community-collections":{"id":"guides-references/hauler-collections/community-collections","title":"Hauler Community Collections","description":"Hauler Community Collections Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/charts":{"id":"guides-references/hauler-content/charts","title":"Hauler Content - Charts","description":"Hauler Content - Charts Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/files":{"id":"guides-references/hauler-content/files","title":"Hauler Content - Files","description":"Hauler Content - Files Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/images":{"id":"guides-references/hauler-content/images","title":"Hauler Content - Images","description":"Hauler Content - Images Documentation","sidebar":"haulerSidebar"},"guides-references/manifests":{"id":"guides-references/manifests","title":"Hauler Manifests","description":"Hauler Manifests Documentation","sidebar":"haulerSidebar"},"guides-references/overview":{"id":"guides-references/overview","title":"Overview","description":"Reference Guides Overview Documentation for Hauler","sidebar":"haulerSidebar"},"intro":{"id":"intro","title":"Introduction","description":"Introduction to Rancher Government Hauler","sidebar":"haulerSidebar"},"introduction/install":{"id":"introduction/install","title":"Installation","description":"Installation Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/quickstart":{"id":"introduction/quickstart","title":"Quickstart","description":"Quickstart Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/uninstall":{"id":"introduction/uninstall","title":"Uninstall","description":"Uninstall Documentation for Hauler","sidebar":"haulerSidebar"},"known-limits":{"id":"known-limits","title":"Known Issues and Limits","description":"Known Issues and Limitations for Hauler","sidebar":"haulerSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/067e0e98.e21fcdc8.js b/assets/js/067e0e98.e21fcdc8.js new file mode 100644 index 000000000..a57e2e99a --- /dev/null +++ b/assets/js/067e0e98.e21fcdc8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8967],{7852:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>o,contentTitle:()=>a,default:()=>u,frontMatter:()=>s,metadata:()=>r,toc:()=>d});var l=i(4848),t=i(8453);const s={title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},a=void 0,r={id:"introduction/uninstall",title:"Uninstall",description:"Uninstall Documentation for Hauler",source:"@site/versioned_docs/version-1.0.0/introduction/uninstall.md",sourceDirName:"introduction",slug:"/introduction/uninstall",permalink:"/docs/1.0.0/introduction/uninstall",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.0/introduction/uninstall.md",tags:[],version:"1.0.0",frontMatter:{title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},sidebar:"haulerSidebar",previous:{title:"Installation",permalink:"/docs/1.0.0/introduction/install"},next:{title:"Overview",permalink:"/docs/1.0.0/guides-references/overview"}},o={},d=[{value:"Uninstallation Steps",id:"uninstallation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin",level:3},{value:"Homebrew",id:"homebrew",level:3},{value:"Windows",id:"windows",level:3},{value:"Manual Uninstallation Steps",id:"manual-uninstallation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin-1",level:3},{value:"Homebrew",id:"homebrew-1",level:3},{value:"Windows",id:"windows-1",level:3}];function c(n){const e={code:"code",h2:"h2",h3:"h3",pre:"pre",...(0,t.R)(),...n.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(e.h2,{id:"uninstallation-steps",children:"Uninstallation Steps"}),"\n",(0,l.jsx)(e.h3,{id:"linuxdarwin",children:"Linux/Darwin"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:"# uninstall hauler\ncurl -sfL https://get.hauler.dev | HAULER_UNINSTALL=true bash\n"})}),"\n",(0,l.jsx)(e.h3,{id:"homebrew",children:"Homebrew"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:"# installs latest release\nbrew uninstall hauler\n"})}),"\n",(0,l.jsx)(e.h3,{id:"windows",children:"Windows"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,l.jsx)(e.h2,{id:"manual-uninstallation-steps",children:"Manual Uninstallation Steps"}),"\n",(0,l.jsx)(e.h3,{id:"linuxdarwin-1",children:"Linux/Darwin"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:'# remove the hauler binary\nsudo rm -f /usr/local/bin/hauler\n\n# remove the working/installation directory\nrm -rf "$HOME/.hauler"\n'})}),"\n",(0,l.jsx)(e.h3,{id:"homebrew-1",children:"Homebrew"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:"# not applicable\n"})}),"\n",(0,l.jsx)(e.h3,{id:"windows-1",children:"Windows"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:"# coming soon\n"})})]})}function u(n={}){const{wrapper:e}={...(0,t.R)(),...n.components};return e?(0,l.jsx)(e,{...n,children:(0,l.jsx)(c,{...n})}):c(n)}},8453:(n,e,i)=>{i.d(e,{R:()=>a,x:()=>r});var l=i(6540);const t={},s=l.createContext(t);function a(n){const e=l.useContext(s);return l.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(t):n.components||t:a(n.components),l.createElement(s.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/067e0e98.e26ec6cc.js b/assets/js/067e0e98.e26ec6cc.js deleted file mode 100644 index 765624597..000000000 --- a/assets/js/067e0e98.e26ec6cc.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8967],{7852:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>o,contentTitle:()=>a,default:()=>u,frontMatter:()=>t,metadata:()=>r,toc:()=>d});var l=i(4848),s=i(8453);const t={title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},a=void 0,r={id:"introduction/uninstall",title:"Uninstall",description:"Uninstall Documentation for Hauler",source:"@site/versioned_docs/version-1.0.0/introduction/uninstall.md",sourceDirName:"introduction",slug:"/introduction/uninstall",permalink:"/hauler-docs/docs/1.0.0/introduction/uninstall",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.0/introduction/uninstall.md",tags:[],version:"1.0.0",frontMatter:{title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},sidebar:"haulerSidebar",previous:{title:"Installation",permalink:"/hauler-docs/docs/1.0.0/introduction/install"},next:{title:"Overview",permalink:"/hauler-docs/docs/1.0.0/guides-references/overview"}},o={},d=[{value:"Uninstallation Steps",id:"uninstallation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin",level:3},{value:"Homebrew",id:"homebrew",level:3},{value:"Windows",id:"windows",level:3},{value:"Manual Uninstallation Steps",id:"manual-uninstallation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin-1",level:3},{value:"Homebrew",id:"homebrew-1",level:3},{value:"Windows",id:"windows-1",level:3}];function c(n){const e={code:"code",h2:"h2",h3:"h3",pre:"pre",...(0,s.R)(),...n.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(e.h2,{id:"uninstallation-steps",children:"Uninstallation Steps"}),"\n",(0,l.jsx)(e.h3,{id:"linuxdarwin",children:"Linux/Darwin"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:"# uninstall hauler\ncurl -sfL https://get.hauler.dev | HAULER_UNINSTALL=true bash\n"})}),"\n",(0,l.jsx)(e.h3,{id:"homebrew",children:"Homebrew"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:"# installs latest release\nbrew uninstall hauler\n"})}),"\n",(0,l.jsx)(e.h3,{id:"windows",children:"Windows"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,l.jsx)(e.h2,{id:"manual-uninstallation-steps",children:"Manual Uninstallation Steps"}),"\n",(0,l.jsx)(e.h3,{id:"linuxdarwin-1",children:"Linux/Darwin"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:'# remove the hauler binary\nsudo rm -f /usr/local/bin/hauler\n\n# remove the working/installation directory\nrm -rf "$HOME/.hauler"\n'})}),"\n",(0,l.jsx)(e.h3,{id:"homebrew-1",children:"Homebrew"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:"# not applicable\n"})}),"\n",(0,l.jsx)(e.h3,{id:"windows-1",children:"Windows"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:"# coming soon\n"})})]})}function u(n={}){const{wrapper:e}={...(0,s.R)(),...n.components};return e?(0,l.jsx)(e,{...n,children:(0,l.jsx)(c,{...n})}):c(n)}},8453:(n,e,i)=>{i.d(e,{R:()=>a,x:()=>r});var l=i(6540);const s={},t=l.createContext(s);function a(n){const e=l.useContext(t);return l.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:a(n.components),l.createElement(t.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/08a39dec.3a69be1b.js b/assets/js/08a39dec.3a69be1b.js new file mode 100644 index 000000000..0dced7ddb --- /dev/null +++ b/assets/js/08a39dec.3a69be1b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4356],{5334:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>h,frontMatter:()=>a,metadata:()=>l,toc:()=>i});var r=t(4848),o=t(8453);const a={title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},s=void 0,l={id:"guides-references/command-line/hauler-store",title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",source:"@site/versioned_docs/version-0.4.1/guides-references/command-line/hauler-store.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-store",permalink:"/docs/0.4.1/guides-references/command-line/hauler-store",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.1/guides-references/command-line/hauler-store.md",tags:[],version:"0.4.1",frontMatter:{title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},sidebar:"haulerSidebar",previous:{title:"Hauler",permalink:"/docs/0.4.1/guides-references/command-line/hauler"},next:{title:"Hauler Completion",permalink:"/docs/0.4.1/guides-references/command-line/hauler-completion"}},c={},i=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler store add:",id:"hauler-store-add",level:4},{value:"hauler store copy:",id:"hauler-store-copy",level:4},{value:"hauler store extract:",id:"hauler-store-extract",level:4},{value:"hauler store info:",id:"hauler-store-info",level:4},{value:"hauler store load:",id:"hauler-store-load",level:4},{value:"hauler store save:",id:"hauler-store-save",level:4},{value:"hauler store serve:",id:"hauler-store-serve",level:4},{value:"hauler store sync:",id:"hauler-store-sync",level:4}];function d(e){const n={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",ul:"ul",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Interact with Hauler's embedded content store."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store [flags]\n hauler store [command]\n\nAliases:\n store, s\n\nAvailable Commands:\n add Add content to store\n copy Copy all store contents to another OCI registry\n extract Extract content from the store to disk\n info Print out information about the store\n load Load a content store from a store archive\n save Save a content store to a store archive\n serve Expose the content of a local store through an OCI compliant server\n sync Sync content to the embedded content store\n\nFlags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -h, --help help for store\n -s, --store string Location to create store at (default "store")\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler store [command] --help" for more information about a command.\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-add",children:[(0,r.jsx)(n.code,{children:"hauler store add"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Add content to store."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store add [flags]\n hauler store add [command]\n\nAvailable Commands:\n chart Add a local or remote chart to the content store\n file Add a file to the content store\n image Add an image to the content store\n\nFlags:\n -h, --help help for add\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n\nUse "hauler store add [command] --help" for more information about a command.\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-copy",children:[(0,r.jsx)(n.code,{children:"hauler store copy"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Copy all store contents to another OCI registry."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store copy [flags]\n\nFlags:\n -h, --help help for copy\n --insecure Toggle allowing insecure connections when copying to a remote registry\n -p, --password string Password when copying to an authenticated remote registry\n --plain-http Toggle allowing plain http connections when copying to a remote registry\n -u, --username string Username when copying to an authenticated remote registry\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-extract",children:[(0,r.jsx)(n.code,{children:"hauler store extract"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Extract content from the store to disk."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store extract [flags]\n\nAliases:\n extract, x\n\nFlags:\n -h, --help help for extract\n -o, --output string Directory to save contents to (defaults to current directory)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-info",children:[(0,r.jsx)(n.code,{children:"hauler store info"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Print out information about the store."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store info [flags]\n\nAliases:\n info, i, list, ls\n\nFlags:\n -h, --help help for info\n -o, --output string Output format (table, json) (default "table")\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-load",children:[(0,r.jsx)(n.code,{children:"hauler store load"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Load a content store from a store archive."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store load [flags]\n\nFlags:\n -h, --help help for load\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-save",children:[(0,r.jsx)(n.code,{children:"hauler store save"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Save a content store to a store archive."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store save [flags]\n\nFlags:\n -f, --filename string Name of archive (default "pkg.tar.zst")\n -h, --help help for save\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-serve",children:[(0,r.jsx)(n.code,{children:"hauler store serve"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Expose the content of a local store through an OCI compliant server."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store serve [flags]\n\nFlags:\n -c, --config string Path to a config file, will override all other configs\n -d, --daemon Toggle serving as a daemon\n --directory string Directory to use for registry backend (defaults to \'$PWD/registry\') (default "registry")\n -h, --help help for serve\n -p, --port int Port to listen on (default 5000)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-sync",children:[(0,r.jsx)(n.code,{children:"hauler store sync"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Sync content to the embedded content store."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store sync [flags]\n\nFlags:\n -f, --files strings Path to content files\n -h, --help help for sync\n -k, --key string (Optional) Path to the key for signature verification\n --products strings Used for RGS Carbide customers to supply a product and version and Hauler will retrieve the images. i.e. \'--product rancher=v2.7.6\'\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>l});var r=t(6540);const o={},a=r.createContext(o);function s(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/08a39dec.dd15d079.js b/assets/js/08a39dec.dd15d079.js deleted file mode 100644 index 34a6277f1..000000000 --- a/assets/js/08a39dec.dd15d079.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4356],{5334:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>h,frontMatter:()=>a,metadata:()=>l,toc:()=>i});var r=t(4848),o=t(8453);const a={title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},s=void 0,l={id:"guides-references/command-line/hauler-store",title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",source:"@site/versioned_docs/version-0.4.1/guides-references/command-line/hauler-store.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-store",permalink:"/hauler-docs/docs/0.4.1/guides-references/command-line/hauler-store",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.1/guides-references/command-line/hauler-store.md",tags:[],version:"0.4.1",frontMatter:{title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},sidebar:"haulerSidebar",previous:{title:"Hauler",permalink:"/hauler-docs/docs/0.4.1/guides-references/command-line/hauler"},next:{title:"Hauler Completion",permalink:"/hauler-docs/docs/0.4.1/guides-references/command-line/hauler-completion"}},c={},i=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler store add:",id:"hauler-store-add",level:4},{value:"hauler store copy:",id:"hauler-store-copy",level:4},{value:"hauler store extract:",id:"hauler-store-extract",level:4},{value:"hauler store info:",id:"hauler-store-info",level:4},{value:"hauler store load:",id:"hauler-store-load",level:4},{value:"hauler store save:",id:"hauler-store-save",level:4},{value:"hauler store serve:",id:"hauler-store-serve",level:4},{value:"hauler store sync:",id:"hauler-store-sync",level:4}];function d(e){const n={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",ul:"ul",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Interact with Hauler's embedded content store."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store [flags]\n hauler store [command]\n\nAliases:\n store, s\n\nAvailable Commands:\n add Add content to store\n copy Copy all store contents to another OCI registry\n extract Extract content from the store to disk\n info Print out information about the store\n load Load a content store from a store archive\n save Save a content store to a store archive\n serve Expose the content of a local store through an OCI compliant server\n sync Sync content to the embedded content store\n\nFlags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -h, --help help for store\n -s, --store string Location to create store at (default "store")\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler store [command] --help" for more information about a command.\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-add",children:[(0,r.jsx)(n.code,{children:"hauler store add"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Add content to store."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store add [flags]\n hauler store add [command]\n\nAvailable Commands:\n chart Add a local or remote chart to the content store\n file Add a file to the content store\n image Add an image to the content store\n\nFlags:\n -h, --help help for add\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n\nUse "hauler store add [command] --help" for more information about a command.\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-copy",children:[(0,r.jsx)(n.code,{children:"hauler store copy"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Copy all store contents to another OCI registry."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store copy [flags]\n\nFlags:\n -h, --help help for copy\n --insecure Toggle allowing insecure connections when copying to a remote registry\n -p, --password string Password when copying to an authenticated remote registry\n --plain-http Toggle allowing plain http connections when copying to a remote registry\n -u, --username string Username when copying to an authenticated remote registry\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-extract",children:[(0,r.jsx)(n.code,{children:"hauler store extract"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Extract content from the store to disk."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store extract [flags]\n\nAliases:\n extract, x\n\nFlags:\n -h, --help help for extract\n -o, --output string Directory to save contents to (defaults to current directory)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-info",children:[(0,r.jsx)(n.code,{children:"hauler store info"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Print out information about the store."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store info [flags]\n\nAliases:\n info, i, list, ls\n\nFlags:\n -h, --help help for info\n -o, --output string Output format (table, json) (default "table")\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-load",children:[(0,r.jsx)(n.code,{children:"hauler store load"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Load a content store from a store archive."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store load [flags]\n\nFlags:\n -h, --help help for load\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-save",children:[(0,r.jsx)(n.code,{children:"hauler store save"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Save a content store to a store archive."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store save [flags]\n\nFlags:\n -f, --filename string Name of archive (default "pkg.tar.zst")\n -h, --help help for save\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-serve",children:[(0,r.jsx)(n.code,{children:"hauler store serve"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Expose the content of a local store through an OCI compliant server."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store serve [flags]\n\nFlags:\n -c, --config string Path to a config file, will override all other configs\n -d, --daemon Toggle serving as a daemon\n --directory string Directory to use for registry backend (defaults to \'$PWD/registry\') (default "registry")\n -h, --help help for serve\n -p, --port int Port to listen on (default 5000)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-sync",children:[(0,r.jsx)(n.code,{children:"hauler store sync"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Sync content to the embedded content store."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store sync [flags]\n\nFlags:\n -f, --files strings Path to content files\n -h, --help help for sync\n -k, --key string (Optional) Path to the key for signature verification\n --products strings Used for RGS Carbide customers to supply a product and version and Hauler will retrieve the images. i.e. \'--product rancher=v2.7.6\'\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>l});var r=t(6540);const o={},a=r.createContext(o);function s(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/092dd1ce.97710d67.js b/assets/js/092dd1ce.97710d67.js deleted file mode 100644 index e7367bea6..000000000 --- a/assets/js/092dd1ce.97710d67.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7989],{1093:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>i,contentTitle:()=>s,default:()=>u,frontMatter:()=>l,metadata:()=>t,toc:()=>c});var o=r(4848),a=r(8453);const l={title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},s=void 0,t={id:"guides-references/command-line/hauler",title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",source:"@site/versioned_docs/version-0.4.4/guides-references/command-line/hauler.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler",permalink:"/hauler-docs/docs/0.4.4/guides-references/command-line/hauler",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.4/guides-references/command-line/hauler.md",tags:[],version:"0.4.4",frontMatter:{title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},sidebar:"haulerSidebar",previous:{title:"Files",permalink:"/hauler-docs/docs/0.4.4/guides-references/hauler-content/files"},next:{title:"Hauler Store",permalink:"/hauler-docs/docs/0.4.4/guides-references/command-line/hauler-store"}},i={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Interact with Hauler's command line."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler [flags]\n hauler [command]\n\nAvailable Commands:\n completion Generates completion scripts for various shells\n download Download OCI content from a registry and populate it on disk\n help Help about any command\n serve Run one or more of hauler\'s embedded servers types\n store Interact with hauler\'s embedded content store\n version Print the current version\n\nFlags:\n -h, --help help for hauler\n -l, --log-level string (default "info")\n\nUse "hauler [command] --help" for more information about a command.\n'})})]})}function u(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>t});var o=r(6540);const a={},l=o.createContext(a);function s(e){const n=o.useContext(l);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),o.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/092dd1ce.faae7a50.js b/assets/js/092dd1ce.faae7a50.js new file mode 100644 index 000000000..5fe3897f5 --- /dev/null +++ b/assets/js/092dd1ce.faae7a50.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7989],{1093:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>i,contentTitle:()=>l,default:()=>u,frontMatter:()=>t,metadata:()=>s,toc:()=>c});var o=r(4848),a=r(8453);const t={title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},l=void 0,s={id:"guides-references/command-line/hauler",title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",source:"@site/versioned_docs/version-0.4.4/guides-references/command-line/hauler.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler",permalink:"/docs/0.4.4/guides-references/command-line/hauler",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.4/guides-references/command-line/hauler.md",tags:[],version:"0.4.4",frontMatter:{title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},sidebar:"haulerSidebar",previous:{title:"Files",permalink:"/docs/0.4.4/guides-references/hauler-content/files"},next:{title:"Hauler Store",permalink:"/docs/0.4.4/guides-references/command-line/hauler-store"}},i={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Interact with Hauler's command line."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler [flags]\n hauler [command]\n\nAvailable Commands:\n completion Generates completion scripts for various shells\n download Download OCI content from a registry and populate it on disk\n help Help about any command\n serve Run one or more of hauler\'s embedded servers types\n store Interact with hauler\'s embedded content store\n version Print the current version\n\nFlags:\n -h, --help help for hauler\n -l, --log-level string (default "info")\n\nUse "hauler [command] --help" for more information about a command.\n'})})]})}function u(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>s});var o=r(6540);const a={},t=o.createContext(a);function l(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:l(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0c154106.9e08a50d.js b/assets/js/0c154106.9e08a50d.js new file mode 100644 index 000000000..d5dec85ab --- /dev/null +++ b/assets/js/0c154106.9e08a50d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9497],{241:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>d,frontMatter:()=>s,metadata:()=>l,toc:()=>c});var a=r(4848),n=r(8453);const s={title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},o=void 0,l={id:"introduction/quickstart",title:"Quickstart",description:"Quickstart Documentation for Hauler",source:"@site/versioned_docs/version-1.0.x/introduction/quickstart.md",sourceDirName:"introduction",slug:"/introduction/quickstart",permalink:"/docs/introduction/quickstart",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.x/introduction/quickstart.md",tags:[],version:"1.0.x",frontMatter:{title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},sidebar:"haulerSidebar",previous:{title:"Airgap Workflow",permalink:"/docs/airgap-workflow"},next:{title:"Installation",permalink:"/docs/introduction/install"}},i={},c=[{value:"Quick Installation",id:"quick-installation",level:2},{value:"Example Use of Hauler",id:"example-use-of-hauler",level:2},{value:"Add Content to the Hauler Store",id:"add-content-to-the-hauler-store",level:3},{value:"View the Hauler Store",id:"view-the-hauler-store",level:3},{value:"Save the Hauler Store",id:"save-the-hauler-store",level:3},{value:"Load the Airgapped Hauler Store",id:"load-the-airgapped-hauler-store",level:3},{value:"Serve the Hauler Store",id:"serve-the-hauler-store",level:3},{value:"Copy the Hauler Store",id:"copy-the-hauler-store",level:3}];function h(e){const t={code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,n.R)(),...e.components},{Details:r}=t;return r||function(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.p,{children:"Skipping past most of the documentation? Here's an easy to follow Quick Start Guide:"}),"\n",(0,a.jsx)(t.h2,{id:"quick-installation",children:"Quick Installation"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n"})}),"\n",(0,a.jsx)(t.h2,{id:"example-use-of-hauler",children:"Example Use of Hauler"}),"\n",(0,a.jsx)(t.h3,{id:"add-content-to-the-hauler-store",children:"Add Content to the Hauler Store"}),"\n",(0,a.jsxs)(r,{open:!0,children:[(0,a.jsx)("summary",{children:(0,a.jsx)("b",{children:"Using the Command Line:"})}),(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# add a image... defaults to docker.io\nhauler store add image neuvector/scanner:latest\n\n# add a image with a specific platform and with supply chain artifacts\n# may not work for all users due to the specified registry\nhauler store add image rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.2 --platform linux/amd64 --key carbide-key.pub\n\n# add a helm chart with a specific version\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.8.2\n\n# add a file and assign it a new name\nhauler store add file https://get.rke2.io --name install.sh\n"})})]}),"\n",(0,a.jsxs)(r,{children:[(0,a.jsx)("summary",{children:(0,a.jsx)("b",{children:"Using a Hauler Manifest:"})}),(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-yaml",metastring:'title="hauler-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\nspec:\n images:\n - name: neuvector/scanner:latest\n - name: rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.6.0\n key: carbide-key.pub\n platform: linux/amd64\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.8.2\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n - path: https://get.rke2.io\n name: install.sh\n"})}),(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# fetch the content from hauler manifest\nhauler store sync --files hauler-manifest.yaml\n"})})]}),"\n",(0,a.jsx)(t.h3,{id:"view-the-hauler-store",children:"View the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# view and verify the content in the local hauler store\nhauler store info\n"})}),"\n",(0,a.jsx)(t.h3,{id:"save-the-hauler-store",children:"Save the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# save and export the content in the local hauler store\nhauler store save --filename haul.tar.zst\n"})}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsxs)(t.strong,{children:["airgap the ",(0,a.jsx)(t.code,{children:"haul.tar.zst"})," to the disconnected environment"]})}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.h3,{id:"load-the-airgapped-hauler-store",children:"Load the Airgapped Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# load and import the airgapped content to the new local hauler store\nhauler store load haul.tar.zst\n"})}),"\n",(0,a.jsx)(t.h3,{id:"serve-the-hauler-store",children:"Serve the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# serve the content as a registry from the hauler store\n# defaults to :5000\nhauler store serve registry\n\n# serve the file content as a fileserver from the hauler store\n# defaults to :8080\nhauler store serve fileserver\n"})}),"\n",(0,a.jsx)(t.h3,{id:"copy-the-hauler-store",children:"Copy the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# copy the content to a registry from the hauler store\n# copies oci compliant artifacts\nhauler store copy registry://registry.example.com\n\n# copy the content to a directory from the hauler store\n# copies non oci compliant artifacts\nhauler store copy dir://hauler-files\n"})})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(h,{...e})}):h(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>o,x:()=>l});var a=r(6540);const n={},s=a.createContext(n);function o(e){const t=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:o(e.components),a.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0c154106.afc7761f.js b/assets/js/0c154106.afc7761f.js deleted file mode 100644 index 96c5a8e59..000000000 --- a/assets/js/0c154106.afc7761f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9497],{241:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>d,frontMatter:()=>s,metadata:()=>l,toc:()=>c});var a=r(4848),n=r(8453);const s={title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},o=void 0,l={id:"introduction/quickstart",title:"Quickstart",description:"Quickstart Documentation for Hauler",source:"@site/versioned_docs/version-1.0.x/introduction/quickstart.md",sourceDirName:"introduction",slug:"/introduction/quickstart",permalink:"/hauler-docs/docs/introduction/quickstart",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.x/introduction/quickstart.md",tags:[],version:"1.0.x",frontMatter:{title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},sidebar:"haulerSidebar",previous:{title:"Airgap Workflow",permalink:"/hauler-docs/docs/airgap-workflow"},next:{title:"Installation",permalink:"/hauler-docs/docs/introduction/install"}},i={},c=[{value:"Quick Installation",id:"quick-installation",level:2},{value:"Example Use of Hauler",id:"example-use-of-hauler",level:2},{value:"Add Content to the Hauler Store",id:"add-content-to-the-hauler-store",level:3},{value:"View the Hauler Store",id:"view-the-hauler-store",level:3},{value:"Save the Hauler Store",id:"save-the-hauler-store",level:3},{value:"Load the Airgapped Hauler Store",id:"load-the-airgapped-hauler-store",level:3},{value:"Serve the Hauler Store",id:"serve-the-hauler-store",level:3},{value:"Copy the Hauler Store",id:"copy-the-hauler-store",level:3}];function h(e){const t={code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,n.R)(),...e.components},{Details:r}=t;return r||function(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.p,{children:"Skipping past most of the documentation? Here's an easy to follow Quick Start Guide:"}),"\n",(0,a.jsx)(t.h2,{id:"quick-installation",children:"Quick Installation"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n"})}),"\n",(0,a.jsx)(t.h2,{id:"example-use-of-hauler",children:"Example Use of Hauler"}),"\n",(0,a.jsx)(t.h3,{id:"add-content-to-the-hauler-store",children:"Add Content to the Hauler Store"}),"\n",(0,a.jsxs)(r,{open:!0,children:[(0,a.jsx)("summary",{children:(0,a.jsx)("b",{children:"Using the Command Line:"})}),(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# add a image... defaults to docker.io\nhauler store add image neuvector/scanner:latest\n\n# add a image with a specific platform and with supply chain artifacts\n# may not work for all users due to the specified registry\nhauler store add image rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.2 --platform linux/amd64 --key carbide-key.pub\n\n# add a helm chart with a specific version\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.8.2\n\n# add a file and assign it a new name\nhauler store add file https://get.rke2.io --name install.sh\n"})})]}),"\n",(0,a.jsxs)(r,{children:[(0,a.jsx)("summary",{children:(0,a.jsx)("b",{children:"Using a Hauler Manifest:"})}),(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-yaml",metastring:'title="hauler-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\nspec:\n images:\n - name: neuvector/scanner:latest\n - name: rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.6.0\n key: carbide-key.pub\n platform: linux/amd64\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.8.2\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n - path: https://get.rke2.io\n name: install.sh\n"})}),(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# fetch the content from hauler manifest\nhauler store sync --files hauler-manifest.yaml\n"})})]}),"\n",(0,a.jsx)(t.h3,{id:"view-the-hauler-store",children:"View the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# view and verify the content in the local hauler store\nhauler store info\n"})}),"\n",(0,a.jsx)(t.h3,{id:"save-the-hauler-store",children:"Save the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# save and export the content in the local hauler store\nhauler store save --filename haul.tar.zst\n"})}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsxs)(t.strong,{children:["airgap the ",(0,a.jsx)(t.code,{children:"haul.tar.zst"})," to the disconnected environment"]})}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.h3,{id:"load-the-airgapped-hauler-store",children:"Load the Airgapped Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# load and import the airgapped content to the new local hauler store\nhauler store load haul.tar.zst\n"})}),"\n",(0,a.jsx)(t.h3,{id:"serve-the-hauler-store",children:"Serve the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# serve the content as a registry from the hauler store\n# defaults to :5000\nhauler store serve registry\n\n# serve the file content as a fileserver from the hauler store\n# defaults to :8080\nhauler store serve fileserver\n"})}),"\n",(0,a.jsx)(t.h3,{id:"copy-the-hauler-store",children:"Copy the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# copy the content to a registry from the hauler store\n# copies oci compliant artifacts\nhauler store copy registry://registry.example.com\n\n# copy the content to a directory from the hauler store\n# copies non oci compliant artifacts\nhauler store copy dir://hauler-files\n"})})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(h,{...e})}):h(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>o,x:()=>l});var a=r(6540);const n={},s=a.createContext(n);function o(e){const t=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:o(e.components),a.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0c54d6cd.4f54f98b.js b/assets/js/0c54d6cd.4f54f98b.js deleted file mode 100644 index dbc2d47da..000000000 --- a/assets/js/0c54d6cd.4f54f98b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1568],{4702:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"1.0.x","label":"1.0.x","banner":null,"badge":true,"noIndex":false,"className":"docs-version-1.0.x","isLast":true,"docsSidebars":{"haulerSidebar":[{"type":"link","label":"Introduction","href":"/hauler-docs/docs/intro","docId":"intro","unlisted":false},{"type":"link","label":"Core Concepts","href":"/hauler-docs/docs/core-concepts","docId":"core-concepts","unlisted":false},{"type":"link","label":"Airgap Workflow","href":"/hauler-docs/docs/airgap-workflow","docId":"airgap-workflow","unlisted":false},{"type":"category","label":"Introduction","description":"Introduction Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Quickstart","href":"/hauler-docs/docs/introduction/quickstart","docId":"introduction/quickstart","unlisted":false},{"type":"link","label":"Installation","href":"/hauler-docs/docs/introduction/install","docId":"introduction/install","unlisted":false},{"type":"link","label":"Uninstall","href":"/hauler-docs/docs/introduction/uninstall","docId":"introduction/uninstall","unlisted":false}],"collapsible":true},{"type":"category","label":"Guides & References","description":"Guides and References Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Overview","href":"/hauler-docs/docs/guides-references/overview","docId":"guides-references/overview","unlisted":false},{"type":"link","label":"Fetch Cluster Images","href":"/hauler-docs/docs/guides-references/cluster-images","docId":"guides-references/cluster-images","unlisted":false},{"type":"link","label":"RGS Carbide Customers","href":"/hauler-docs/docs/guides-references/carbide-customers","docId":"guides-references/carbide-customers","unlisted":false},{"type":"category","label":"Bootstrapping Utilities","description":"Guides and References for Hauler Bootstrapping Utilities","collapsed":false,"items":[{"type":"link","label":"Hauler Registry","href":"/hauler-docs/docs/guides-references/utilities/registry","docId":"guides-references/utilities/registry","unlisted":false},{"type":"link","label":"Hauler Fileserver","href":"/hauler-docs/docs/guides-references/utilities/fileserver","docId":"guides-references/utilities/fileserver","unlisted":false}],"collapsible":true},{"type":"link","label":"Hauler Manifests","href":"/hauler-docs/docs/guides-references/manifests","docId":"guides-references/manifests","unlisted":false},{"type":"category","label":"Hauler Collections","description":"Guides and References for Hauler Collections","items":[{"type":"link","label":"Community Collections","href":"/hauler-docs/docs/guides-references/hauler-collections/community-collections","docId":"guides-references/hauler-collections/community-collections","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Hauler Content","description":"Guides and References for Hauler Content Types","items":[{"type":"link","label":"Images","href":"/hauler-docs/docs/guides-references/hauler-content/images","docId":"guides-references/hauler-content/images","unlisted":false},{"type":"link","label":"Charts","href":"/hauler-docs/docs/guides-references/hauler-content/charts","docId":"guides-references/hauler-content/charts","unlisted":false},{"type":"link","label":"Files","href":"/hauler-docs/docs/guides-references/hauler-content/files","docId":"guides-references/hauler-content/files","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Hauler Command Line","description":"Guides and References for the Hauler Command Line","items":[{"type":"link","label":"Hauler","href":"/hauler-docs/docs/guides-references/command-line/hauler","docId":"guides-references/command-line/hauler","unlisted":false},{"type":"link","label":"Hauler Store","href":"/hauler-docs/docs/guides-references/command-line/hauler-store","docId":"guides-references/command-line/hauler-store","unlisted":false},{"type":"link","label":"Hauler Completion","href":"/hauler-docs/docs/guides-references/command-line/hauler-completion","docId":"guides-references/command-line/hauler-completion","unlisted":false},{"type":"link","label":"Hauler Version","href":"/hauler-docs/docs/guides-references/command-line/hauler-version","docId":"guides-references/command-line/hauler-version","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true},{"type":"link","label":"Known Issues/Limits","href":"/hauler-docs/docs/known-limits","docId":"known-limits","unlisted":false},{"type":"link","label":"Feedback","href":"/hauler-docs/docs/feedback","docId":"feedback","unlisted":false}]},"docs":{"airgap-workflow":{"id":"airgap-workflow","title":"Airgap Workflow","description":"Airgap Workflow Documentation for Hauler","sidebar":"haulerSidebar"},"core-concepts":{"id":"core-concepts","title":"Core Concepts","description":"Core Concepts Documentation for Hauler","sidebar":"haulerSidebar"},"feedback":{"id":"feedback","title":"Feedback","description":"Feedback for Hauler","sidebar":"haulerSidebar"},"guides-references/carbide-customers":{"id":"guides-references/carbide-customers","title":"RGS Carbide Customers","description":"RGS Carbide Customers Documentation","sidebar":"haulerSidebar"},"guides-references/cluster-images":{"id":"guides-references/cluster-images","title":"Fetching Cluster Images","description":"Fetching Images on a Cluster Documentation","sidebar":"haulerSidebar"},"guides-references/command-line/hauler":{"id":"guides-references/command-line/hauler","title":"Hauler (Command)","description":"Hauler CLI Reference for hauler","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-completion":{"id":"guides-references/command-line/hauler-completion","title":"Hauler Completion (Command)","description":"Hauler CLI Reference for hauler completion","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-login":{"id":"guides-references/command-line/hauler-login","title":"Hauler Login (Command)","description":"Hauler CLI Reference for hauler login"},"guides-references/command-line/hauler-store":{"id":"guides-references/command-line/hauler-store","title":"Hauler Store (Command)","description":"Hauler CLI Reference for hauler store","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-version":{"id":"guides-references/command-line/hauler-version","title":"Hauler Version (Command)","description":"Hauler CLI Reference for hauler version","sidebar":"haulerSidebar"},"guides-references/hauler-collections/community-collections":{"id":"guides-references/hauler-collections/community-collections","title":"Hauler Community Collections","description":"Hauler Community Collections Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/charts":{"id":"guides-references/hauler-content/charts","title":"Hauler Content - Charts","description":"Hauler Content - Charts Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/files":{"id":"guides-references/hauler-content/files","title":"Hauler Content - Files","description":"Hauler Content - Files Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/images":{"id":"guides-references/hauler-content/images","title":"Hauler Content - Images","description":"Hauler Content - Images Documentation","sidebar":"haulerSidebar"},"guides-references/manifests":{"id":"guides-references/manifests","title":"Hauler Manifests","description":"Hauler Manifests Documentation","sidebar":"haulerSidebar"},"guides-references/overview":{"id":"guides-references/overview","title":"Overview","description":"Reference Guides Overview Documentation for Hauler","sidebar":"haulerSidebar"},"guides-references/utilities/fileserver":{"id":"guides-references/utilities/fileserver","title":"Hauler Fileserver","description":"Hauler Fileserver Documentation","sidebar":"haulerSidebar"},"guides-references/utilities/registry":{"id":"guides-references/utilities/registry","title":"Hauler Registry","description":"Hauler Registry Documentation","sidebar":"haulerSidebar"},"intro":{"id":"intro","title":"Introduction","description":"Introduction to Rancher Government Hauler","sidebar":"haulerSidebar"},"introduction/install":{"id":"introduction/install","title":"Installation","description":"Installation Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/quickstart":{"id":"introduction/quickstart","title":"Quickstart","description":"Quickstart Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/uninstall":{"id":"introduction/uninstall","title":"Uninstall","description":"Uninstall Documentation for Hauler","sidebar":"haulerSidebar"},"known-limits":{"id":"known-limits","title":"Known Issues and Limits","description":"Known Issues and Limitations for Hauler","sidebar":"haulerSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/0c5a8bb3.0b63ca9e.js b/assets/js/0c5a8bb3.0b63ca9e.js new file mode 100644 index 000000000..8895267dc --- /dev/null +++ b/assets/js/0c5a8bb3.0b63ca9e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[6613],{4409:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>o});var n=r(4848),i=r(8453);const s={title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},l=void 0,c={id:"guides-references/overview",title:"Overview",description:"Reference Guides Overview Documentation for Hauler",source:"@site/versioned_docs/version-1.0.x/guides-references/overview.md",sourceDirName:"guides-references",slug:"/guides-references/overview",permalink:"/docs/guides-references/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/overview.md",tags:[],version:"1.0.x",frontMatter:{title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Uninstall",permalink:"/docs/introduction/uninstall"},next:{title:"Fetch Cluster Images",permalink:"/docs/guides-references/cluster-images"}},d={},o=[{value:"Hauler Guides & Reference Documentation",id:"hauler-guides--reference-documentation",level:2}];function a(e){const t={a:"a",h2:"h2",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Additional Overview Documentation pending a future release!"}),"\n",(0,n.jsx)(t.h2,{id:"hauler-guides--reference-documentation",children:"Hauler Guides & Reference Documentation"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Guide or Reference Documentation"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"cluster-images",children:"Fetch Cluster Images"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Fetch All Images on a Cluster"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"carbide-customers",children:"RGS Carbide Customers"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of Addons for Carbide Customers"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"utilities/registry",children:"Bootstrapping Utilities"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of Hauler Bootstrapping Utilities"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"manifests",children:"Hauler Manifests"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of Hauler Manifests"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-collections/community-collections",children:"Hauler Collections"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of Hauler Collections"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-content/images",children:"Hauler Content"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of Hauler Content Types"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"command-line/hauler",children:"Hauler Command Line"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of the Hauler Command Line Interface"})]})]})]})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>l,x:()=>c});var n=r(6540);const i={},s=n.createContext(i);function l(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0c5a8bb3.aee430c1.js b/assets/js/0c5a8bb3.aee430c1.js deleted file mode 100644 index 07b485aa3..000000000 --- a/assets/js/0c5a8bb3.aee430c1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[6613],{4409:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>o});var n=r(4848),i=r(8453);const s={title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},l=void 0,c={id:"guides-references/overview",title:"Overview",description:"Reference Guides Overview Documentation for Hauler",source:"@site/versioned_docs/version-1.0.x/guides-references/overview.md",sourceDirName:"guides-references",slug:"/guides-references/overview",permalink:"/hauler-docs/docs/guides-references/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/overview.md",tags:[],version:"1.0.x",frontMatter:{title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Uninstall",permalink:"/hauler-docs/docs/introduction/uninstall"},next:{title:"Fetch Cluster Images",permalink:"/hauler-docs/docs/guides-references/cluster-images"}},d={},o=[{value:"Hauler Guides & Reference Documentation",id:"hauler-guides--reference-documentation",level:2}];function a(e){const t={a:"a",h2:"h2",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Additional Overview Documentation pending a future release!"}),"\n",(0,n.jsx)(t.h2,{id:"hauler-guides--reference-documentation",children:"Hauler Guides & Reference Documentation"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Guide or Reference Documentation"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"cluster-images",children:"Fetch Cluster Images"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Fetch All Images on a Cluster"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"carbide-customers",children:"RGS Carbide Customers"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of Addons for Carbide Customers"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"utilities/registry",children:"Bootstrapping Utilities"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of Hauler Bootstrapping Utilities"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"manifests",children:"Hauler Manifests"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of Hauler Manifests"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-collections/community-collections",children:"Hauler Collections"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of Hauler Collections"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-content/images",children:"Hauler Content"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of Hauler Content Types"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"command-line/hauler",children:"Hauler Command Line"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of the Hauler Command Line Interface"})]})]})]})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>l,x:()=>c});var n=r(6540);const i={},s=n.createContext(i);function l(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0d694d04.11b1d5e1.js b/assets/js/0d694d04.11b1d5e1.js deleted file mode 100644 index dadaa3dc6..000000000 --- a/assets/js/0d694d04.11b1d5e1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[272],{8916:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>t,toc:()=>c});var o=l(4848),s=l(8453);const r={title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},i=void 0,t={id:"guides-references/command-line/hauler-completion",title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",source:"@site/docs/guides-references/command-line/hauler-completion.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-completion",permalink:"/hauler-docs/docs/next/guides-references/command-line/hauler-completion",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/docs/guides-references/command-line/hauler-completion.md",tags:[],version:"current",frontMatter:{title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},sidebar:"haulerSidebar",previous:{title:"Hauler Store",permalink:"/hauler-docs/docs/next/guides-references/command-line/hauler-store"},next:{title:"Hauler Version",permalink:"/hauler-docs/docs/next/guides-references/command-line/hauler-version"}},a={},c=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler completion bash:",id:"hauler-completion-bash",level:4},{value:"hauler completion fish:",id:"hauler-completion-fish",level:4},{value:"hauler completion powershell:",id:"hauler-completion-powershell",level:4},{value:"hauler completion zsh:",id:"hauler-completion-zsh",level:4}];function h(e){const n={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate an autocompletion script for hauler for the specified shell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler completion [command]\n\nAvailable Commands:\n bash Generates bash completion scripts\n fish Generates fish completion scripts\n powershell Generates powershell completion scripts\n zsh Generates zsh completion scripts\n\nFlags:\n -h, --help help for completion\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler completion [command] --help" for more information about a command.\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-bash",children:[(0,o.jsx)(n.code,{children:"hauler completion bash"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Generate the autocompletion script for the bash shell.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Note:"})," This script depends on the 'bash-completion' package."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion bash)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion bash > /etc/bash_completion.d/hauler\n\n#### macOS:\n\n hauler completion bash > $(brew --prefix)/etc/bash_completion.d/hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion bash\n\nFlags:\n -h, --help help for bash\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-fish",children:[(0,o.jsx)(n.code,{children:"hauler completion fish"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate the autocompletion script for the fish shell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion fish | source\n\nTo load completions for every new session, execute once:\n\n hauler completion fish > ~/.config/fish/completions/hauler.fish\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion fish [flags]\n\nFlags:\n -h, --help help for fish\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-powershell",children:[(0,o.jsx)(n.code,{children:"hauler completion powershell"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate the autocompletion script for powershell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion powershell | Out-String | Invoke-Expression\n\nTo load completions for every new session, add the output of the above command\nto your powershell profile.\n\nUsage:\n hauler completion powershell [flags]\n\nFlags:\n -h, --help help for powershell\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-zsh",children:[(0,o.jsx)(n.code,{children:"hauler completion zsh"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Generate the autocompletion script for the zsh shell.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Note:"})," If shell completion is not already enabled in your environment you will need to enable it."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion zsh)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion zsh > "${fpath[1]}/_hauler"\n\n#### macOS:\n\n hauler completion zsh > $(brew --prefix)/share/zsh/site-functions/_hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion zsh [flags]\n\nFlags:\n -h, --help help for zsh\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n'})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},8453:(e,n,l)=>{l.d(n,{R:()=>i,x:()=>t});var o=l(6540);const s={},r=o.createContext(s);function i(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0d694d04.7b41919e.js b/assets/js/0d694d04.7b41919e.js new file mode 100644 index 000000000..e2597b3f6 --- /dev/null +++ b/assets/js/0d694d04.7b41919e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[272],{8916:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>t,toc:()=>c});var o=l(4848),s=l(8453);const r={title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},i=void 0,t={id:"guides-references/command-line/hauler-completion",title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",source:"@site/docs/guides-references/command-line/hauler-completion.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-completion",permalink:"/docs/next/guides-references/command-line/hauler-completion",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/docs/guides-references/command-line/hauler-completion.md",tags:[],version:"current",frontMatter:{title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},sidebar:"haulerSidebar",previous:{title:"Hauler Store",permalink:"/docs/next/guides-references/command-line/hauler-store"},next:{title:"Hauler Version",permalink:"/docs/next/guides-references/command-line/hauler-version"}},a={},c=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler completion bash:",id:"hauler-completion-bash",level:4},{value:"hauler completion fish:",id:"hauler-completion-fish",level:4},{value:"hauler completion powershell:",id:"hauler-completion-powershell",level:4},{value:"hauler completion zsh:",id:"hauler-completion-zsh",level:4}];function h(e){const n={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate an autocompletion script for hauler for the specified shell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler completion [command]\n\nAvailable Commands:\n bash Generates bash completion scripts\n fish Generates fish completion scripts\n powershell Generates powershell completion scripts\n zsh Generates zsh completion scripts\n\nFlags:\n -h, --help help for completion\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler completion [command] --help" for more information about a command.\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-bash",children:[(0,o.jsx)(n.code,{children:"hauler completion bash"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Generate the autocompletion script for the bash shell.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Note:"})," This script depends on the 'bash-completion' package."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion bash)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion bash > /etc/bash_completion.d/hauler\n\n#### macOS:\n\n hauler completion bash > $(brew --prefix)/etc/bash_completion.d/hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion bash\n\nFlags:\n -h, --help help for bash\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-fish",children:[(0,o.jsx)(n.code,{children:"hauler completion fish"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate the autocompletion script for the fish shell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion fish | source\n\nTo load completions for every new session, execute once:\n\n hauler completion fish > ~/.config/fish/completions/hauler.fish\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion fish [flags]\n\nFlags:\n -h, --help help for fish\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-powershell",children:[(0,o.jsx)(n.code,{children:"hauler completion powershell"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate the autocompletion script for powershell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion powershell | Out-String | Invoke-Expression\n\nTo load completions for every new session, add the output of the above command\nto your powershell profile.\n\nUsage:\n hauler completion powershell [flags]\n\nFlags:\n -h, --help help for powershell\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-zsh",children:[(0,o.jsx)(n.code,{children:"hauler completion zsh"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Generate the autocompletion script for the zsh shell.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Note:"})," If shell completion is not already enabled in your environment you will need to enable it."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion zsh)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion zsh > "${fpath[1]}/_hauler"\n\n#### macOS:\n\n hauler completion zsh > $(brew --prefix)/share/zsh/site-functions/_hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion zsh [flags]\n\nFlags:\n -h, --help help for zsh\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n'})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},8453:(e,n,l)=>{l.d(n,{R:()=>i,x:()=>t});var o=l(6540);const s={},r=o.createContext(s);function i(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0dfe3d03.30496660.js b/assets/js/0dfe3d03.30496660.js deleted file mode 100644 index 63ec47db8..000000000 --- a/assets/js/0dfe3d03.30496660.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2774],{1517:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>t,metadata:()=>l,toc:()=>d});var a=r(4848),s=r(8453);const t={title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},i=void 0,l={id:"guides-references/cluster-images",title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",source:"@site/versioned_docs/version-0.4.1/guides-references/cluster-images.md",sourceDirName:"guides-references",slug:"/guides-references/cluster-images",permalink:"/hauler-docs/docs/0.4.1/guides-references/cluster-images",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.1/guides-references/cluster-images.md",tags:[],version:"0.4.1",frontMatter:{title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/hauler-docs/docs/0.4.1/guides-references/overview"},next:{title:"Overview",permalink:"/hauler-docs/docs/0.4.1/guides-references/hauler-collections/overview"}},c={},d=[{value:"Example Output",id:"example-output",level:3},{value:"Hauler Manifest using the Images",id:"hauler-manifest-using-the-images",level:3},{value:"Resulting Hauler Manifest",id:"resulting-hauler-manifest",level:3}];function o(e){const n={code:"code",h3:"h3",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsxs)(n.p,{children:["It may be difficult to understand exactly what ",(0,a.jsx)(n.code,{children:"content"})," is actively within your environment. Below is a simple way to generate a list of all images running in your environment, store it as an environment variable, and show the list by echoing the environment variable."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"export IMAGE_LIST=$(kubectl get pods --all-namespaces -o jsonpath=\"{.items[*].spec.containers[*].image}\" |tr -s '[[:space:]]' '\\n' |sort |uniq -c | cut -c 9-)\necho \"$IMAGE_LIST\"\n"})}),"\n",(0,a.jsx)(n.h3,{id:"example-output",children:"Example Output"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:"index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\nindex.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\nindex.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\nrancher/hardened-calico:v3.21.4-build20220228\nrancher/hardened-cluster-autoscaler:v1.8.5-build20211119\nrancher/hardened-coredns:v1.9.1-build20220318\nrancher/hardened-flannel:v0.17.0-build20220317\nrancher/hardened-k8s-metrics-server:v0.5.0-build20211119\nrancher/klipper-helm:v0.7.0-build20220315\nrancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})}),"\n",(0,a.jsx)(n.h3,{id:"hauler-manifest-using-the-images",children:"Hauler Manifest using the Images"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:"IMAGE_LIST_MODIFIED=$(cat \"$IMAGE_LIST\" | sed 's/^/ - name: /')\n# sed, stream editor, appends 2 spaces of indentation denotes\n# an entry in a list, then adds name: to match expected syntax\n"})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images-example\nspec:\n images:\n$IMAGE_LIST_MODIFIED\n"})}),"\n",(0,a.jsx)(n.h3,{id:"resulting-hauler-manifest",children:"Resulting Hauler Manifest"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images-example\nspec:\n images:\n - name: index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\n - name: index.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\n - name: index.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\n - name: rancher/hardened-calico:v3.21.4-build20220228\n - name: rancher/hardened-cluster-autoscaler:v1.8.5-build20211119\n - name: rancher/hardened-coredns:v1.9.1-build20220318\n - name: rancher/hardened-flannel:v0.17.0-build20220317\n - name: rancher/hardened-k8s-metrics-server:v0.5.0-build20211119\n - name: rancher/klipper-helm:v0.7.0-build20220315\n - name: rancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(o,{...e})}):o(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>l});var a=r(6540);const s={},t=a.createContext(s);function i(e){const n=a.useContext(t);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),a.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0dfe3d03.354e0f0d.js b/assets/js/0dfe3d03.354e0f0d.js new file mode 100644 index 000000000..f70d1a336 --- /dev/null +++ b/assets/js/0dfe3d03.354e0f0d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2774],{1517:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>t,metadata:()=>l,toc:()=>d});var a=r(4848),s=r(8453);const t={title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},i=void 0,l={id:"guides-references/cluster-images",title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",source:"@site/versioned_docs/version-0.4.1/guides-references/cluster-images.md",sourceDirName:"guides-references",slug:"/guides-references/cluster-images",permalink:"/docs/0.4.1/guides-references/cluster-images",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.1/guides-references/cluster-images.md",tags:[],version:"0.4.1",frontMatter:{title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/docs/0.4.1/guides-references/overview"},next:{title:"Overview",permalink:"/docs/0.4.1/guides-references/hauler-collections/overview"}},c={},d=[{value:"Example Output",id:"example-output",level:3},{value:"Hauler Manifest using the Images",id:"hauler-manifest-using-the-images",level:3},{value:"Resulting Hauler Manifest",id:"resulting-hauler-manifest",level:3}];function o(e){const n={code:"code",h3:"h3",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsxs)(n.p,{children:["It may be difficult to understand exactly what ",(0,a.jsx)(n.code,{children:"content"})," is actively within your environment. Below is a simple way to generate a list of all images running in your environment, store it as an environment variable, and show the list by echoing the environment variable."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"export IMAGE_LIST=$(kubectl get pods --all-namespaces -o jsonpath=\"{.items[*].spec.containers[*].image}\" |tr -s '[[:space:]]' '\\n' |sort |uniq -c | cut -c 9-)\necho \"$IMAGE_LIST\"\n"})}),"\n",(0,a.jsx)(n.h3,{id:"example-output",children:"Example Output"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:"index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\nindex.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\nindex.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\nrancher/hardened-calico:v3.21.4-build20220228\nrancher/hardened-cluster-autoscaler:v1.8.5-build20211119\nrancher/hardened-coredns:v1.9.1-build20220318\nrancher/hardened-flannel:v0.17.0-build20220317\nrancher/hardened-k8s-metrics-server:v0.5.0-build20211119\nrancher/klipper-helm:v0.7.0-build20220315\nrancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})}),"\n",(0,a.jsx)(n.h3,{id:"hauler-manifest-using-the-images",children:"Hauler Manifest using the Images"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:"IMAGE_LIST_MODIFIED=$(cat \"$IMAGE_LIST\" | sed 's/^/ - name: /')\n# sed, stream editor, appends 2 spaces of indentation denotes\n# an entry in a list, then adds name: to match expected syntax\n"})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images-example\nspec:\n images:\n$IMAGE_LIST_MODIFIED\n"})}),"\n",(0,a.jsx)(n.h3,{id:"resulting-hauler-manifest",children:"Resulting Hauler Manifest"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images-example\nspec:\n images:\n - name: index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\n - name: index.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\n - name: index.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\n - name: rancher/hardened-calico:v3.21.4-build20220228\n - name: rancher/hardened-cluster-autoscaler:v1.8.5-build20211119\n - name: rancher/hardened-coredns:v1.9.1-build20220318\n - name: rancher/hardened-flannel:v0.17.0-build20220317\n - name: rancher/hardened-k8s-metrics-server:v0.5.0-build20211119\n - name: rancher/klipper-helm:v0.7.0-build20220315\n - name: rancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(o,{...e})}):o(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>l});var a=r(6540);const s={},t=a.createContext(s);function i(e){const n=a.useContext(t);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),a.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0e07dcbd.a9ff769b.js b/assets/js/0e07dcbd.a9ff769b.js deleted file mode 100644 index 9aeee2941..000000000 --- a/assets/js/0e07dcbd.a9ff769b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3552],{1184:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>t,metadata:()=>l,toc:()=>d});var a=r(4848),s=r(8453);const t={title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},i=void 0,l={id:"guides-references/cluster-images",title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",source:"@site/versioned_docs/version-0.4.4/guides-references/cluster-images.md",sourceDirName:"guides-references",slug:"/guides-references/cluster-images",permalink:"/hauler-docs/docs/0.4.4/guides-references/cluster-images",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.4/guides-references/cluster-images.md",tags:[],version:"0.4.4",frontMatter:{title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/hauler-docs/docs/0.4.4/guides-references/overview"},next:{title:"RGS Carbide Customers",permalink:"/hauler-docs/docs/0.4.4/guides-references/carbide-customers"}},c={},d=[{value:"Example Output",id:"example-output",level:3},{value:"Hauler Manifest using the Images",id:"hauler-manifest-using-the-images",level:3},{value:"Resulting Hauler Manifest",id:"resulting-hauler-manifest",level:3}];function o(e){const n={code:"code",h3:"h3",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsxs)(n.p,{children:["It may be difficult to understand exactly what ",(0,a.jsx)(n.code,{children:"content"})," is actively within your environment. Below is a simple way to generate a list of all images running in your environment, store it as an environment variable, and show the list by echoing the environment variable."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"export IMAGE_LIST=$(kubectl get pods --all-namespaces -o jsonpath=\"{.items[*].spec.containers[*].image}\" |tr -s '[[:space:]]' '\\n' |sort |uniq -c | cut -c 9-)\necho \"$IMAGE_LIST\"\n"})}),"\n",(0,a.jsx)(n.h3,{id:"example-output",children:"Example Output"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:"index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\nindex.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\nindex.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\nrancher/hardened-calico:v3.21.4-build20220228\nrancher/hardened-cluster-autoscaler:v1.8.5-build20211119\nrancher/hardened-coredns:v1.9.1-build20220318\nrancher/hardened-flannel:v0.17.0-build20220317\nrancher/hardened-k8s-metrics-server:v0.5.0-build20211119\nrancher/klipper-helm:v0.7.0-build20220315\nrancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})}),"\n",(0,a.jsx)(n.h3,{id:"hauler-manifest-using-the-images",children:"Hauler Manifest using the Images"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:"IMAGE_LIST_MODIFIED=$(cat \"$IMAGE_LIST\" | sed 's/^/ - name: /')\n# sed, stream editor, appends 2 spaces of indentation denotes\n# an entry in a list, then adds name: to match expected syntax\n"})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images-example\nspec:\n images:\n$IMAGE_LIST_MODIFIED\n"})}),"\n",(0,a.jsx)(n.h3,{id:"resulting-hauler-manifest",children:"Resulting Hauler Manifest"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images-example\nspec:\n images:\n - name: index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\n - name: index.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\n - name: index.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\n - name: rancher/hardened-calico:v3.21.4-build20220228\n - name: rancher/hardened-cluster-autoscaler:v1.8.5-build20211119\n - name: rancher/hardened-coredns:v1.9.1-build20220318\n - name: rancher/hardened-flannel:v0.17.0-build20220317\n - name: rancher/hardened-k8s-metrics-server:v0.5.0-build20211119\n - name: rancher/klipper-helm:v0.7.0-build20220315\n - name: rancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(o,{...e})}):o(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>l});var a=r(6540);const s={},t=a.createContext(s);function i(e){const n=a.useContext(t);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),a.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0e07dcbd.abecab1d.js b/assets/js/0e07dcbd.abecab1d.js new file mode 100644 index 000000000..bcdac2706 --- /dev/null +++ b/assets/js/0e07dcbd.abecab1d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3552],{1184:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>t,metadata:()=>l,toc:()=>d});var a=r(4848),s=r(8453);const t={title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},i=void 0,l={id:"guides-references/cluster-images",title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",source:"@site/versioned_docs/version-0.4.4/guides-references/cluster-images.md",sourceDirName:"guides-references",slug:"/guides-references/cluster-images",permalink:"/docs/0.4.4/guides-references/cluster-images",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.4/guides-references/cluster-images.md",tags:[],version:"0.4.4",frontMatter:{title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/docs/0.4.4/guides-references/overview"},next:{title:"RGS Carbide Customers",permalink:"/docs/0.4.4/guides-references/carbide-customers"}},c={},d=[{value:"Example Output",id:"example-output",level:3},{value:"Hauler Manifest using the Images",id:"hauler-manifest-using-the-images",level:3},{value:"Resulting Hauler Manifest",id:"resulting-hauler-manifest",level:3}];function o(e){const n={code:"code",h3:"h3",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsxs)(n.p,{children:["It may be difficult to understand exactly what ",(0,a.jsx)(n.code,{children:"content"})," is actively within your environment. Below is a simple way to generate a list of all images running in your environment, store it as an environment variable, and show the list by echoing the environment variable."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"export IMAGE_LIST=$(kubectl get pods --all-namespaces -o jsonpath=\"{.items[*].spec.containers[*].image}\" |tr -s '[[:space:]]' '\\n' |sort |uniq -c | cut -c 9-)\necho \"$IMAGE_LIST\"\n"})}),"\n",(0,a.jsx)(n.h3,{id:"example-output",children:"Example Output"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:"index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\nindex.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\nindex.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\nrancher/hardened-calico:v3.21.4-build20220228\nrancher/hardened-cluster-autoscaler:v1.8.5-build20211119\nrancher/hardened-coredns:v1.9.1-build20220318\nrancher/hardened-flannel:v0.17.0-build20220317\nrancher/hardened-k8s-metrics-server:v0.5.0-build20211119\nrancher/klipper-helm:v0.7.0-build20220315\nrancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})}),"\n",(0,a.jsx)(n.h3,{id:"hauler-manifest-using-the-images",children:"Hauler Manifest using the Images"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:"IMAGE_LIST_MODIFIED=$(cat \"$IMAGE_LIST\" | sed 's/^/ - name: /')\n# sed, stream editor, appends 2 spaces of indentation denotes\n# an entry in a list, then adds name: to match expected syntax\n"})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images-example\nspec:\n images:\n$IMAGE_LIST_MODIFIED\n"})}),"\n",(0,a.jsx)(n.h3,{id:"resulting-hauler-manifest",children:"Resulting Hauler Manifest"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images-example\nspec:\n images:\n - name: index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\n - name: index.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\n - name: index.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\n - name: rancher/hardened-calico:v3.21.4-build20220228\n - name: rancher/hardened-cluster-autoscaler:v1.8.5-build20211119\n - name: rancher/hardened-coredns:v1.9.1-build20220318\n - name: rancher/hardened-flannel:v0.17.0-build20220317\n - name: rancher/hardened-k8s-metrics-server:v0.5.0-build20211119\n - name: rancher/klipper-helm:v0.7.0-build20220315\n - name: rancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(o,{...e})}):o(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>l});var a=r(6540);const s={},t=a.createContext(s);function i(e){const n=a.useContext(t);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),a.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0e384e19.0b02023d.js b/assets/js/0e384e19.0b02023d.js deleted file mode 100644 index 131687b75..000000000 --- a/assets/js/0e384e19.0b02023d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3976],{1512:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>s,metadata:()=>a,toc:()=>l});var r=n(4848),o=n(8453);const s={title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},i="Rancher Government Hauler",a={id:"intro",title:"Introduction",description:"Introduction to Rancher Government Hauler",source:"@site/docs/intro.md",sourceDirName:".",slug:"/intro",permalink:"/hauler-docs/docs/next/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/docs/intro.md",tags:[],version:"current",frontMatter:{title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},sidebar:"haulerSidebar",next:{title:"Core Concepts",permalink:"/hauler-docs/docs/next/core-concepts"}},c={},l=[{value:"What's Hauler?",id:"whats-hauler",level:2},{value:"Acknowledgements",id:"acknowledgements",level:2}];function d(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",img:"img",li:"li",p:"p",ul:"ul",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"rancher-government-hauler",children:"Rancher Government Hauler"}),"\n",(0,r.jsx)(t.h1,{id:"airgap-swiss-army-knife",children:"Airgap Swiss Army Knife"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.img,{alt:"hauler-logo",src:n(227).A+"",width:"2556",height:"662"})}),"\n",(0,r.jsx)(t.h2,{id:"whats-hauler",children:"What's Hauler?"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"Rancher Government Hauler"})," simplifies the airgap experience without requiring operators to adopt a specific workflow. ",(0,r.jsx)(t.code,{children:"Hauler"})," simplifies the airgapping process, by representing assets (images, charts, files, etc...) as content and collections to allow operators to easily fetch, store, package, and distribute these assets with declarative manifests or through the command line."]}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"Hauler"})," does this by storing contents and collections as OCI Artifacts and allows operators to serve contents and collections with an embedded registry and fileserver. Additionally, ",(0,r.jsx)(t.code,{children:"Hauler"})," has the ability to store and inspect various non-image OCI Artifacts."]}),"\n",(0,r.jsx)(t.h2,{id:"acknowledgements",children:"Acknowledgements"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"Hauler"})," wouldn't be possible without the open-source community, but there are a few projects that stand out:"]}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"https://github.com/oras-project/oras",children:"oras cli"})}),"\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"https://github.com/sigstore/cosign",children:"cosign"})}),"\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"https://github.com/google/go-containerregistry",children:"go-containerregistry"})}),"\n"]})]})}function h(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},227:(e,t,n)=>{n.d(t,{A:()=>r});const r=n.p+"assets/images/rgs-hauler-logo-5ff1f5df85d77bc2846abfd55a0b7319.png"},8453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>a});var r=n(6540);const o={},s=r.createContext(o);function i(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/18f564c8.e9bc4a86.js b/assets/js/0e384e19.2c8d9eb6.js similarity index 84% rename from assets/js/18f564c8.e9bc4a86.js rename to assets/js/0e384e19.2c8d9eb6.js index a2ccf082d..0a7475543 100644 --- a/assets/js/18f564c8.e9bc4a86.js +++ b/assets/js/0e384e19.2c8d9eb6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7432],{8771:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>s,metadata:()=>a,toc:()=>l});var r=n(4848),o=n(8453);const s={title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},i="Rancher Government Hauler",a={id:"intro",title:"Introduction",description:"Introduction to Rancher Government Hauler",source:"@site/versioned_docs/version-1.0.x/intro.md",sourceDirName:".",slug:"/intro",permalink:"/hauler-docs/docs/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.x/intro.md",tags:[],version:"1.0.x",frontMatter:{title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},sidebar:"haulerSidebar",next:{title:"Core Concepts",permalink:"/hauler-docs/docs/core-concepts"}},c={},l=[{value:"What's Hauler?",id:"whats-hauler",level:2},{value:"Acknowledgements",id:"acknowledgements",level:2}];function d(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",img:"img",li:"li",p:"p",ul:"ul",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"rancher-government-hauler",children:"Rancher Government Hauler"}),"\n",(0,r.jsx)(t.h1,{id:"airgap-swiss-army-knife",children:"Airgap Swiss Army Knife"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.img,{alt:"hauler-logo",src:n(227).A+"",width:"2556",height:"662"})}),"\n",(0,r.jsx)(t.h2,{id:"whats-hauler",children:"What's Hauler?"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"Rancher Government Hauler"})," simplifies the airgap experience without requiring operators to adopt a specific workflow. ",(0,r.jsx)(t.code,{children:"Hauler"})," simplifies the airgapping process, by representing assets (images, charts, files, etc...) as content and collections to allow operators to easily fetch, store, package, and distribute these assets with declarative manifests or through the command line."]}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"Hauler"})," does this by storing contents and collections as OCI Artifacts and allows operators to serve contents and collections with an embedded registry and fileserver. Additionally, ",(0,r.jsx)(t.code,{children:"Hauler"})," has the ability to store and inspect various non-image OCI Artifacts."]}),"\n",(0,r.jsx)(t.h2,{id:"acknowledgements",children:"Acknowledgements"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"Hauler"})," wouldn't be possible without the open-source community, but there are a few projects that stand out:"]}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"https://github.com/oras-project/oras",children:"oras cli"})}),"\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"https://github.com/sigstore/cosign",children:"cosign"})}),"\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"https://github.com/google/go-containerregistry",children:"go-containerregistry"})}),"\n"]})]})}function h(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},227:(e,t,n)=>{n.d(t,{A:()=>r});const r=n.p+"assets/images/rgs-hauler-logo-5ff1f5df85d77bc2846abfd55a0b7319.png"},8453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>a});var r=n(6540);const o={},s=r.createContext(o);function i(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3976],{1512:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>s,metadata:()=>a,toc:()=>l});var r=n(4848),o=n(8453);const s={title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},i="Rancher Government Hauler",a={id:"intro",title:"Introduction",description:"Introduction to Rancher Government Hauler",source:"@site/docs/intro.md",sourceDirName:".",slug:"/intro",permalink:"/docs/next/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/docs/intro.md",tags:[],version:"current",frontMatter:{title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},sidebar:"haulerSidebar",next:{title:"Core Concepts",permalink:"/docs/next/core-concepts"}},c={},l=[{value:"What's Hauler?",id:"whats-hauler",level:2},{value:"Acknowledgements",id:"acknowledgements",level:2}];function d(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",img:"img",li:"li",p:"p",ul:"ul",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"rancher-government-hauler",children:"Rancher Government Hauler"}),"\n",(0,r.jsx)(t.h1,{id:"airgap-swiss-army-knife",children:"Airgap Swiss Army Knife"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.img,{alt:"hauler-logo",src:n(227).A+"",width:"2556",height:"662"})}),"\n",(0,r.jsx)(t.h2,{id:"whats-hauler",children:"What's Hauler?"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"Rancher Government Hauler"})," simplifies the airgap experience without requiring operators to adopt a specific workflow. ",(0,r.jsx)(t.code,{children:"Hauler"})," simplifies the airgapping process, by representing assets (images, charts, files, etc...) as content and collections to allow operators to easily fetch, store, package, and distribute these assets with declarative manifests or through the command line."]}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"Hauler"})," does this by storing contents and collections as OCI Artifacts and allows operators to serve contents and collections with an embedded registry and fileserver. Additionally, ",(0,r.jsx)(t.code,{children:"Hauler"})," has the ability to store and inspect various non-image OCI Artifacts."]}),"\n",(0,r.jsx)(t.h2,{id:"acknowledgements",children:"Acknowledgements"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"Hauler"})," wouldn't be possible without the open-source community, but there are a few projects that stand out:"]}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"https://github.com/oras-project/oras",children:"oras cli"})}),"\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"https://github.com/sigstore/cosign",children:"cosign"})}),"\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"https://github.com/google/go-containerregistry",children:"go-containerregistry"})}),"\n"]})]})}function h(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},227:(e,t,n)=>{n.d(t,{A:()=>r});const r=n.p+"assets/images/rgs-hauler-logo-5ff1f5df85d77bc2846abfd55a0b7319.png"},8453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>a});var r=n(6540);const o={},s=r.createContext(o);function i(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0efd9b8a.61b34964.js b/assets/js/0efd9b8a.61b34964.js new file mode 100644 index 000000000..0ee995911 --- /dev/null +++ b/assets/js/0efd9b8a.61b34964.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5444],{8114:(o,r,e)=>{e.r(r),e.d(r,{assets:()=>l,contentTitle:()=>n,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>c});var t=e(4848),a=e(8453);const i={title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},n=void 0,s={id:"airgap-workflow",title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",source:"@site/versioned_docs/version-0.4.2/airgap-workflow.md",sourceDirName:".",slug:"/airgap-workflow",permalink:"/docs/0.4.2/airgap-workflow",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.2/airgap-workflow.md",tags:[],version:"0.4.2",frontMatter:{title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},sidebar:"haulerSidebar",previous:{title:"Core Concepts",permalink:"/docs/0.4.2/core-concepts"},next:{title:"Quickstart",permalink:"/docs/0.4.2/introduction/quickstart"}},l={},c=[{value:"Workflow Diagram",id:"workflow-diagram",level:2}];function d(o){const r={h2:"h2",img:"img",p:"p",...(0,a.R)(),...o.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h2,{id:"workflow-diagram",children:"Workflow Diagram"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.img,{alt:"hauler-workflow-diagram",src:e(8010).A+"",width:"2883",height:"1013"})}),"\n",(0,t.jsx)(r.p,{children:"Airgap Workflow Documentation pending a future release!"})]})}function u(o={}){const{wrapper:r}={...(0,a.R)(),...o.components};return r?(0,t.jsx)(r,{...o,children:(0,t.jsx)(d,{...o})}):d(o)}},8010:(o,r,e)=>{e.d(r,{A:()=>t});const t=e.p+"assets/images/hauler-workflow-diagram-a0761cc99fb86b21c4ca1a7d8a31dfc4.png"},8453:(o,r,e)=>{e.d(r,{R:()=>n,x:()=>s});var t=e(6540);const a={},i=t.createContext(a);function n(o){const r=t.useContext(i);return t.useMemo((function(){return"function"==typeof o?o(r):{...r,...o}}),[r,o])}function s(o){let r;return r=o.disableParentContext?"function"==typeof o.components?o.components(a):o.components||a:n(o.components),t.createElement(i.Provider,{value:r},o.children)}}}]); \ No newline at end of file diff --git a/assets/js/0efd9b8a.834c1796.js b/assets/js/0efd9b8a.834c1796.js deleted file mode 100644 index f563db295..000000000 --- a/assets/js/0efd9b8a.834c1796.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5444],{8114:(r,e,o)=>{o.r(e),o.d(e,{assets:()=>c,contentTitle:()=>n,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var t=o(4848),a=o(8453);const i={title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},n=void 0,s={id:"airgap-workflow",title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",source:"@site/versioned_docs/version-0.4.2/airgap-workflow.md",sourceDirName:".",slug:"/airgap-workflow",permalink:"/hauler-docs/docs/0.4.2/airgap-workflow",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.2/airgap-workflow.md",tags:[],version:"0.4.2",frontMatter:{title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},sidebar:"haulerSidebar",previous:{title:"Core Concepts",permalink:"/hauler-docs/docs/0.4.2/core-concepts"},next:{title:"Quickstart",permalink:"/hauler-docs/docs/0.4.2/introduction/quickstart"}},c={},l=[{value:"Workflow Diagram",id:"workflow-diagram",level:2}];function d(r){const e={h2:"h2",img:"img",p:"p",...(0,a.R)(),...r.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h2,{id:"workflow-diagram",children:"Workflow Diagram"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.img,{alt:"hauler-workflow-diagram",src:o(8010).A+"",width:"2883",height:"1013"})}),"\n",(0,t.jsx)(e.p,{children:"Airgap Workflow Documentation pending a future release!"})]})}function u(r={}){const{wrapper:e}={...(0,a.R)(),...r.components};return e?(0,t.jsx)(e,{...r,children:(0,t.jsx)(d,{...r})}):d(r)}},8010:(r,e,o)=>{o.d(e,{A:()=>t});const t=o.p+"assets/images/hauler-workflow-diagram-a0761cc99fb86b21c4ca1a7d8a31dfc4.png"},8453:(r,e,o)=>{o.d(e,{R:()=>n,x:()=>s});var t=o(6540);const a={},i=t.createContext(a);function n(r){const e=t.useContext(i);return t.useMemo((function(){return"function"==typeof r?r(e):{...e,...r}}),[e,r])}function s(r){let e;return e=r.disableParentContext?"function"==typeof r.components?r.components(a):r.components||a:n(r.components),t.createElement(i.Provider,{value:e},r.children)}}}]); \ No newline at end of file diff --git a/assets/js/0f67b906.3cc4fdc0.js b/assets/js/0f67b906.3cc4fdc0.js deleted file mode 100644 index 4e11af040..000000000 --- a/assets/js/0f67b906.3cc4fdc0.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4825],{5570:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>o,contentTitle:()=>i,default:()=>m,frontMatter:()=>s,metadata:()=>l,toc:()=>c});var t=a(4848),r=a(8453);const s={title:"Hauler Manifests",description:"Hauler Manifests Documentation",sidebar_label:"Hauler Manifests"},i=void 0,l={id:"guides-references/manifests",title:"Hauler Manifests",description:"Hauler Manifests Documentation",source:"@site/versioned_docs/version-1.0.0/guides-references/manifests.md",sourceDirName:"guides-references",slug:"/guides-references/manifests",permalink:"/hauler-docs/docs/1.0.0/guides-references/manifests",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.0/guides-references/manifests.md",tags:[],version:"1.0.0",frontMatter:{title:"Hauler Manifests",description:"Hauler Manifests Documentation",sidebar_label:"Hauler Manifests"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/hauler-docs/docs/1.0.0/guides-references/overview"},next:{title:"Fetch Cluster Images",permalink:"/hauler-docs/docs/1.0.0/guides-references/cluster-images"}},o={},c=[{value:"Example Manifest for Images",id:"example-manifest-for-images",level:2},{value:"Example Manifest for Charts",id:"example-manifest-for-charts",level:2},{value:"Example Manifest for Files",id:"example-manifest-for-files",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"example-manifest-for-images",children:"Example Manifest for Images"}),"\n",(0,t.jsxs)(n.p,{children:["Please review the Hauler Content Pages for ",(0,t.jsx)(n.a,{href:"/hauler-docs/docs/1.0.0/guides-references/hauler-content/images",children:"Images"})," for more detailed information."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-image-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\n annotations:\n # global flags for all images in the manifest\n # image flags override global flags\n hauler.dev/key: \n hauler.dev/platform: \n hauler.dev/registry: \nspec:\n images:\n # fetch image\n - name: neuvector/scanner\n # fetch image with full image reference\n - name: docker.io/neuvector/updater:latest\n # fetch image with full image reference with digest\n - name: docker.io/neuvector/updater@sha256:0076b356368c9988eec5f3cead771d29a377074b982f22800f4d9c8c3b215a56\n # fetch image with full image reference, specific version, specific platform\n - name: docker.io/longhornio/longhorn-ui:v1.6.0\n platform: linux/amd64\n # fetch image with full image reference, specific version, specific platform, and signature verification\n - name: docker.io/longhornio/longhorn-manager:v1.6.0\n key: cosign-public-key.pub\n platform: linux/amd64\n"})}),"\n",(0,t.jsx)(n.h2,{id:"example-manifest-for-charts",children:"Example Manifest for Charts"}),"\n",(0,t.jsxs)(n.p,{children:["Please review the Hauler Content Pages for ",(0,t.jsx)(n.a,{href:"/hauler-docs/docs/1.0.0/guides-references/hauler-content/charts",children:"Charts"})," for more detailed information."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-chart-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n # fetch helm chart\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n # fetch helm chart with specific version\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.8.2\n"})}),"\n",(0,t.jsx)(n.h2,{id:"example-manifest-for-files",children:"Example Manifest for Files"}),"\n",(0,t.jsxs)(n.p,{children:["Please review the Hauler Content Pages for ",(0,t.jsx)(n.a,{href:"/hauler-docs/docs/1.0.0/guides-references/hauler-content/files",children:"Files"})," for more detailed information."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-file-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n # fetch remote file\n - path: https://get.rke2.io\n # fetch remote file and assign new name\n - path: https://get.rke2.io\n name: install.sh\n # fetch local file\n - path: path/to/local/file.txt\n # fetch local file and assign new name\n - path: path/to/local/file.txt\n name: local-file.txt\n"})})]})}function m(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}},8453:(e,n,a)=>{a.d(n,{R:()=>i,x:()=>l});var t=a(6540);const r={},s=t.createContext(r);function i(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0f67b906.bb81d433.js b/assets/js/0f67b906.bb81d433.js new file mode 100644 index 000000000..4dbdc92d0 --- /dev/null +++ b/assets/js/0f67b906.bb81d433.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4825],{5570:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>o,contentTitle:()=>i,default:()=>m,frontMatter:()=>s,metadata:()=>l,toc:()=>c});var t=a(4848),r=a(8453);const s={title:"Hauler Manifests",description:"Hauler Manifests Documentation",sidebar_label:"Hauler Manifests"},i=void 0,l={id:"guides-references/manifests",title:"Hauler Manifests",description:"Hauler Manifests Documentation",source:"@site/versioned_docs/version-1.0.0/guides-references/manifests.md",sourceDirName:"guides-references",slug:"/guides-references/manifests",permalink:"/docs/1.0.0/guides-references/manifests",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.0/guides-references/manifests.md",tags:[],version:"1.0.0",frontMatter:{title:"Hauler Manifests",description:"Hauler Manifests Documentation",sidebar_label:"Hauler Manifests"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/docs/1.0.0/guides-references/overview"},next:{title:"Fetch Cluster Images",permalink:"/docs/1.0.0/guides-references/cluster-images"}},o={},c=[{value:"Example Manifest for Images",id:"example-manifest-for-images",level:2},{value:"Example Manifest for Charts",id:"example-manifest-for-charts",level:2},{value:"Example Manifest for Files",id:"example-manifest-for-files",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"example-manifest-for-images",children:"Example Manifest for Images"}),"\n",(0,t.jsxs)(n.p,{children:["Please review the Hauler Content Pages for ",(0,t.jsx)(n.a,{href:"/docs/1.0.0/guides-references/hauler-content/images",children:"Images"})," for more detailed information."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-image-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\n annotations:\n # global flags for all images in the manifest\n # image flags override global flags\n hauler.dev/key: \n hauler.dev/platform: \n hauler.dev/registry: \nspec:\n images:\n # fetch image\n - name: neuvector/scanner\n # fetch image with full image reference\n - name: docker.io/neuvector/updater:latest\n # fetch image with full image reference with digest\n - name: docker.io/neuvector/updater@sha256:0076b356368c9988eec5f3cead771d29a377074b982f22800f4d9c8c3b215a56\n # fetch image with full image reference, specific version, specific platform\n - name: docker.io/longhornio/longhorn-ui:v1.6.0\n platform: linux/amd64\n # fetch image with full image reference, specific version, specific platform, and signature verification\n - name: docker.io/longhornio/longhorn-manager:v1.6.0\n key: cosign-public-key.pub\n platform: linux/amd64\n"})}),"\n",(0,t.jsx)(n.h2,{id:"example-manifest-for-charts",children:"Example Manifest for Charts"}),"\n",(0,t.jsxs)(n.p,{children:["Please review the Hauler Content Pages for ",(0,t.jsx)(n.a,{href:"/docs/1.0.0/guides-references/hauler-content/charts",children:"Charts"})," for more detailed information."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-chart-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n # fetch helm chart\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n # fetch helm chart with specific version\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.8.2\n"})}),"\n",(0,t.jsx)(n.h2,{id:"example-manifest-for-files",children:"Example Manifest for Files"}),"\n",(0,t.jsxs)(n.p,{children:["Please review the Hauler Content Pages for ",(0,t.jsx)(n.a,{href:"/docs/1.0.0/guides-references/hauler-content/files",children:"Files"})," for more detailed information."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-file-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n # fetch remote file\n - path: https://get.rke2.io\n # fetch remote file and assign new name\n - path: https://get.rke2.io\n name: install.sh\n # fetch local file\n - path: path/to/local/file.txt\n # fetch local file and assign new name\n - path: path/to/local/file.txt\n name: local-file.txt\n"})})]})}function m(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}},8453:(e,n,a)=>{a.d(n,{R:()=>i,x:()=>l});var t=a(6540);const r={},s=t.createContext(r);function i(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/13b4a6fe.443a0a05.js b/assets/js/13b4a6fe.443a0a05.js deleted file mode 100644 index cf903ba7f..000000000 --- a/assets/js/13b4a6fe.443a0a05.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9511],{4805:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>c,default:()=>l,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var r=t(4848),s=t(8453);const a={title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',sidebar_label:"Images"},c=void 0,o={id:"guides-references/hauler-content/images",title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',source:"@site/versioned_docs/version-0.4.2/guides-references/hauler-content/images.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/images",permalink:"/hauler-docs/docs/0.4.2/guides-references/hauler-content/images",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.2/guides-references/hauler-content/images.md",tags:[],version:"0.4.2",frontMatter:{title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',sidebar_label:"Images"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/hauler-docs/docs/0.4.2/guides-references/hauler-content/overview"},next:{title:"Charts",permalink:"/hauler-docs/docs/0.4.2/guides-references/hauler-content/charts"}},i={},d=[];function u(e){const n={code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.p,{children:"Any OCI compatible image can be fetched remotely:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'# "shorthand" image references\nhauler store add image rancher/rancher:v2.7.9\n\n# fully qualified image references\nhauler store add image ghcr.io/fluxcd/flux-cli@sha256:02aa820c3a9c57d67208afcfc4bce9661658c17d15940aea369da259d2b976dd\n'})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>o});var r=t(6540);const s={},a=r.createContext(s);function c(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/13b4a6fe.b511c81f.js b/assets/js/13b4a6fe.b511c81f.js new file mode 100644 index 000000000..5aec6b89b --- /dev/null +++ b/assets/js/13b4a6fe.b511c81f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9511],{4805:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>o,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var r=t(4848),s=t(8453);const a={title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',sidebar_label:"Images"},o=void 0,c={id:"guides-references/hauler-content/images",title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',source:"@site/versioned_docs/version-0.4.2/guides-references/hauler-content/images.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/images",permalink:"/docs/0.4.2/guides-references/hauler-content/images",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.2/guides-references/hauler-content/images.md",tags:[],version:"0.4.2",frontMatter:{title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',sidebar_label:"Images"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/docs/0.4.2/guides-references/hauler-content/overview"},next:{title:"Charts",permalink:"/docs/0.4.2/guides-references/hauler-content/charts"}},i={},d=[];function u(e){const n={code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.p,{children:"Any OCI compatible image can be fetched remotely:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'# "shorthand" image references\nhauler store add image rancher/rancher:v2.7.9\n\n# fully qualified image references\nhauler store add image ghcr.io/fluxcd/flux-cli@sha256:02aa820c3a9c57d67208afcfc4bce9661658c17d15940aea369da259d2b976dd\n'})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>c});var r=t(6540);const s={},a=r.createContext(s);function o(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1671c90a.41d85329.js b/assets/js/1671c90a.41d85329.js deleted file mode 100644 index 255102f0c..000000000 --- a/assets/js/1671c90a.41d85329.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7239],{9098:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var o=t(4848),r=t(8453);const i={title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},s=void 0,c={id:"core-concepts",title:"Core Concepts",description:"Core Concepts Documentation for Hauler",source:"@site/versioned_docs/version-1.0.0/core-concepts.md",sourceDirName:".",slug:"/core-concepts",permalink:"/hauler-docs/docs/1.0.0/core-concepts",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.0/core-concepts.md",tags:[],version:"1.0.0",frontMatter:{title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},sidebar:"haulerSidebar",previous:{title:"Introduction",permalink:"/hauler-docs/docs/1.0.0/intro"},next:{title:"Airgap Workflow",permalink:"/hauler-docs/docs/1.0.0/airgap-workflow"}},a={},l=[{value:"Haul",id:"haul",level:2},{value:"Collections",id:"collections",level:2},{value:"Community Collections",id:"community-collections",level:3},{value:"RGS Carbide Collections",id:"rgs-carbide-collections",level:3},{value:"Content",id:"content",level:2},{value:"Declarative Content",id:"declarative-content",level:3}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"hauler-diagram",src:t(6178).A+"",width:"1949",height:"988"})}),"\n",(0,o.jsx)(n.h2,{id:"haul",children:"Haul"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauls"})," are Compressed Archive (Tarball) of Hauler Collections and Content."]})}),"\n",(0,o.jsxs)(n.p,{children:["At the heart of Hauler lies the concept of a ",(0,o.jsx)(n.code,{children:"Haul"}),". A ",(0,o.jsx)(n.code,{children:"Haul"})," is a compressed archive, often in the form of a tarball, containing Hauler collections and content. It serves as a container for grouping and transporting various data types, making it a fundamental element in the Hauler ecosystem."]}),"\n",(0,o.jsx)(n.h2,{id:"collections",children:"Collections"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are Grouping of one or more Hauler Contents."]})}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are the building blocks of Hauler. These are groupings of one or more Hauler ",(0,o.jsx)(n.code,{children:"contents"}),". Think of ",(0,o.jsx)(n.code,{children:"collections"})," as organized sets of data that collectively represent something desirable."]}),"\n",(0,o.jsx)(n.h3,{id:"community-collections",children:"Community Collections"}),"\n",(0,o.jsxs)(n.p,{children:["While ",(0,o.jsx)(n.code,{children:"collections"})," (and ",(0,o.jsx)(n.code,{children:"contents"}),") are built into Hauler, our goal is to empower operators to define their own ",(0,o.jsx)(n.code,{children:"collections"}),". This way, you can tailor Hauler to your unique requirements and take full control of your artifacts."]}),"\n",(0,o.jsx)(n.h3,{id:"rgs-carbide-collections",children:"RGS Carbide Collections"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauler"})," provides the ability to import ",(0,o.jsx)(n.code,{children:"collections"})," for the Rancher products, making it seamless for RGS Supported Customers to airgap any of the Rancher products or projects. If you haven't heard of Rancher Government Carbide, check it out ",(0,o.jsx)(n.a,{href:"https://ranchergovernment.com/carbide",children:"here"}),"!"]}),"\n",(0,o.jsx)(n.h2,{id:"content",children:"Content"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Contents"})," are Artifacts such as Images, Charts, or Files."]})}),"\n",(0,o.jsxs)(n.p,{children:["In Hauler's terminology, ",(0,o.jsx)(n.code,{children:"content"})," refers to artifacts such as ",(0,o.jsx)(n.strong,{children:"container images, helm charts, or files."})," These are the fundamental types of artifacts for ",(0,o.jsx)(n.code,{children:"Hauler"}),". To understand it a little bit better, let's break it down:"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Content"}),": The fundamental type of artifacts that Hauler recognizes (images, charts, and files)."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Artifact"}),": Anything that can be represented as an OCI (Open Container Initiative) Compliant Artifact.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"OCI Compliant Artifacts provide a standardized way to store arbitrary files, making it easier to manage content efficiently."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"declarative-content",children:"Declarative Content"}),"\n",(0,o.jsxs)(n.p,{children:["While manually adding content to ",(0,o.jsx)(n.code,{children:"Hauler"})," is an easy way to get started, there is a more sustainable approach... ",(0,o.jsx)(n.code,{children:"Hauler"})," provides a declarative and programmatic approach by allowing operators to define ",(0,o.jsx)(n.code,{children:"content"})," within a configuration file, known as a manifest. This approach ensures a more reproducable workflow for managing the lifecycle of your ",(0,o.jsx)(n.code,{children:"hauls"}),". Check it out ",(0,o.jsx)(n.a,{href:"/hauler-docs/docs/1.0.0/guides-references/manifests",children:"here"}),"!"]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},6178:(e,n,t)=>{t.d(n,{A:()=>o});const o=t.p+"assets/images/hauler-diagram-53f9182c0d98fe871fb3cf7fe8cd475a.png"},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var o=t(6540);const r={},i=o.createContext(r);function s(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1671c90a.a12ee1ef.js b/assets/js/1671c90a.a12ee1ef.js new file mode 100644 index 000000000..8413b31ca --- /dev/null +++ b/assets/js/1671c90a.a12ee1ef.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7239],{9098:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var o=t(4848),r=t(8453);const i={title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},s=void 0,c={id:"core-concepts",title:"Core Concepts",description:"Core Concepts Documentation for Hauler",source:"@site/versioned_docs/version-1.0.0/core-concepts.md",sourceDirName:".",slug:"/core-concepts",permalink:"/docs/1.0.0/core-concepts",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.0/core-concepts.md",tags:[],version:"1.0.0",frontMatter:{title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},sidebar:"haulerSidebar",previous:{title:"Introduction",permalink:"/docs/1.0.0/intro"},next:{title:"Airgap Workflow",permalink:"/docs/1.0.0/airgap-workflow"}},a={},l=[{value:"Haul",id:"haul",level:2},{value:"Collections",id:"collections",level:2},{value:"Community Collections",id:"community-collections",level:3},{value:"RGS Carbide Collections",id:"rgs-carbide-collections",level:3},{value:"Content",id:"content",level:2},{value:"Declarative Content",id:"declarative-content",level:3}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"hauler-diagram",src:t(6178).A+"",width:"1949",height:"988"})}),"\n",(0,o.jsx)(n.h2,{id:"haul",children:"Haul"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauls"})," are Compressed Archive (Tarball) of Hauler Collections and Content."]})}),"\n",(0,o.jsxs)(n.p,{children:["At the heart of Hauler lies the concept of a ",(0,o.jsx)(n.code,{children:"Haul"}),". A ",(0,o.jsx)(n.code,{children:"Haul"})," is a compressed archive, often in the form of a tarball, containing Hauler collections and content. It serves as a container for grouping and transporting various data types, making it a fundamental element in the Hauler ecosystem."]}),"\n",(0,o.jsx)(n.h2,{id:"collections",children:"Collections"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are Grouping of one or more Hauler Contents."]})}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are the building blocks of Hauler. These are groupings of one or more Hauler ",(0,o.jsx)(n.code,{children:"contents"}),". Think of ",(0,o.jsx)(n.code,{children:"collections"})," as organized sets of data that collectively represent something desirable."]}),"\n",(0,o.jsx)(n.h3,{id:"community-collections",children:"Community Collections"}),"\n",(0,o.jsxs)(n.p,{children:["While ",(0,o.jsx)(n.code,{children:"collections"})," (and ",(0,o.jsx)(n.code,{children:"contents"}),") are built into Hauler, our goal is to empower operators to define their own ",(0,o.jsx)(n.code,{children:"collections"}),". This way, you can tailor Hauler to your unique requirements and take full control of your artifacts."]}),"\n",(0,o.jsx)(n.h3,{id:"rgs-carbide-collections",children:"RGS Carbide Collections"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauler"})," provides the ability to import ",(0,o.jsx)(n.code,{children:"collections"})," for the Rancher products, making it seamless for RGS Supported Customers to airgap any of the Rancher products or projects. If you haven't heard of Rancher Government Carbide, check it out ",(0,o.jsx)(n.a,{href:"https://ranchergovernment.com/carbide",children:"here"}),"!"]}),"\n",(0,o.jsx)(n.h2,{id:"content",children:"Content"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Contents"})," are Artifacts such as Images, Charts, or Files."]})}),"\n",(0,o.jsxs)(n.p,{children:["In Hauler's terminology, ",(0,o.jsx)(n.code,{children:"content"})," refers to artifacts such as ",(0,o.jsx)(n.strong,{children:"container images, helm charts, or files."})," These are the fundamental types of artifacts for ",(0,o.jsx)(n.code,{children:"Hauler"}),". To understand it a little bit better, let's break it down:"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Content"}),": The fundamental type of artifacts that Hauler recognizes (images, charts, and files)."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Artifact"}),": Anything that can be represented as an OCI (Open Container Initiative) Compliant Artifact.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"OCI Compliant Artifacts provide a standardized way to store arbitrary files, making it easier to manage content efficiently."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"declarative-content",children:"Declarative Content"}),"\n",(0,o.jsxs)(n.p,{children:["While manually adding content to ",(0,o.jsx)(n.code,{children:"Hauler"})," is an easy way to get started, there is a more sustainable approach... ",(0,o.jsx)(n.code,{children:"Hauler"})," provides a declarative and programmatic approach by allowing operators to define ",(0,o.jsx)(n.code,{children:"content"})," within a configuration file, known as a manifest. This approach ensures a more reproducable workflow for managing the lifecycle of your ",(0,o.jsx)(n.code,{children:"hauls"}),". Check it out ",(0,o.jsx)(n.a,{href:"/docs/1.0.0/guides-references/manifests",children:"here"}),"!"]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},6178:(e,n,t)=>{t.d(n,{A:()=>o});const o=t.p+"assets/images/hauler-diagram-53f9182c0d98fe871fb3cf7fe8cd475a.png"},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var o=t(6540);const r={},i=o.createContext(r);function s(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/18b021cc.444211b4.js b/assets/js/18b021cc.444211b4.js deleted file mode 100644 index 340bb1ec4..000000000 --- a/assets/js/18b021cc.444211b4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8735],{3290:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>d,frontMatter:()=>s,metadata:()=>l,toc:()=>c});var a=r(4848),n=r(8453);const s={title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},o=void 0,l={id:"introduction/quickstart",title:"Quickstart",description:"Quickstart Documentation for Hauler",source:"@site/docs/introduction/quickstart.md",sourceDirName:"introduction",slug:"/introduction/quickstart",permalink:"/hauler-docs/docs/next/introduction/quickstart",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/docs/introduction/quickstart.md",tags:[],version:"current",frontMatter:{title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},sidebar:"haulerSidebar",previous:{title:"Airgap Workflow",permalink:"/hauler-docs/docs/next/airgap-workflow"},next:{title:"Installation",permalink:"/hauler-docs/docs/next/introduction/install"}},i={},c=[{value:"Quick Installation",id:"quick-installation",level:2},{value:"Example Use of Hauler",id:"example-use-of-hauler",level:2},{value:"Add Content to the Hauler Store",id:"add-content-to-the-hauler-store",level:3},{value:"View the Hauler Store",id:"view-the-hauler-store",level:3},{value:"Save the Hauler Store",id:"save-the-hauler-store",level:3},{value:"Load the Airgapped Hauler Store",id:"load-the-airgapped-hauler-store",level:3},{value:"Serve the Hauler Store",id:"serve-the-hauler-store",level:3},{value:"Copy the Hauler Store",id:"copy-the-hauler-store",level:3}];function h(e){const t={code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,n.R)(),...e.components},{Details:r}=t;return r||function(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.p,{children:"Skipping past most of the documentation? Here's an easy to follow Quick Start Guide:"}),"\n",(0,a.jsx)(t.h2,{id:"quick-installation",children:"Quick Installation"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n"})}),"\n",(0,a.jsx)(t.h2,{id:"example-use-of-hauler",children:"Example Use of Hauler"}),"\n",(0,a.jsx)(t.h3,{id:"add-content-to-the-hauler-store",children:"Add Content to the Hauler Store"}),"\n",(0,a.jsxs)(r,{open:!0,children:[(0,a.jsx)("summary",{children:(0,a.jsx)("b",{children:"Using the Command Line:"})}),(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# add a image... defaults to docker.io\nhauler store add image neuvector/scanner:latest\n\n# add a image with a specific platform and with supply chain artifacts\n# may not work for all users due to the specified registry\nhauler store add image rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.2 --platform linux/amd64 --key carbide-key.pub\n\n# add a helm chart with a specific version\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.8.2\n\n# add a file and assign it a new name\nhauler store add file https://get.rke2.io --name install.sh\n"})})]}),"\n",(0,a.jsxs)(r,{children:[(0,a.jsx)("summary",{children:(0,a.jsx)("b",{children:"Using a Hauler Manifest:"})}),(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-yaml",metastring:'title="hauler-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\nspec:\n images:\n - name: neuvector/scanner:latest\n - name: rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.6.0\n key: carbide-key.pub\n platform: linux/amd64\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.8.2\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n - path: https://get.rke2.io\n name: install.sh\n"})}),(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# fetch the content from hauler manifest\nhauler store sync --files hauler-manifest.yaml\n"})})]}),"\n",(0,a.jsx)(t.h3,{id:"view-the-hauler-store",children:"View the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# view and verify the content in the local hauler store\nhauler store info\n"})}),"\n",(0,a.jsx)(t.h3,{id:"save-the-hauler-store",children:"Save the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# save and export the content in the local hauler store\nhauler store save --filename haul.tar.zst\n"})}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsxs)(t.strong,{children:["airgap the ",(0,a.jsx)(t.code,{children:"haul.tar.zst"})," to the disconnected environment"]})}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.h3,{id:"load-the-airgapped-hauler-store",children:"Load the Airgapped Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# load and import the airgapped content to the new local hauler store\nhauler store load haul.tar.zst\n"})}),"\n",(0,a.jsx)(t.h3,{id:"serve-the-hauler-store",children:"Serve the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# serve the content as a readonly registry from the hauler store\n# defaults to :5000\nhauler store serve registry\n\n# serve the file content as a fileserver from the hauler store\n# defaults to :8080\nhauler store serve fileserver\n"})}),"\n",(0,a.jsx)(t.h3,{id:"copy-the-hauler-store",children:"Copy the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# copy the content to a registry from the hauler store\n# copies oci compliant artifacts\nhauler store copy registry://registry.example.com\n\n# copy the content to a directory from the hauler store\n# copies non oci compliant artifacts\nhauler store copy dir://hauler-files\n"})})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(h,{...e})}):h(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>o,x:()=>l});var a=r(6540);const n={},s=a.createContext(n);function o(e){const t=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:o(e.components),a.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/18b021cc.4a5bc8f9.js b/assets/js/18b021cc.4a5bc8f9.js new file mode 100644 index 000000000..f11018284 --- /dev/null +++ b/assets/js/18b021cc.4a5bc8f9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8735],{3290:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>d,frontMatter:()=>s,metadata:()=>l,toc:()=>c});var a=r(4848),n=r(8453);const s={title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},o=void 0,l={id:"introduction/quickstart",title:"Quickstart",description:"Quickstart Documentation for Hauler",source:"@site/docs/introduction/quickstart.md",sourceDirName:"introduction",slug:"/introduction/quickstart",permalink:"/docs/next/introduction/quickstart",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/docs/introduction/quickstart.md",tags:[],version:"current",frontMatter:{title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},sidebar:"haulerSidebar",previous:{title:"Airgap Workflow",permalink:"/docs/next/airgap-workflow"},next:{title:"Installation",permalink:"/docs/next/introduction/install"}},i={},c=[{value:"Quick Installation",id:"quick-installation",level:2},{value:"Example Use of Hauler",id:"example-use-of-hauler",level:2},{value:"Add Content to the Hauler Store",id:"add-content-to-the-hauler-store",level:3},{value:"View the Hauler Store",id:"view-the-hauler-store",level:3},{value:"Save the Hauler Store",id:"save-the-hauler-store",level:3},{value:"Load the Airgapped Hauler Store",id:"load-the-airgapped-hauler-store",level:3},{value:"Serve the Hauler Store",id:"serve-the-hauler-store",level:3},{value:"Copy the Hauler Store",id:"copy-the-hauler-store",level:3}];function h(e){const t={code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,n.R)(),...e.components},{Details:r}=t;return r||function(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.p,{children:"Skipping past most of the documentation? Here's an easy to follow Quick Start Guide:"}),"\n",(0,a.jsx)(t.h2,{id:"quick-installation",children:"Quick Installation"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n"})}),"\n",(0,a.jsx)(t.h2,{id:"example-use-of-hauler",children:"Example Use of Hauler"}),"\n",(0,a.jsx)(t.h3,{id:"add-content-to-the-hauler-store",children:"Add Content to the Hauler Store"}),"\n",(0,a.jsxs)(r,{open:!0,children:[(0,a.jsx)("summary",{children:(0,a.jsx)("b",{children:"Using the Command Line:"})}),(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# add a image... defaults to docker.io\nhauler store add image neuvector/scanner:latest\n\n# add a image with a specific platform and with supply chain artifacts\n# may not work for all users due to the specified registry\nhauler store add image rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.2 --platform linux/amd64 --key carbide-key.pub\n\n# add a helm chart with a specific version\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.8.2\n\n# add a file and assign it a new name\nhauler store add file https://get.rke2.io --name install.sh\n"})})]}),"\n",(0,a.jsxs)(r,{children:[(0,a.jsx)("summary",{children:(0,a.jsx)("b",{children:"Using a Hauler Manifest:"})}),(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-yaml",metastring:'title="hauler-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\nspec:\n images:\n - name: neuvector/scanner:latest\n - name: rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.6.0\n key: carbide-key.pub\n platform: linux/amd64\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.8.2\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n - path: https://get.rke2.io\n name: install.sh\n"})}),(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# fetch the content from hauler manifest\nhauler store sync --files hauler-manifest.yaml\n"})})]}),"\n",(0,a.jsx)(t.h3,{id:"view-the-hauler-store",children:"View the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# view and verify the content in the local hauler store\nhauler store info\n"})}),"\n",(0,a.jsx)(t.h3,{id:"save-the-hauler-store",children:"Save the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# save and export the content in the local hauler store\nhauler store save --filename haul.tar.zst\n"})}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsxs)(t.strong,{children:["airgap the ",(0,a.jsx)(t.code,{children:"haul.tar.zst"})," to the disconnected environment"]})}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.h3,{id:"load-the-airgapped-hauler-store",children:"Load the Airgapped Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# load and import the airgapped content to the new local hauler store\nhauler store load haul.tar.zst\n"})}),"\n",(0,a.jsx)(t.h3,{id:"serve-the-hauler-store",children:"Serve the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# serve the content as a readonly registry from the hauler store\n# defaults to :5000\nhauler store serve registry\n\n# serve the file content as a fileserver from the hauler store\n# defaults to :8080\nhauler store serve fileserver\n"})}),"\n",(0,a.jsx)(t.h3,{id:"copy-the-hauler-store",children:"Copy the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# copy the content to a registry from the hauler store\n# copies oci compliant artifacts\nhauler store copy registry://registry.example.com\n\n# copy the content to a directory from the hauler store\n# copies non oci compliant artifacts\nhauler store copy dir://hauler-files\n"})})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(h,{...e})}):h(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>o,x:()=>l});var a=r(6540);const n={},s=a.createContext(n);function o(e){const t=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:o(e.components),a.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/18f564c8.b6cb17ad.js b/assets/js/18f564c8.b6cb17ad.js new file mode 100644 index 000000000..33ae19091 --- /dev/null +++ b/assets/js/18f564c8.b6cb17ad.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7432],{8771:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>s,metadata:()=>a,toc:()=>l});var r=n(4848),o=n(8453);const s={title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},i="Rancher Government Hauler",a={id:"intro",title:"Introduction",description:"Introduction to Rancher Government Hauler",source:"@site/versioned_docs/version-1.0.x/intro.md",sourceDirName:".",slug:"/intro",permalink:"/docs/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.x/intro.md",tags:[],version:"1.0.x",frontMatter:{title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},sidebar:"haulerSidebar",next:{title:"Core Concepts",permalink:"/docs/core-concepts"}},c={},l=[{value:"What's Hauler?",id:"whats-hauler",level:2},{value:"Acknowledgements",id:"acknowledgements",level:2}];function d(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",img:"img",li:"li",p:"p",ul:"ul",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h1,{id:"rancher-government-hauler",children:"Rancher Government Hauler"}),"\n",(0,r.jsx)(t.h1,{id:"airgap-swiss-army-knife",children:"Airgap Swiss Army Knife"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.img,{alt:"hauler-logo",src:n(227).A+"",width:"2556",height:"662"})}),"\n",(0,r.jsx)(t.h2,{id:"whats-hauler",children:"What's Hauler?"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"Rancher Government Hauler"})," simplifies the airgap experience without requiring operators to adopt a specific workflow. ",(0,r.jsx)(t.code,{children:"Hauler"})," simplifies the airgapping process, by representing assets (images, charts, files, etc...) as content and collections to allow operators to easily fetch, store, package, and distribute these assets with declarative manifests or through the command line."]}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"Hauler"})," does this by storing contents and collections as OCI Artifacts and allows operators to serve contents and collections with an embedded registry and fileserver. Additionally, ",(0,r.jsx)(t.code,{children:"Hauler"})," has the ability to store and inspect various non-image OCI Artifacts."]}),"\n",(0,r.jsx)(t.h2,{id:"acknowledgements",children:"Acknowledgements"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"Hauler"})," wouldn't be possible without the open-source community, but there are a few projects that stand out:"]}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"https://github.com/oras-project/oras",children:"oras cli"})}),"\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"https://github.com/sigstore/cosign",children:"cosign"})}),"\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"https://github.com/google/go-containerregistry",children:"go-containerregistry"})}),"\n"]})]})}function h(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},227:(e,t,n)=>{n.d(t,{A:()=>r});const r=n.p+"assets/images/rgs-hauler-logo-5ff1f5df85d77bc2846abfd55a0b7319.png"},8453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>a});var r=n(6540);const o={},s=r.createContext(o);function i(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/18fa258f.079ef6e1.js b/assets/js/18fa258f.079ef6e1.js deleted file mode 100644 index 1551bc2ac..000000000 --- a/assets/js/18fa258f.079ef6e1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2422],{706:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>o,contentTitle:()=>s,default:()=>f,frontMatter:()=>i,metadata:()=>r,toc:()=>c});var t=l(4848),a=l(8453);const i={title:"Hauler Content - Files",description:"Hauler Content - Files Documentation",sidebar_label:"Files"},s=void 0,r={id:"guides-references/hauler-content/files",title:"Hauler Content - Files",description:"Hauler Content - Files Documentation",source:"@site/docs/guides-references/hauler-content/files.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/files",permalink:"/hauler-docs/docs/next/guides-references/hauler-content/files",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/docs/guides-references/hauler-content/files.md",tags:[],version:"current",frontMatter:{title:"Hauler Content - Files",description:"Hauler Content - Files Documentation",sidebar_label:"Files"},sidebar:"haulerSidebar",previous:{title:"Charts",permalink:"/hauler-docs/docs/next/guides-references/hauler-content/charts"},next:{title:"Hauler",permalink:"/hauler-docs/docs/next/guides-references/command-line/hauler"}},o={},c=[{value:"Hauler Command Line for Files",id:"hauler-command-line-for-files",level:2},{value:"Example Commands for Files",id:"example-commands-for-files",level:2},{value:"Hauler Manifest for Files",id:"hauler-manifest-for-files",level:2},{value:"Example Manifest for Files",id:"example-manifest-for-files",level:2}];function d(e){const n={code:"code",h2:"h2",pre:"pre",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"hauler-command-line-for-files",children:"Hauler Command Line for Files"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"hauler store add file --name \n"})}),"\n",(0,t.jsx)(n.h2,{id:"example-commands-for-files",children:"Example Commands for Files"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"# fetch remote file\nhauler store add file https://get.rke2.io\n\n# fetch local file and assign new name\nhauler store add file path/to/local/file.txt --name local-file.txt\n"})}),"\n",(0,t.jsx)(n.h2,{id:"hauler-manifest-for-files",children:"Hauler Manifest for Files"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-file-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n - path: \n name: \n"})}),"\n",(0,t.jsx)(n.h2,{id:"example-manifest-for-files",children:"Example Manifest for Files"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-file-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n # fetch remote file\n - path: https://get.rke2.io\n # fetch remote file and assign new name\n - path: https://get.rke2.io\n name: install.sh\n # fetch local file\n - path: path/to/local/file.txt\n # fetch local file and assign new name\n - path: path/to/local/file.txt\n name: local-file.txt\n"})})]})}function f(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,n,l)=>{l.d(n,{R:()=>s,x:()=>r});var t=l(6540);const a={},i=t.createContext(a);function s(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/18fa258f.95ae3a2c.js b/assets/js/18fa258f.95ae3a2c.js new file mode 100644 index 000000000..d7a95b3ad --- /dev/null +++ b/assets/js/18fa258f.95ae3a2c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2422],{706:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>r,toc:()=>c});var l=t(4848),a=t(8453);const i={title:"Hauler Content - Files",description:"Hauler Content - Files Documentation",sidebar_label:"Files"},s=void 0,r={id:"guides-references/hauler-content/files",title:"Hauler Content - Files",description:"Hauler Content - Files Documentation",source:"@site/docs/guides-references/hauler-content/files.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/files",permalink:"/docs/next/guides-references/hauler-content/files",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/docs/guides-references/hauler-content/files.md",tags:[],version:"current",frontMatter:{title:"Hauler Content - Files",description:"Hauler Content - Files Documentation",sidebar_label:"Files"},sidebar:"haulerSidebar",previous:{title:"Charts",permalink:"/docs/next/guides-references/hauler-content/charts"},next:{title:"Hauler",permalink:"/docs/next/guides-references/command-line/hauler"}},o={},c=[{value:"Hauler Command Line for Files",id:"hauler-command-line-for-files",level:2},{value:"Example Commands for Files",id:"example-commands-for-files",level:2},{value:"Hauler Manifest for Files",id:"hauler-manifest-for-files",level:2},{value:"Example Manifest for Files",id:"example-manifest-for-files",level:2}];function f(e){const n={code:"code",h2:"h2",pre:"pre",...(0,a.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.h2,{id:"hauler-command-line-for-files",children:"Hauler Command Line for Files"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"hauler store add file --name \n"})}),"\n",(0,l.jsx)(n.h2,{id:"example-commands-for-files",children:"Example Commands for Files"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"# fetch remote file\nhauler store add file https://get.rke2.io\n\n# fetch local file and assign new name\nhauler store add file path/to/local/file.txt --name local-file.txt\n"})}),"\n",(0,l.jsx)(n.h2,{id:"hauler-manifest-for-files",children:"Hauler Manifest for Files"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-file-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n - path: \n name: \n"})}),"\n",(0,l.jsx)(n.h2,{id:"example-manifest-for-files",children:"Example Manifest for Files"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-file-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n # fetch remote file\n - path: https://get.rke2.io\n # fetch remote file and assign new name\n - path: https://get.rke2.io\n name: install.sh\n # fetch local file\n - path: path/to/local/file.txt\n # fetch local file and assign new name\n - path: path/to/local/file.txt\n name: local-file.txt\n"})})]})}function d(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(f,{...e})}):f(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>r});var l=t(6540);const a={},i=l.createContext(a);function s(e){const n=l.useContext(i);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),l.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/194e810c.b66307fa.js b/assets/js/194e810c.b66307fa.js deleted file mode 100644 index c1161454d..000000000 --- a/assets/js/194e810c.b66307fa.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[902],{6990:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>l,toc:()=>d});var i=n(4848),t=n(8453);const o={title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},r=void 0,l={id:"known-limits",title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",source:"@site/versioned_docs/version-0.4.4/known-limits.md",sourceDirName:".",slug:"/known-limits",permalink:"/hauler-docs/docs/0.4.4/known-limits",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.4/known-limits.md",tags:[],version:"0.4.4",frontMatter:{title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},sidebar:"haulerSidebar",previous:{title:"Hauler Version",permalink:"/hauler-docs/docs/0.4.4/guides-references/command-line/hauler-version"}},a={},d=[{value:"Issues",id:"issues",level:2},{value:"Limitations",id:"limitations",level:2},{value:"Notices",id:"notices",level:2},{value:"Upcoming Deprecated Command(s):",id:"upcoming-deprecated-commands",level:4}];function c(e){const s={a:"a",code:"code",h2:"h2",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h2,{id:"issues",children:"Issues"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Copying SBOMS to AWS Elastic Container Registry (AWS ECR):","\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["When using ",(0,i.jsx)(s.code,{children:"hauler store copy"})," to AWS ECR, the Software Bill of Materials (SBOM) attachement will fail to copy due to changes in the way ",(0,i.jsx)(s.code,{children:"cosign"})," handles attachments. ",(0,i.jsx)(s.strong,{children:"We are investigating a way forward to address this issue."})]}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"https://github.com/sigstore/cosign/blob/main/specs/SBOM_SPEC.md",children:"https://github.com/sigstore/cosign/blob/main/specs/SBOM_SPEC.md"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"https://github.com/sigstore/cosign/issues/2755",children:"https://github.com/sigstore/cosign/issues/2755"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"limitations",children:"Limitations"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:'No "known" limitations at this time but as a reminder, Hauler and the Hauler Documentation are in active development and not Generally Available (GA).'}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"notices",children:"Notices"}),"\n",(0,i.jsx)(s.h4,{id:"upcoming-deprecated-commands",children:"Upcoming Deprecated Command(s):"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.code,{children:"hauler download"})," (alternatively ",(0,i.jsx)(s.code,{children:"hauler dl"}),") is deprecated and will be removed in a future release."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.code,{children:"hauler serve"})," is deprecated and will be removed in a future release."]}),"\n"]})]})}function u(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>r,x:()=>l});var i=n(6540);const t={},o=i.createContext(t);function r(e){const s=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/194e810c.d9d830be.js b/assets/js/194e810c.d9d830be.js new file mode 100644 index 000000000..1ac775a55 --- /dev/null +++ b/assets/js/194e810c.d9d830be.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[902],{6990:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>l,toc:()=>d});var i=n(4848),t=n(8453);const o={title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},r=void 0,l={id:"known-limits",title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",source:"@site/versioned_docs/version-0.4.4/known-limits.md",sourceDirName:".",slug:"/known-limits",permalink:"/docs/0.4.4/known-limits",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.4/known-limits.md",tags:[],version:"0.4.4",frontMatter:{title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},sidebar:"haulerSidebar",previous:{title:"Hauler Version",permalink:"/docs/0.4.4/guides-references/command-line/hauler-version"}},a={},d=[{value:"Issues",id:"issues",level:2},{value:"Limitations",id:"limitations",level:2},{value:"Notices",id:"notices",level:2},{value:"Upcoming Deprecated Command(s):",id:"upcoming-deprecated-commands",level:4}];function c(e){const s={a:"a",code:"code",h2:"h2",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h2,{id:"issues",children:"Issues"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Copying SBOMS to AWS Elastic Container Registry (AWS ECR):","\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["When using ",(0,i.jsx)(s.code,{children:"hauler store copy"})," to AWS ECR, the Software Bill of Materials (SBOM) attachement will fail to copy due to changes in the way ",(0,i.jsx)(s.code,{children:"cosign"})," handles attachments. ",(0,i.jsx)(s.strong,{children:"We are investigating a way forward to address this issue."})]}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"https://github.com/sigstore/cosign/blob/main/specs/SBOM_SPEC.md",children:"https://github.com/sigstore/cosign/blob/main/specs/SBOM_SPEC.md"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"https://github.com/sigstore/cosign/issues/2755",children:"https://github.com/sigstore/cosign/issues/2755"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"limitations",children:"Limitations"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:'No "known" limitations at this time but as a reminder, Hauler and the Hauler Documentation are in active development and not Generally Available (GA).'}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"notices",children:"Notices"}),"\n",(0,i.jsx)(s.h4,{id:"upcoming-deprecated-commands",children:"Upcoming Deprecated Command(s):"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.code,{children:"hauler download"})," (alternatively ",(0,i.jsx)(s.code,{children:"hauler dl"}),") is deprecated and will be removed in a future release."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.code,{children:"hauler serve"})," is deprecated and will be removed in a future release."]}),"\n"]})]})}function u(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>r,x:()=>l});var i=n(6540);const t={},o=i.createContext(t);function r(e){const s=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/198208fc.2d934701.js b/assets/js/198208fc.2d934701.js new file mode 100644 index 000000000..f193d3259 --- /dev/null +++ b/assets/js/198208fc.2d934701.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3322],{3189:(e,r,o)=>{o.r(r),o.d(r,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>u});var t=o(4848),n=o(8453);const i={title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",sidebar_label:"Overview"},s=void 0,c={id:"guides-references/hauler-collections/overview",title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",source:"@site/versioned_docs/version-0.4.4/guides-references/hauler-collections/overview.md",sourceDirName:"guides-references/hauler-collections",slug:"/guides-references/hauler-collections/overview",permalink:"/docs/0.4.4/guides-references/hauler-collections/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.4/guides-references/hauler-collections/overview.md",tags:[],version:"0.4.4",frontMatter:{title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"RGS Carbide Customers",permalink:"/docs/0.4.4/guides-references/carbide-customers"},next:{title:"Overview",permalink:"/docs/0.4.4/guides-references/hauler-content/overview"}},l={},u=[];function a(e){const r={p:"p",...(0,n.R)(),...e.components};return(0,t.jsx)(r.p,{children:"Hauler Collections Overview Documentation pending a future release!"})}function d(e={}){const{wrapper:r}={...(0,n.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},8453:(e,r,o)=>{o.d(r,{R:()=>s,x:()=>c});var t=o(6540);const n={},i=t.createContext(n);function s(e){const r=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:s(e.components),t.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/198208fc.fc71a355.js b/assets/js/198208fc.fc71a355.js deleted file mode 100644 index 060d12fac..000000000 --- a/assets/js/198208fc.fc71a355.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3322],{3189:(e,r,o)=>{o.r(r),o.d(r,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>s,metadata:()=>c,toc:()=>u});var t=o(4848),n=o(8453);const s={title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",sidebar_label:"Overview"},i=void 0,c={id:"guides-references/hauler-collections/overview",title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",source:"@site/versioned_docs/version-0.4.4/guides-references/hauler-collections/overview.md",sourceDirName:"guides-references/hauler-collections",slug:"/guides-references/hauler-collections/overview",permalink:"/hauler-docs/docs/0.4.4/guides-references/hauler-collections/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.4/guides-references/hauler-collections/overview.md",tags:[],version:"0.4.4",frontMatter:{title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"RGS Carbide Customers",permalink:"/hauler-docs/docs/0.4.4/guides-references/carbide-customers"},next:{title:"Overview",permalink:"/hauler-docs/docs/0.4.4/guides-references/hauler-content/overview"}},l={},u=[];function a(e){const r={p:"p",...(0,n.R)(),...e.components};return(0,t.jsx)(r.p,{children:"Hauler Collections Overview Documentation pending a future release!"})}function d(e={}){const{wrapper:r}={...(0,n.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},8453:(e,r,o)=>{o.d(r,{R:()=>i,x:()=>c});var t=o(6540);const n={},s=t.createContext(n);function i(e){const r=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),t.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/19aeb315.0646ff25.js b/assets/js/19aeb315.0646ff25.js deleted file mode 100644 index eac722c23..000000000 --- a/assets/js/19aeb315.0646ff25.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7764],{9997:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>t,contentTitle:()=>l,default:()=>u,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var o=r(4848),s=r(8453);const i={title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},l=void 0,a={id:"guides-references/command-line/hauler-version",title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",source:"@site/versioned_docs/version-0.4.3/guides-references/command-line/hauler-version.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-version",permalink:"/hauler-docs/docs/0.4.3/guides-references/command-line/hauler-version",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.3/guides-references/command-line/hauler-version.md",tags:[],version:"0.4.3",frontMatter:{title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},sidebar:"haulerSidebar",previous:{title:"Hauler Completion",permalink:"/hauler-docs/docs/0.4.3/guides-references/command-line/hauler-completion"},next:{title:"Known Issues/Limits",permalink:"/hauler-docs/docs/0.4.3/known-limits"}},t={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Print Hauler's current version."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler version [flags]\n\nAliases:\n version, v\n\nFlags:\n -h, --help help for version\n --json toggle output in JSON\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>a});var o=r(6540);const s={},i=o.createContext(s);function l(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/19aeb315.ed7b49b4.js b/assets/js/19aeb315.ed7b49b4.js new file mode 100644 index 000000000..4b3f708d3 --- /dev/null +++ b/assets/js/19aeb315.ed7b49b4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7764],{9997:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>t,toc:()=>c});var o=r(4848),s=r(8453);const i={title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},l=void 0,t={id:"guides-references/command-line/hauler-version",title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",source:"@site/versioned_docs/version-0.4.3/guides-references/command-line/hauler-version.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-version",permalink:"/docs/0.4.3/guides-references/command-line/hauler-version",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.3/guides-references/command-line/hauler-version.md",tags:[],version:"0.4.3",frontMatter:{title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},sidebar:"haulerSidebar",previous:{title:"Hauler Completion",permalink:"/docs/0.4.3/guides-references/command-line/hauler-completion"},next:{title:"Known Issues/Limits",permalink:"/docs/0.4.3/known-limits"}},a={},c=[{value:"Command Overview",id:"command-overview",level:3}];function u(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Print Hauler's current version."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler version [flags]\n\nAliases:\n version, v\n\nFlags:\n -h, --help help for version\n --json toggle output in JSON\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>t});var o=r(6540);const s={},i=o.createContext(s);function l(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1ad55919.3d13f993.js b/assets/js/1ad55919.3d13f993.js new file mode 100644 index 000000000..4bbe7c1a1 --- /dev/null +++ b/assets/js/1ad55919.3d13f993.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3412],{4649:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>s,metadata:()=>l,toc:()=>d});var a=r(4848),t=r(8453);const s={title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},i=void 0,l={id:"guides-references/cluster-images",title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",source:"@site/versioned_docs/version-1.0.x/guides-references/cluster-images.md",sourceDirName:"guides-references",slug:"/guides-references/cluster-images",permalink:"/docs/guides-references/cluster-images",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/cluster-images.md",tags:[],version:"1.0.x",frontMatter:{title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/docs/guides-references/overview"},next:{title:"RGS Carbide Customers",permalink:"/docs/guides-references/carbide-customers"}},c={},d=[{value:"Fetch Cluster Images",id:"fetch-cluster-images",level:2},{value:"Example Output",id:"example-output",level:2},{value:"Generate Hauler Manifest",id:"generate-hauler-manifest",level:2},{value:"Resulting Hauler Manifest",id:"resulting-hauler-manifest",level:2}];function o(e){const n={code:"code",h2:"h2",p:"p",pre:"pre",...(0,t.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsxs)(n.p,{children:["It may be difficult to understand exactly what ",(0,a.jsx)(n.code,{children:"content"})," is actively within your environment. Below is a simple way to generate a list of all images running in your environment, store it as an environment variable, and show the list by echoing the environment variable."]}),"\n",(0,a.jsx)(n.h2,{id:"fetch-cluster-images",children:"Fetch Cluster Images"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"# fetch all images in the cluster, remove duplicates, alphabetize, and put on a newline\nexport IMAGE_LIST=$(kubectl get pods --all-namespaces -o jsonpath=\"{.items[*].spec.containers[*].image}\" | sed 's/ /\\n/g' | sort | uniq)\n"})}),"\n",(0,a.jsx)(n.h2,{id:"example-output",children:"Example Output"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"# view the list of images from the cluster\necho $IMAGE_LIST\nindex.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\nindex.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\nindex.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\nrancher/hardened-calico:v3.21.4-build20220228\nrancher/hardened-cluster-autoscaler:v1.8.5-build20211119\nrancher/hardened-coredns:v1.9.1-build20220318\nrancher/hardened-flannel:v0.17.0-build20220317\nrancher/hardened-k8s-metrics-server:v0.5.0-build20211119\nrancher/klipper-helm:v0.7.0-build20220315\nrancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})}),"\n",(0,a.jsx)(n.h2,{id:"generate-hauler-manifest",children:"Generate Hauler Manifest"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"# add the required formatting for the image list\nexport IMAGE_LIST_MODIFIED=$(echo \"${IMAGE_LIST} | sed 's/^/ - name: /'\")\n\n# create the hauler manifest with the updated image list\ncat << EOF >> hauler-manifest.yaml\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images\nspec:\n images:\n$IMAGE_LIST_MODIFIED\nEOF\n"})}),"\n",(0,a.jsx)(n.h2,{id:"resulting-hauler-manifest",children:"Resulting Hauler Manifest"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images\nspec:\n images:\n - name: index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\n - name: index.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\n - name: index.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\n - name: rancher/hardened-calico:v3.21.4-build20220228\n - name: rancher/hardened-cluster-autoscaler:v1.8.5-build20211119\n - name: rancher/hardened-coredns:v1.9.1-build20220318\n - name: rancher/hardened-flannel:v0.17.0-build20220317\n - name: rancher/hardened-k8s-metrics-server:v0.5.0-build20211119\n - name: rancher/klipper-helm:v0.7.0-build20220315\n - name: rancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(o,{...e})}):o(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>l});var a=r(6540);const t={},s=a.createContext(t);function i(e){const n=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),a.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1ad55919.f7fcf941.js b/assets/js/1ad55919.f7fcf941.js deleted file mode 100644 index d60fe4a13..000000000 --- a/assets/js/1ad55919.f7fcf941.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3412],{4649:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>s,metadata:()=>l,toc:()=>d});var a=r(4848),t=r(8453);const s={title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},i=void 0,l={id:"guides-references/cluster-images",title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",source:"@site/versioned_docs/version-1.0.x/guides-references/cluster-images.md",sourceDirName:"guides-references",slug:"/guides-references/cluster-images",permalink:"/hauler-docs/docs/guides-references/cluster-images",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/cluster-images.md",tags:[],version:"1.0.x",frontMatter:{title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/hauler-docs/docs/guides-references/overview"},next:{title:"RGS Carbide Customers",permalink:"/hauler-docs/docs/guides-references/carbide-customers"}},c={},d=[{value:"Fetch Cluster Images",id:"fetch-cluster-images",level:2},{value:"Example Output",id:"example-output",level:2},{value:"Generate Hauler Manifest",id:"generate-hauler-manifest",level:2},{value:"Resulting Hauler Manifest",id:"resulting-hauler-manifest",level:2}];function o(e){const n={code:"code",h2:"h2",p:"p",pre:"pre",...(0,t.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsxs)(n.p,{children:["It may be difficult to understand exactly what ",(0,a.jsx)(n.code,{children:"content"})," is actively within your environment. Below is a simple way to generate a list of all images running in your environment, store it as an environment variable, and show the list by echoing the environment variable."]}),"\n",(0,a.jsx)(n.h2,{id:"fetch-cluster-images",children:"Fetch Cluster Images"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"# fetch all images in the cluster, remove duplicates, alphabetize, and put on a newline\nexport IMAGE_LIST=$(kubectl get pods --all-namespaces -o jsonpath=\"{.items[*].spec.containers[*].image}\" | sed 's/ /\\n/g' | sort | uniq)\n"})}),"\n",(0,a.jsx)(n.h2,{id:"example-output",children:"Example Output"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"# view the list of images from the cluster\necho $IMAGE_LIST\nindex.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\nindex.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\nindex.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\nrancher/hardened-calico:v3.21.4-build20220228\nrancher/hardened-cluster-autoscaler:v1.8.5-build20211119\nrancher/hardened-coredns:v1.9.1-build20220318\nrancher/hardened-flannel:v0.17.0-build20220317\nrancher/hardened-k8s-metrics-server:v0.5.0-build20211119\nrancher/klipper-helm:v0.7.0-build20220315\nrancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})}),"\n",(0,a.jsx)(n.h2,{id:"generate-hauler-manifest",children:"Generate Hauler Manifest"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"# add the required formatting for the image list\nexport IMAGE_LIST_MODIFIED=$(echo \"${IMAGE_LIST} | sed 's/^/ - name: /'\")\n\n# create the hauler manifest with the updated image list\ncat << EOF >> hauler-manifest.yaml\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images\nspec:\n images:\n$IMAGE_LIST_MODIFIED\nEOF\n"})}),"\n",(0,a.jsx)(n.h2,{id:"resulting-hauler-manifest",children:"Resulting Hauler Manifest"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images\nspec:\n images:\n - name: index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\n - name: index.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\n - name: index.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\n - name: rancher/hardened-calico:v3.21.4-build20220228\n - name: rancher/hardened-cluster-autoscaler:v1.8.5-build20211119\n - name: rancher/hardened-coredns:v1.9.1-build20220318\n - name: rancher/hardened-flannel:v0.17.0-build20220317\n - name: rancher/hardened-k8s-metrics-server:v0.5.0-build20211119\n - name: rancher/klipper-helm:v0.7.0-build20220315\n - name: rancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(o,{...e})}):o(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>l});var a=r(6540);const t={},s=a.createContext(t);function i(e){const n=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),a.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1cfe0173.3a7b3289.js b/assets/js/1cfe0173.3a7b3289.js new file mode 100644 index 000000000..9b4f61596 --- /dev/null +++ b/assets/js/1cfe0173.3a7b3289.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9651],{1937:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>t,toc:()=>c});var o=l(4848),s=l(8453);const r={title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},i=void 0,t={id:"guides-references/command-line/hauler-completion",title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",source:"@site/versioned_docs/version-1.0.0/guides-references/command-line/hauler-completion.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-completion",permalink:"/docs/1.0.0/guides-references/command-line/hauler-completion",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.0/guides-references/command-line/hauler-completion.md",tags:[],version:"1.0.0",frontMatter:{title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},sidebar:"haulerSidebar",previous:{title:"Hauler Store",permalink:"/docs/1.0.0/guides-references/command-line/hauler-store"},next:{title:"Hauler Version",permalink:"/docs/1.0.0/guides-references/command-line/hauler-version"}},a={},c=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler completion bash:",id:"hauler-completion-bash",level:4},{value:"hauler completion fish:",id:"hauler-completion-fish",level:4},{value:"hauler completion powershell:",id:"hauler-completion-powershell",level:4},{value:"hauler completion zsh:",id:"hauler-completion-zsh",level:4}];function h(e){const n={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate an autocompletion script for hauler for the specified shell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler completion [command]\n\nAvailable Commands:\n bash Generates bash completion scripts\n fish Generates fish completion scripts\n powershell Generates powershell completion scripts\n zsh Generates zsh completion scripts\n\nFlags:\n -h, --help help for completion\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler completion [command] --help" for more information about a command.\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-bash",children:[(0,o.jsx)(n.code,{children:"hauler completion bash"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Generate the autocompletion script for the bash shell.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Note:"})," This script depends on the 'bash-completion' package."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion bash)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion bash > /etc/bash_completion.d/hauler\n\n#### macOS:\n\n hauler completion bash > $(brew --prefix)/etc/bash_completion.d/hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion bash\n\nFlags:\n -h, --help help for bash\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-fish",children:[(0,o.jsx)(n.code,{children:"hauler completion fish"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate the autocompletion script for the fish shell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion fish | source\n\nTo load completions for every new session, execute once:\n\n hauler completion fish > ~/.config/fish/completions/hauler.fish\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion fish [flags]\n\nFlags:\n -h, --help help for fish\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-powershell",children:[(0,o.jsx)(n.code,{children:"hauler completion powershell"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate the autocompletion script for powershell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion powershell | Out-String | Invoke-Expression\n\nTo load completions for every new session, add the output of the above command\nto your powershell profile.\n\nUsage:\n hauler completion powershell [flags]\n\nFlags:\n -h, --help help for powershell\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-zsh",children:[(0,o.jsx)(n.code,{children:"hauler completion zsh"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Generate the autocompletion script for the zsh shell.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Note:"})," If shell completion is not already enabled in your environment you will need to enable it."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion zsh)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion zsh > "${fpath[1]}/_hauler"\n\n#### macOS:\n\n hauler completion zsh > $(brew --prefix)/share/zsh/site-functions/_hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion zsh [flags]\n\nFlags:\n -h, --help help for zsh\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n'})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},8453:(e,n,l)=>{l.d(n,{R:()=>i,x:()=>t});var o=l(6540);const s={},r=o.createContext(s);function i(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1cfe0173.d13bbbc7.js b/assets/js/1cfe0173.d13bbbc7.js deleted file mode 100644 index a9d3ca406..000000000 --- a/assets/js/1cfe0173.d13bbbc7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9651],{1937:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>t,toc:()=>c});var o=l(4848),s=l(8453);const r={title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},i=void 0,t={id:"guides-references/command-line/hauler-completion",title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",source:"@site/versioned_docs/version-1.0.0/guides-references/command-line/hauler-completion.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-completion",permalink:"/hauler-docs/docs/1.0.0/guides-references/command-line/hauler-completion",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.0/guides-references/command-line/hauler-completion.md",tags:[],version:"1.0.0",frontMatter:{title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},sidebar:"haulerSidebar",previous:{title:"Hauler Store",permalink:"/hauler-docs/docs/1.0.0/guides-references/command-line/hauler-store"},next:{title:"Hauler Version",permalink:"/hauler-docs/docs/1.0.0/guides-references/command-line/hauler-version"}},a={},c=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler completion bash:",id:"hauler-completion-bash",level:4},{value:"hauler completion fish:",id:"hauler-completion-fish",level:4},{value:"hauler completion powershell:",id:"hauler-completion-powershell",level:4},{value:"hauler completion zsh:",id:"hauler-completion-zsh",level:4}];function h(e){const n={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate an autocompletion script for hauler for the specified shell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler completion [command]\n\nAvailable Commands:\n bash Generates bash completion scripts\n fish Generates fish completion scripts\n powershell Generates powershell completion scripts\n zsh Generates zsh completion scripts\n\nFlags:\n -h, --help help for completion\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler completion [command] --help" for more information about a command.\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-bash",children:[(0,o.jsx)(n.code,{children:"hauler completion bash"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Generate the autocompletion script for the bash shell.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Note:"})," This script depends on the 'bash-completion' package."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion bash)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion bash > /etc/bash_completion.d/hauler\n\n#### macOS:\n\n hauler completion bash > $(brew --prefix)/etc/bash_completion.d/hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion bash\n\nFlags:\n -h, --help help for bash\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-fish",children:[(0,o.jsx)(n.code,{children:"hauler completion fish"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate the autocompletion script for the fish shell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion fish | source\n\nTo load completions for every new session, execute once:\n\n hauler completion fish > ~/.config/fish/completions/hauler.fish\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion fish [flags]\n\nFlags:\n -h, --help help for fish\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-powershell",children:[(0,o.jsx)(n.code,{children:"hauler completion powershell"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate the autocompletion script for powershell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion powershell | Out-String | Invoke-Expression\n\nTo load completions for every new session, add the output of the above command\nto your powershell profile.\n\nUsage:\n hauler completion powershell [flags]\n\nFlags:\n -h, --help help for powershell\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-zsh",children:[(0,o.jsx)(n.code,{children:"hauler completion zsh"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Generate the autocompletion script for the zsh shell.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Note:"})," If shell completion is not already enabled in your environment you will need to enable it."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion zsh)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion zsh > "${fpath[1]}/_hauler"\n\n#### macOS:\n\n hauler completion zsh > $(brew --prefix)/share/zsh/site-functions/_hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion zsh [flags]\n\nFlags:\n -h, --help help for zsh\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n'})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},8453:(e,n,l)=>{l.d(n,{R:()=>i,x:()=>t});var o=l(6540);const s={},r=o.createContext(s);function i(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/1db0d189.b488d490.js b/assets/js/1db0d189.b488d490.js deleted file mode 100644 index 83c2c1415..000000000 --- a/assets/js/1db0d189.b488d490.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4306],{948:(r,e,o)=>{o.r(e),o.d(e,{assets:()=>c,contentTitle:()=>n,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var t=o(4848),a=o(8453);const i={title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},n=void 0,s={id:"airgap-workflow",title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",source:"@site/versioned_docs/version-0.4.4/airgap-workflow.md",sourceDirName:".",slug:"/airgap-workflow",permalink:"/hauler-docs/docs/0.4.4/airgap-workflow",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.4/airgap-workflow.md",tags:[],version:"0.4.4",frontMatter:{title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},sidebar:"haulerSidebar",previous:{title:"Core Concepts",permalink:"/hauler-docs/docs/0.4.4/core-concepts"},next:{title:"Quickstart",permalink:"/hauler-docs/docs/0.4.4/introduction/quickstart"}},c={},l=[{value:"Workflow Diagram",id:"workflow-diagram",level:2}];function d(r){const e={h2:"h2",img:"img",p:"p",...(0,a.R)(),...r.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h2,{id:"workflow-diagram",children:"Workflow Diagram"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.img,{alt:"hauler-workflow-diagram",src:o(8010).A+"",width:"2883",height:"1013"})}),"\n",(0,t.jsx)(e.p,{children:"Airgap Workflow Documentation pending a future release!"})]})}function u(r={}){const{wrapper:e}={...(0,a.R)(),...r.components};return e?(0,t.jsx)(e,{...r,children:(0,t.jsx)(d,{...r})}):d(r)}},8010:(r,e,o)=>{o.d(e,{A:()=>t});const t=o.p+"assets/images/hauler-workflow-diagram-a0761cc99fb86b21c4ca1a7d8a31dfc4.png"},8453:(r,e,o)=>{o.d(e,{R:()=>n,x:()=>s});var t=o(6540);const a={},i=t.createContext(a);function n(r){const e=t.useContext(i);return t.useMemo((function(){return"function"==typeof r?r(e):{...e,...r}}),[e,r])}function s(r){let e;return e=r.disableParentContext?"function"==typeof r.components?r.components(a):r.components||a:n(r.components),t.createElement(i.Provider,{value:e},r.children)}}}]); \ No newline at end of file diff --git a/assets/js/1db0d189.f99979ab.js b/assets/js/1db0d189.f99979ab.js new file mode 100644 index 000000000..03357e44a --- /dev/null +++ b/assets/js/1db0d189.f99979ab.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4306],{948:(o,r,e)=>{e.r(r),e.d(r,{assets:()=>l,contentTitle:()=>n,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>c});var t=e(4848),a=e(8453);const i={title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},n=void 0,s={id:"airgap-workflow",title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",source:"@site/versioned_docs/version-0.4.4/airgap-workflow.md",sourceDirName:".",slug:"/airgap-workflow",permalink:"/docs/0.4.4/airgap-workflow",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.4/airgap-workflow.md",tags:[],version:"0.4.4",frontMatter:{title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},sidebar:"haulerSidebar",previous:{title:"Core Concepts",permalink:"/docs/0.4.4/core-concepts"},next:{title:"Quickstart",permalink:"/docs/0.4.4/introduction/quickstart"}},l={},c=[{value:"Workflow Diagram",id:"workflow-diagram",level:2}];function d(o){const r={h2:"h2",img:"img",p:"p",...(0,a.R)(),...o.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h2,{id:"workflow-diagram",children:"Workflow Diagram"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.img,{alt:"hauler-workflow-diagram",src:e(8010).A+"",width:"2883",height:"1013"})}),"\n",(0,t.jsx)(r.p,{children:"Airgap Workflow Documentation pending a future release!"})]})}function u(o={}){const{wrapper:r}={...(0,a.R)(),...o.components};return r?(0,t.jsx)(r,{...o,children:(0,t.jsx)(d,{...o})}):d(o)}},8010:(o,r,e)=>{e.d(r,{A:()=>t});const t=e.p+"assets/images/hauler-workflow-diagram-a0761cc99fb86b21c4ca1a7d8a31dfc4.png"},8453:(o,r,e)=>{e.d(r,{R:()=>n,x:()=>s});var t=e(6540);const a={},i=t.createContext(a);function n(o){const r=t.useContext(i);return t.useMemo((function(){return"function"==typeof o?o(r):{...r,...o}}),[r,o])}function s(o){let r;return r=o.disableParentContext?"function"==typeof o.components?o.components(a):o.components||a:n(o.components),t.createElement(i.Provider,{value:r},o.children)}}}]); \ No newline at end of file diff --git a/assets/js/238f7f49.c683b918.js b/assets/js/238f7f49.c683b918.js deleted file mode 100644 index 7641ec1be..000000000 --- a/assets/js/238f7f49.c683b918.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5398],{2924:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var r=n(4848),s=n(8453);const a={title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',sidebar_label:"Charts"},o=void 0,c={id:"guides-references/hauler-content/charts",title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',source:"@site/versioned_docs/version-0.4.4/guides-references/hauler-content/charts.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/charts",permalink:"/hauler-docs/docs/0.4.4/guides-references/hauler-content/charts",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.4/guides-references/hauler-content/charts.md",tags:[],version:"0.4.4",frontMatter:{title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',sidebar_label:"Charts"},sidebar:"haulerSidebar",previous:{title:"Images",permalink:"/hauler-docs/docs/0.4.4/guides-references/hauler-content/images"},next:{title:"Files",permalink:"/hauler-docs/docs/0.4.4/guides-references/hauler-content/files"}},i={},l=[];function d(e){const t={admonition:"admonition",code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.admonition,{type:"tip",children:(0,r.jsx)(t.p,{children:"Hauler supports the experimental format of Helm Chart OCI Artifacts, but can also be represented as the usual Tarball Artifact!"})}),"\n",(0,r.jsx)(t.p,{children:"Helm charts represented as OCI content:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# add a helm chart (defaults to latest version)\nhauler store add chart loki --repo https://grafana.github.io/helm-charts\n\n# add a specific version of a helm chart\nhauler store add chart loki --repo https://grafana.github.io/helm-charts --version 5.42.2\n\n# install directly from the oci content\nhelm install loki oci://localhost:3000/library/loki --version 5.42.2\n"})})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>c});var r=n(6540);const s={},a=r.createContext(s);function o(e){const t=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/238f7f49.d0ff35ac.js b/assets/js/238f7f49.d0ff35ac.js new file mode 100644 index 000000000..38bf32e42 --- /dev/null +++ b/assets/js/238f7f49.d0ff35ac.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5398],{2924:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>u,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var r=n(4848),s=n(8453);const a={title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',sidebar_label:"Charts"},o=void 0,i={id:"guides-references/hauler-content/charts",title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',source:"@site/versioned_docs/version-0.4.4/guides-references/hauler-content/charts.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/charts",permalink:"/docs/0.4.4/guides-references/hauler-content/charts",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.4/guides-references/hauler-content/charts.md",tags:[],version:"0.4.4",frontMatter:{title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',sidebar_label:"Charts"},sidebar:"haulerSidebar",previous:{title:"Images",permalink:"/docs/0.4.4/guides-references/hauler-content/images"},next:{title:"Files",permalink:"/docs/0.4.4/guides-references/hauler-content/files"}},c={},l=[];function d(e){const t={admonition:"admonition",code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.admonition,{type:"tip",children:(0,r.jsx)(t.p,{children:"Hauler supports the experimental format of Helm Chart OCI Artifacts, but can also be represented as the usual Tarball Artifact!"})}),"\n",(0,r.jsx)(t.p,{children:"Helm charts represented as OCI content:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# add a helm chart (defaults to latest version)\nhauler store add chart loki --repo https://grafana.github.io/helm-charts\n\n# add a specific version of a helm chart\nhauler store add chart loki --repo https://grafana.github.io/helm-charts --version 5.42.2\n\n# install directly from the oci content\nhelm install loki oci://localhost:3000/library/loki --version 5.42.2\n"})})]})}function u(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>i});var r=n(6540);const s={},a=r.createContext(s);function o(e){const t=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/263082ee.2dab9ab3.js b/assets/js/263082ee.2dab9ab3.js deleted file mode 100644 index a2bca4117..000000000 --- a/assets/js/263082ee.2dab9ab3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[6590],{9376:(e,r,a)=>{a.r(r),a.d(r,{assets:()=>o,contentTitle:()=>c,default:()=>d,frontMatter:()=>s,metadata:()=>h,toc:()=>l});var t=a(4848),n=a(8453);const s={title:"Hauler Content - Charts",description:"Hauler Content - Charts Documentation",sidebar_label:"Charts"},c=void 0,h={id:"guides-references/hauler-content/charts",title:"Hauler Content - Charts",description:"Hauler Content - Charts Documentation",source:"@site/docs/guides-references/hauler-content/charts.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/charts",permalink:"/hauler-docs/docs/next/guides-references/hauler-content/charts",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/docs/guides-references/hauler-content/charts.md",tags:[],version:"current",frontMatter:{title:"Hauler Content - Charts",description:"Hauler Content - Charts Documentation",sidebar_label:"Charts"},sidebar:"haulerSidebar",previous:{title:"Images",permalink:"/hauler-docs/docs/next/guides-references/hauler-content/images"},next:{title:"Files",permalink:"/hauler-docs/docs/next/guides-references/hauler-content/files"}},o={},l=[{value:"Hauler Command Line for Charts",id:"hauler-command-line-for-charts",level:2},{value:"Example Commands for Charts",id:"example-commands-for-charts",level:2},{value:"Hauler Manifest for Charts",id:"hauler-manifest-for-charts",level:2},{value:"Example Manifest for Charts",id:"example-manifest-for-charts",level:2}];function i(e){const r={code:"code",h2:"h2",pre:"pre",...(0,n.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h2,{id:"hauler-command-line-for-charts",children:"Hauler Command Line for Charts"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-bash",children:"hauler store add chart --repo --version \n"})}),"\n",(0,t.jsx)(r.h2,{id:"example-commands-for-charts",children:"Example Commands for Charts"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-bash",children:"# fetch helm chart\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable\n\n# fetch helm chart with specific version\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.8.2\n"})}),"\n",(0,t.jsx)(r.h2,{id:"hauler-manifest-for-charts",children:"Hauler Manifest for Charts"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",metastring:'title="hauler-chart-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n # fetch helm chart\n - name: \n repoURL: \n version: \n"})}),"\n",(0,t.jsx)(r.h2,{id:"example-manifest-for-charts",children:"Example Manifest for Charts"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",metastring:'title="hauler-chart-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n # fetch helm chart\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n # fetch helm chart with specific version\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.8.2\n"})})]})}function d(e={}){const{wrapper:r}={...(0,n.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(i,{...e})}):i(e)}},8453:(e,r,a)=>{a.d(r,{R:()=>c,x:()=>h});var t=a(6540);const n={},s=t.createContext(n);function c(e){const r=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function h(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:c(e.components),t.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/263082ee.abeb861b.js b/assets/js/263082ee.abeb861b.js new file mode 100644 index 000000000..e417b956f --- /dev/null +++ b/assets/js/263082ee.abeb861b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[6590],{9376:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>o,contentTitle:()=>c,default:()=>d,frontMatter:()=>s,metadata:()=>h,toc:()=>l});var a=t(4848),n=t(8453);const s={title:"Hauler Content - Charts",description:"Hauler Content - Charts Documentation",sidebar_label:"Charts"},c=void 0,h={id:"guides-references/hauler-content/charts",title:"Hauler Content - Charts",description:"Hauler Content - Charts Documentation",source:"@site/docs/guides-references/hauler-content/charts.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/charts",permalink:"/docs/next/guides-references/hauler-content/charts",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/docs/guides-references/hauler-content/charts.md",tags:[],version:"current",frontMatter:{title:"Hauler Content - Charts",description:"Hauler Content - Charts Documentation",sidebar_label:"Charts"},sidebar:"haulerSidebar",previous:{title:"Images",permalink:"/docs/next/guides-references/hauler-content/images"},next:{title:"Files",permalink:"/docs/next/guides-references/hauler-content/files"}},o={},l=[{value:"Hauler Command Line for Charts",id:"hauler-command-line-for-charts",level:2},{value:"Example Commands for Charts",id:"example-commands-for-charts",level:2},{value:"Hauler Manifest for Charts",id:"hauler-manifest-for-charts",level:2},{value:"Example Manifest for Charts",id:"example-manifest-for-charts",level:2}];function i(e){const r={code:"code",h2:"h2",pre:"pre",...(0,n.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(r.h2,{id:"hauler-command-line-for-charts",children:"Hauler Command Line for Charts"}),"\n",(0,a.jsx)(r.pre,{children:(0,a.jsx)(r.code,{className:"language-bash",children:"hauler store add chart --repo --version \n"})}),"\n",(0,a.jsx)(r.h2,{id:"example-commands-for-charts",children:"Example Commands for Charts"}),"\n",(0,a.jsx)(r.pre,{children:(0,a.jsx)(r.code,{className:"language-bash",children:"# fetch helm chart\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable\n\n# fetch helm chart with specific version\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.8.2\n"})}),"\n",(0,a.jsx)(r.h2,{id:"hauler-manifest-for-charts",children:"Hauler Manifest for Charts"}),"\n",(0,a.jsx)(r.pre,{children:(0,a.jsx)(r.code,{className:"language-yaml",metastring:'title="hauler-chart-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n # fetch helm chart\n - name: \n repoURL: \n version: \n"})}),"\n",(0,a.jsx)(r.h2,{id:"example-manifest-for-charts",children:"Example Manifest for Charts"}),"\n",(0,a.jsx)(r.pre,{children:(0,a.jsx)(r.code,{className:"language-yaml",metastring:'title="hauler-chart-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n # fetch helm chart\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n # fetch helm chart with specific version\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.8.2\n"})})]})}function d(e={}){const{wrapper:r}={...(0,n.R)(),...e.components};return r?(0,a.jsx)(r,{...e,children:(0,a.jsx)(i,{...e})}):i(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>c,x:()=>h});var a=t(6540);const n={},s=a.createContext(n);function c(e){const r=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function h(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:c(e.components),a.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/27e9e2e1.4389e014.js b/assets/js/27e9e2e1.4389e014.js new file mode 100644 index 000000000..bd3eb1304 --- /dev/null +++ b/assets/js/27e9e2e1.4389e014.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8191],{8403:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>a});var i=s(4848),t=s(8453);const o={title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},l=void 0,r={id:"known-limits",title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",source:"@site/versioned_docs/version-1.0.0/known-limits.md",sourceDirName:".",slug:"/known-limits",permalink:"/docs/1.0.0/known-limits",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.0/known-limits.md",tags:[],version:"1.0.0",frontMatter:{title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},sidebar:"haulerSidebar",previous:{title:"Hauler Version",permalink:"/docs/1.0.0/guides-references/command-line/hauler-version"},next:{title:"Feedback",permalink:"/docs/1.0.0/feedback"}},c={},a=[{value:"Issues",id:"issues",level:2},{value:"Limitations",id:"limitations",level:2},{value:"Notices",id:"notices",level:2}];function d(e){const n={a:"a",code:"code",h2:"h2",li:"li",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"issues",children:"Issues"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"No Issues at this time."}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"limitations",children:"Limitations"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["When using a ",(0,i.jsx)(n.code,{children:"store"})," for ",(0,i.jsx)(n.code,{children:"hauler"})," that has the same name of a ",(0,i.jsx)(n.code,{children:"helm"})," chart, ",(0,i.jsx)(n.code,{children:"hauler"})," will fail to fetch the chart.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["For example, if you tried to use a ",(0,i.jsx)(n.code,{children:"store"})," name of ",(0,i.jsx)(n.code,{children:"rancher"})," with a ",(0,i.jsx)(n.code,{children:"helm"})," chart name ",(0,i.jsx)(n.code,{children:"rancher"}),", the fetch will fail due to the fact that ",(0,i.jsx)(n.code,{children:"helm"})," defaults to using an exisiting local directory, if it matches the name of the chart."]}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://github.com/helm/helm/blob/e81f6140ddb22bc99a08f7409522a8dbe5338ee3/pkg/action/install.go#L714-L815",children:"https://github.com/helm/helm/blob/e81f6140ddb22bc99a08f7409522a8dbe5338ee3/pkg/action/install.go#L714-L815"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"notices",children:"Notices"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"No Notices at this time."}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>l,x:()=>r});var i=s(6540);const t={},o=i.createContext(t);function l(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/27e9e2e1.53dad88c.js b/assets/js/27e9e2e1.53dad88c.js deleted file mode 100644 index 0c9eeba61..000000000 --- a/assets/js/27e9e2e1.53dad88c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8191],{8403:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>a});var i=s(4848),t=s(8453);const o={title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},l=void 0,r={id:"known-limits",title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",source:"@site/versioned_docs/version-1.0.0/known-limits.md",sourceDirName:".",slug:"/known-limits",permalink:"/hauler-docs/docs/1.0.0/known-limits",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.0/known-limits.md",tags:[],version:"1.0.0",frontMatter:{title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},sidebar:"haulerSidebar",previous:{title:"Hauler Version",permalink:"/hauler-docs/docs/1.0.0/guides-references/command-line/hauler-version"},next:{title:"Feedback",permalink:"/hauler-docs/docs/1.0.0/feedback"}},c={},a=[{value:"Issues",id:"issues",level:2},{value:"Limitations",id:"limitations",level:2},{value:"Notices",id:"notices",level:2}];function d(e){const n={a:"a",code:"code",h2:"h2",li:"li",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"issues",children:"Issues"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"No Issues at this time."}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"limitations",children:"Limitations"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["When using a ",(0,i.jsx)(n.code,{children:"store"})," for ",(0,i.jsx)(n.code,{children:"hauler"})," that has the same name of a ",(0,i.jsx)(n.code,{children:"helm"})," chart, ",(0,i.jsx)(n.code,{children:"hauler"})," will fail to fetch the chart.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["For example, if you tried to use a ",(0,i.jsx)(n.code,{children:"store"})," name of ",(0,i.jsx)(n.code,{children:"rancher"})," with a ",(0,i.jsx)(n.code,{children:"helm"})," chart name ",(0,i.jsx)(n.code,{children:"rancher"}),", the fetch will fail due to the fact that ",(0,i.jsx)(n.code,{children:"helm"})," defaults to using an exisiting local directory, if it matches the name of the chart."]}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://github.com/helm/helm/blob/e81f6140ddb22bc99a08f7409522a8dbe5338ee3/pkg/action/install.go#L714-L815",children:"https://github.com/helm/helm/blob/e81f6140ddb22bc99a08f7409522a8dbe5338ee3/pkg/action/install.go#L714-L815"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"notices",children:"Notices"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"No Notices at this time."}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>l,x:()=>r});var i=s(6540);const t={},o=i.createContext(t);function l(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/28e0ee0f.55aff659.js b/assets/js/28e0ee0f.55aff659.js new file mode 100644 index 000000000..9132a7dee --- /dev/null +++ b/assets/js/28e0ee0f.55aff659.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8614],{4512:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>l,toc:()=>a});var r=n(4848),s=n(8453);const o={title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',sidebar_label:"Files"},i=void 0,l={id:"guides-references/hauler-content/files",title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',source:"@site/versioned_docs/version-0.4.1/guides-references/hauler-content/files.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/files",permalink:"/docs/0.4.1/guides-references/hauler-content/files",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.1/guides-references/hauler-content/files.md",tags:[],version:"0.4.1",frontMatter:{title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',sidebar_label:"Files"},sidebar:"haulerSidebar",previous:{title:"Charts",permalink:"/docs/0.4.1/guides-references/hauler-content/charts"},next:{title:"Hauler",permalink:"/docs/0.4.1/guides-references/command-line/hauler"}},c={},a=[];function u(e){const t={code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.p,{children:"Generic content that can be represented as a file, either sourced locally or remotely:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-yaml",children:"# local file\nhauler store add file path/to/local/file.txt\n\n# remote file with name\nhauler store add file https://get.rke2.io --name install.sh\n"})})]})}function d(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>l});var r=n(6540);const s={},o=r.createContext(s);function i(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/28e0ee0f.a81435bf.js b/assets/js/28e0ee0f.a81435bf.js deleted file mode 100644 index 41060ef50..000000000 --- a/assets/js/28e0ee0f.a81435bf.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8614],{4512:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>l,toc:()=>a});var r=n(4848),s=n(8453);const o={title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',sidebar_label:"Files"},i=void 0,l={id:"guides-references/hauler-content/files",title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',source:"@site/versioned_docs/version-0.4.1/guides-references/hauler-content/files.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/files",permalink:"/hauler-docs/docs/0.4.1/guides-references/hauler-content/files",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.1/guides-references/hauler-content/files.md",tags:[],version:"0.4.1",frontMatter:{title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',sidebar_label:"Files"},sidebar:"haulerSidebar",previous:{title:"Charts",permalink:"/hauler-docs/docs/0.4.1/guides-references/hauler-content/charts"},next:{title:"Hauler",permalink:"/hauler-docs/docs/0.4.1/guides-references/command-line/hauler"}},c={},a=[];function u(e){const t={code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.p,{children:"Generic content that can be represented as a file, either sourced locally or remotely:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-yaml",children:"# local file\nhauler store add file path/to/local/file.txt\n\n# remote file with name\nhauler store add file https://get.rke2.io --name install.sh\n"})})]})}function d(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>l});var r=n(6540);const s={},o=r.createContext(s);function i(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2deb419f.5f05dfe0.js b/assets/js/2deb419f.5f05dfe0.js new file mode 100644 index 000000000..c7bbeca1e --- /dev/null +++ b/assets/js/2deb419f.5f05dfe0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9164],{4966:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"0.4.3","label":"0.4.3","banner":"unmaintained","badge":true,"noIndex":false,"className":"docs-version-0.4.3","isLast":false,"docsSidebars":{"haulerSidebar":[{"type":"link","label":"Introduction","href":"/docs/0.4.3/intro","docId":"intro","unlisted":false},{"type":"link","label":"Core Concepts","href":"/docs/0.4.3/core-concepts","docId":"core-concepts","unlisted":false},{"type":"link","label":"Airgap Workflow","href":"/docs/0.4.3/airgap-workflow","docId":"airgap-workflow","unlisted":false},{"type":"category","label":"Introduction","description":"Introduction Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Quickstart","href":"/docs/0.4.3/introduction/quickstart","docId":"introduction/quickstart","unlisted":false},{"type":"link","label":"Installation","href":"/docs/0.4.3/introduction/install","docId":"introduction/install","unlisted":false},{"type":"link","label":"Uninstall","href":"/docs/0.4.3/introduction/uninstall","docId":"introduction/uninstall","unlisted":false}],"collapsible":true},{"type":"category","label":"Guides & References","description":"Guides and References Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Overview","href":"/docs/0.4.3/guides-references/overview","docId":"guides-references/overview","unlisted":false},{"type":"link","label":"Fetch Cluster Images","href":"/docs/0.4.3/guides-references/cluster-images","docId":"guides-references/cluster-images","unlisted":false},{"type":"link","label":"RGS Carbide Customers","href":"/docs/0.4.3/guides-references/carbide-customers","docId":"guides-references/carbide-customers","unlisted":false},{"type":"category","label":"Hauler Collections","description":"Guides and References for Hauler Collections","items":[{"type":"link","label":"Overview","href":"/docs/0.4.3/guides-references/hauler-collections/overview","docId":"guides-references/hauler-collections/overview","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Hauler Content","description":"Guides and References for Hauler Content Types","items":[{"type":"link","label":"Overview","href":"/docs/0.4.3/guides-references/hauler-content/overview","docId":"guides-references/hauler-content/overview","unlisted":false},{"type":"link","label":"Images","href":"/docs/0.4.3/guides-references/hauler-content/images","docId":"guides-references/hauler-content/images","unlisted":false},{"type":"link","label":"Charts","href":"/docs/0.4.3/guides-references/hauler-content/charts","docId":"guides-references/hauler-content/charts","unlisted":false},{"type":"link","label":"Files","href":"/docs/0.4.3/guides-references/hauler-content/files","docId":"guides-references/hauler-content/files","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Command Line Interface","description":"Guides and References for the Hauler Command Line","items":[{"type":"link","label":"Hauler","href":"/docs/0.4.3/guides-references/command-line/hauler","docId":"guides-references/command-line/hauler","unlisted":false},{"type":"link","label":"Hauler Store","href":"/docs/0.4.3/guides-references/command-line/hauler-store","docId":"guides-references/command-line/hauler-store","unlisted":false},{"type":"link","label":"Hauler Completion","href":"/docs/0.4.3/guides-references/command-line/hauler-completion","docId":"guides-references/command-line/hauler-completion","unlisted":false},{"type":"link","label":"Hauler Version","href":"/docs/0.4.3/guides-references/command-line/hauler-version","docId":"guides-references/command-line/hauler-version","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true},{"type":"link","label":"Known Issues/Limits","href":"/docs/0.4.3/known-limits","docId":"known-limits","unlisted":false}]},"docs":{"airgap-workflow":{"id":"airgap-workflow","title":"Airgap Workflow","description":"Airgap Workflow Documentation for Hauler","sidebar":"haulerSidebar"},"core-concepts":{"id":"core-concepts","title":"Core Concepts","description":"Core Concepts Documentation for Hauler","sidebar":"haulerSidebar"},"guides-references/carbide-customers":{"id":"guides-references/carbide-customers","title":"RGS Carbide Customers","description":"RGS Carbide Customers Documentation","sidebar":"haulerSidebar"},"guides-references/cluster-images":{"id":"guides-references/cluster-images","title":"Fetching Cluster Images","description":"Fetching Images on a Cluster Documentation","sidebar":"haulerSidebar"},"guides-references/command-line/hauler":{"id":"guides-references/command-line/hauler","title":"Hauler (Command)","description":"Hauler CLI Reference for hauler","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-completion":{"id":"guides-references/command-line/hauler-completion","title":"Hauler Completion (Command)","description":"Hauler CLI Reference for hauler completion","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-store":{"id":"guides-references/command-line/hauler-store","title":"Hauler Store (Command)","description":"Hauler CLI Reference for hauler store","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-version":{"id":"guides-references/command-line/hauler-version","title":"Hauler Version (Command)","description":"Hauler CLI Reference for hauler version","sidebar":"haulerSidebar"},"guides-references/hauler-collections/overview":{"id":"guides-references/hauler-collections/overview","title":"Overview of Hauler Collections","description":"Hauler Collections Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/charts":{"id":"guides-references/hauler-content/charts","title":"Charts (Content Type)","description":"Hauler \\"Charts\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/files":{"id":"guides-references/hauler-content/files","title":"Files (Content Type)","description":"Hauler \\"Files\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/images":{"id":"guides-references/hauler-content/images","title":"Images (Content Type)","description":"Hauler \\"Images\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/overview":{"id":"guides-references/hauler-content/overview","title":"Overview of Hauler Content","description":"Hauler Content Documentation","sidebar":"haulerSidebar"},"guides-references/overview":{"id":"guides-references/overview","title":"Overview","description":"Reference Guides Overview Documentation for Hauler","sidebar":"haulerSidebar"},"intro":{"id":"intro","title":"Introduction","description":"Introduction to Rancher Government Hauler","sidebar":"haulerSidebar"},"introduction/install":{"id":"introduction/install","title":"Installation","description":"Installation Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/quickstart":{"id":"introduction/quickstart","title":"Quickstart","description":"Quickstart Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/uninstall":{"id":"introduction/uninstall","title":"Uninstall","description":"Uninstall Documentation for Hauler","sidebar":"haulerSidebar"},"known-limits":{"id":"known-limits","title":"Known Issues and Limits","description":"Known Issues and Limitations for Hauler","sidebar":"haulerSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/3062a55a.f3809c91.js b/assets/js/3062a55a.f3809c91.js deleted file mode 100644 index b9192824d..000000000 --- a/assets/js/3062a55a.f3809c91.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1550],{1068:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"1.0.0","label":"1.0.0","banner":"unmaintained","badge":true,"noIndex":false,"className":"docs-version-1.0.0","isLast":false,"docsSidebars":{"haulerSidebar":[{"type":"link","label":"Introduction","href":"/hauler-docs/docs/1.0.0/intro","docId":"intro","unlisted":false},{"type":"link","label":"Core Concepts","href":"/hauler-docs/docs/1.0.0/core-concepts","docId":"core-concepts","unlisted":false},{"type":"link","label":"Airgap Workflow","href":"/hauler-docs/docs/1.0.0/airgap-workflow","docId":"airgap-workflow","unlisted":false},{"type":"category","label":"Introduction","description":"Introduction Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Quickstart","href":"/hauler-docs/docs/1.0.0/introduction/quickstart","docId":"introduction/quickstart","unlisted":false},{"type":"link","label":"Installation","href":"/hauler-docs/docs/1.0.0/introduction/install","docId":"introduction/install","unlisted":false},{"type":"link","label":"Uninstall","href":"/hauler-docs/docs/1.0.0/introduction/uninstall","docId":"introduction/uninstall","unlisted":false}],"collapsible":true},{"type":"category","label":"Guides & References","description":"Guides and References Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Overview","href":"/hauler-docs/docs/1.0.0/guides-references/overview","docId":"guides-references/overview","unlisted":false},{"type":"link","label":"Hauler Manifests","href":"/hauler-docs/docs/1.0.0/guides-references/manifests","docId":"guides-references/manifests","unlisted":false},{"type":"link","label":"Fetch Cluster Images","href":"/hauler-docs/docs/1.0.0/guides-references/cluster-images","docId":"guides-references/cluster-images","unlisted":false},{"type":"link","label":"RGS Carbide Customers","href":"/hauler-docs/docs/1.0.0/guides-references/carbide-customers","docId":"guides-references/carbide-customers","unlisted":false},{"type":"category","label":"Hauler Collections","description":"Guides and References for Hauler Collections","items":[{"type":"link","label":"Community Collections","href":"/hauler-docs/docs/1.0.0/guides-references/hauler-collections/community-collections","docId":"guides-references/hauler-collections/community-collections","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Hauler Content","description":"Guides and References for Hauler Content Types","items":[{"type":"link","label":"Images","href":"/hauler-docs/docs/1.0.0/guides-references/hauler-content/images","docId":"guides-references/hauler-content/images","unlisted":false},{"type":"link","label":"Charts","href":"/hauler-docs/docs/1.0.0/guides-references/hauler-content/charts","docId":"guides-references/hauler-content/charts","unlisted":false},{"type":"link","label":"Files","href":"/hauler-docs/docs/1.0.0/guides-references/hauler-content/files","docId":"guides-references/hauler-content/files","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Command Line Interface","description":"Guides and References for the Hauler Command Line","items":[{"type":"link","label":"Hauler","href":"/hauler-docs/docs/1.0.0/guides-references/command-line/hauler","docId":"guides-references/command-line/hauler","unlisted":false},{"type":"link","label":"Hauler Store","href":"/hauler-docs/docs/1.0.0/guides-references/command-line/hauler-store","docId":"guides-references/command-line/hauler-store","unlisted":false},{"type":"link","label":"Hauler Completion","href":"/hauler-docs/docs/1.0.0/guides-references/command-line/hauler-completion","docId":"guides-references/command-line/hauler-completion","unlisted":false},{"type":"link","label":"Hauler Version","href":"/hauler-docs/docs/1.0.0/guides-references/command-line/hauler-version","docId":"guides-references/command-line/hauler-version","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true},{"type":"link","label":"Known Issues/Limits","href":"/hauler-docs/docs/1.0.0/known-limits","docId":"known-limits","unlisted":false},{"type":"link","label":"Feedback","href":"/hauler-docs/docs/1.0.0/feedback","docId":"feedback","unlisted":false}]},"docs":{"airgap-workflow":{"id":"airgap-workflow","title":"Airgap Workflow","description":"Airgap Workflow Documentation for Hauler","sidebar":"haulerSidebar"},"core-concepts":{"id":"core-concepts","title":"Core Concepts","description":"Core Concepts Documentation for Hauler","sidebar":"haulerSidebar"},"feedback":{"id":"feedback","title":"Feedback","description":"Feedback for Hauler","sidebar":"haulerSidebar"},"guides-references/carbide-customers":{"id":"guides-references/carbide-customers","title":"RGS Carbide Customers","description":"RGS Carbide Customers Documentation","sidebar":"haulerSidebar"},"guides-references/cluster-images":{"id":"guides-references/cluster-images","title":"Fetching Cluster Images","description":"Fetching Images on a Cluster Documentation","sidebar":"haulerSidebar"},"guides-references/command-line/hauler":{"id":"guides-references/command-line/hauler","title":"Hauler (Command)","description":"Hauler CLI Reference for hauler","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-completion":{"id":"guides-references/command-line/hauler-completion","title":"Hauler Completion (Command)","description":"Hauler CLI Reference for hauler completion","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-store":{"id":"guides-references/command-line/hauler-store","title":"Hauler Store (Command)","description":"Hauler CLI Reference for hauler store","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-version":{"id":"guides-references/command-line/hauler-version","title":"Hauler Version (Command)","description":"Hauler CLI Reference for hauler version","sidebar":"haulerSidebar"},"guides-references/hauler-collections/community-collections":{"id":"guides-references/hauler-collections/community-collections","title":"Hauler Community Collections","description":"Hauler Community Collections Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/charts":{"id":"guides-references/hauler-content/charts","title":"Hauler Content - Charts","description":"Hauler Content - Charts Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/files":{"id":"guides-references/hauler-content/files","title":"Hauler Content - Files","description":"Hauler Content - Files Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/images":{"id":"guides-references/hauler-content/images","title":"Hauler Content - Images","description":"Hauler Content - Images Documentation","sidebar":"haulerSidebar"},"guides-references/manifests":{"id":"guides-references/manifests","title":"Hauler Manifests","description":"Hauler Manifests Documentation","sidebar":"haulerSidebar"},"guides-references/overview":{"id":"guides-references/overview","title":"Overview","description":"Reference Guides Overview Documentation for Hauler","sidebar":"haulerSidebar"},"intro":{"id":"intro","title":"Introduction","description":"Introduction to Rancher Government Hauler","sidebar":"haulerSidebar"},"introduction/install":{"id":"introduction/install","title":"Installation","description":"Installation Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/quickstart":{"id":"introduction/quickstart","title":"Quickstart","description":"Quickstart Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/uninstall":{"id":"introduction/uninstall","title":"Uninstall","description":"Uninstall Documentation for Hauler","sidebar":"haulerSidebar"},"known-limits":{"id":"known-limits","title":"Known Issues and Limits","description":"Known Issues and Limitations for Hauler","sidebar":"haulerSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/34fcde0b.08ae7ef2.js b/assets/js/34fcde0b.08ae7ef2.js deleted file mode 100644 index fe02619f8..000000000 --- a/assets/js/34fcde0b.08ae7ef2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2732],{710:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>l,default:()=>d,frontMatter:()=>s,metadata:()=>o,toc:()=>h});var a=r(4848),n=r(8453);const s={title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},l=void 0,o={id:"introduction/quickstart",title:"Quickstart",description:"Quickstart Documentation for Hauler",source:"@site/versioned_docs/version-0.4.4/introduction/quickstart.md",sourceDirName:"introduction",slug:"/introduction/quickstart",permalink:"/hauler-docs/docs/0.4.4/introduction/quickstart",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.4/introduction/quickstart.md",tags:[],version:"0.4.4",frontMatter:{title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},sidebar:"haulerSidebar",previous:{title:"Airgap Workflow",permalink:"/hauler-docs/docs/0.4.4/airgap-workflow"},next:{title:"Installation",permalink:"/hauler-docs/docs/0.4.4/introduction/install"}},i={},h=[{value:"Quick Installation",id:"quick-installation",level:2},{value:"Example Use of Hauler",id:"example-use-of-hauler",level:2},{value:"Add Content to the Hauler Store",id:"add-content-to-the-hauler-store",level:3},{value:"Using the Command Line:",id:"using-the-command-line",level:4},{value:"Using a Hauler Manifest:",id:"using-a-hauler-manifest",level:4},{value:"View the Hauler Store",id:"view-the-hauler-store",level:3},{value:"Save the Hauler Store",id:"save-the-hauler-store",level:3},{value:"Load the Airgapped Hauler Store",id:"load-the-airgapped-hauler-store",level:3},{value:"Serve the Hauler Store",id:"serve-the-hauler-store",level:3},{value:"Copy the Hauler Store to a Registry",id:"copy-the-hauler-store-to-a-registry",level:3},{value:"Copy the Hauler Store to a Directory",id:"copy-the-hauler-store-to-a-directory",level:3}];function c(e){const t={code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,n.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.p,{children:"Skipping past most of the documentation? Here's an easy to follow Quick Start Guide:"}),"\n",(0,a.jsx)(t.h2,{id:"quick-installation",children:"Quick Installation"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n"})}),"\n",(0,a.jsx)(t.h2,{id:"example-use-of-hauler",children:"Example Use of Hauler"}),"\n",(0,a.jsx)(t.h3,{id:"add-content-to-the-hauler-store",children:"Add Content to the Hauler Store"}),"\n",(0,a.jsx)(t.h4,{id:"using-the-command-line",children:"Using the Command Line:"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# add a image: neuvector/scanner:latest\nhauler store add image neuvector/scanner:latest --platform linux/amd64\n\n# add a image with supply chain artifacts\nhauler store add image rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.2 --key carbide-key.pub --platform linux/amd64\n\n# add a chart: rancher-stable/rancher (v2.8.2)\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.8.2\n\n# add a file: rke2-install.sh\nhauler store add file https://get.rke2.io --name install.sh\n"})}),"\n",(0,a.jsx)(t.h4,{id:"using-a-hauler-manifest",children:"Using a Hauler Manifest:"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"hauler store sync --files hauler-manfiest.yaml\n"})}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\nspec:\n images:\n - name: neuvector/scanner:latest\n - name: rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.1\n key: carbide-key.pub\n platform: linux/amd64\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.8.2\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n - path: https://get.rke2.io\n name: install.sh\n"})}),"\n",(0,a.jsx)(t.h3,{id:"view-the-hauler-store",children:"View the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# view and verify the content in the local hauler store\nhauler store info\n"})}),"\n",(0,a.jsx)(t.h3,{id:"save-the-hauler-store",children:"Save the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# save and export the content in the local hauler store\nhauler store save --filename haul.tar.zst\n"})}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsxs)(t.strong,{children:["airgap the ",(0,a.jsx)(t.code,{children:"haul.tar.zst"})," to the disconnected environment"]})}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.h3,{id:"load-the-airgapped-hauler-store",children:"Load the Airgapped Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# load and import the airgapped content to the new local hauler store\nhauler store load haul.tar.zst\n"})}),"\n",(0,a.jsx)(t.h3,{id:"serve-the-hauler-store",children:"Serve the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# serve the content as a registry from the hauler store\nhauler store serve registry\n\n# serve the file content as a fileserver from the hauler store\nhauler store serve fileserver\n"})}),"\n",(0,a.jsx)(t.h3,{id:"copy-the-hauler-store-to-a-registry",children:"Copy the Hauler Store to a Registry"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# copy the content to a registry from the hauler store\nhauler store copy registry://harbor.example.com\n"})}),"\n",(0,a.jsx)(t.h3,{id:"copy-the-hauler-store-to-a-directory",children:"Copy the Hauler Store to a Directory"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# copy the content to a directory from the hauler store\nhauler store copy dir://hauler-files\n"})})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(c,{...e})}):c(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>l,x:()=>o});var a=r(6540);const n={},s=a.createContext(n);function l(e){const t=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:l(e.components),a.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/34fcde0b.46184051.js b/assets/js/34fcde0b.46184051.js new file mode 100644 index 000000000..0277b105f --- /dev/null +++ b/assets/js/34fcde0b.46184051.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2732],{710:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>l,default:()=>d,frontMatter:()=>s,metadata:()=>o,toc:()=>h});var a=r(4848),n=r(8453);const s={title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},l=void 0,o={id:"introduction/quickstart",title:"Quickstart",description:"Quickstart Documentation for Hauler",source:"@site/versioned_docs/version-0.4.4/introduction/quickstart.md",sourceDirName:"introduction",slug:"/introduction/quickstart",permalink:"/docs/0.4.4/introduction/quickstart",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.4/introduction/quickstart.md",tags:[],version:"0.4.4",frontMatter:{title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},sidebar:"haulerSidebar",previous:{title:"Airgap Workflow",permalink:"/docs/0.4.4/airgap-workflow"},next:{title:"Installation",permalink:"/docs/0.4.4/introduction/install"}},i={},h=[{value:"Quick Installation",id:"quick-installation",level:2},{value:"Example Use of Hauler",id:"example-use-of-hauler",level:2},{value:"Add Content to the Hauler Store",id:"add-content-to-the-hauler-store",level:3},{value:"Using the Command Line:",id:"using-the-command-line",level:4},{value:"Using a Hauler Manifest:",id:"using-a-hauler-manifest",level:4},{value:"View the Hauler Store",id:"view-the-hauler-store",level:3},{value:"Save the Hauler Store",id:"save-the-hauler-store",level:3},{value:"Load the Airgapped Hauler Store",id:"load-the-airgapped-hauler-store",level:3},{value:"Serve the Hauler Store",id:"serve-the-hauler-store",level:3},{value:"Copy the Hauler Store to a Registry",id:"copy-the-hauler-store-to-a-registry",level:3},{value:"Copy the Hauler Store to a Directory",id:"copy-the-hauler-store-to-a-directory",level:3}];function c(e){const t={code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,n.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.p,{children:"Skipping past most of the documentation? Here's an easy to follow Quick Start Guide:"}),"\n",(0,a.jsx)(t.h2,{id:"quick-installation",children:"Quick Installation"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n"})}),"\n",(0,a.jsx)(t.h2,{id:"example-use-of-hauler",children:"Example Use of Hauler"}),"\n",(0,a.jsx)(t.h3,{id:"add-content-to-the-hauler-store",children:"Add Content to the Hauler Store"}),"\n",(0,a.jsx)(t.h4,{id:"using-the-command-line",children:"Using the Command Line:"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# add a image: neuvector/scanner:latest\nhauler store add image neuvector/scanner:latest --platform linux/amd64\n\n# add a image with supply chain artifacts\nhauler store add image rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.2 --key carbide-key.pub --platform linux/amd64\n\n# add a chart: rancher-stable/rancher (v2.8.2)\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.8.2\n\n# add a file: rke2-install.sh\nhauler store add file https://get.rke2.io --name install.sh\n"})}),"\n",(0,a.jsx)(t.h4,{id:"using-a-hauler-manifest",children:"Using a Hauler Manifest:"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"hauler store sync --files hauler-manfiest.yaml\n"})}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\nspec:\n images:\n - name: neuvector/scanner:latest\n - name: rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.1\n key: carbide-key.pub\n platform: linux/amd64\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.8.2\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n - path: https://get.rke2.io\n name: install.sh\n"})}),"\n",(0,a.jsx)(t.h3,{id:"view-the-hauler-store",children:"View the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# view and verify the content in the local hauler store\nhauler store info\n"})}),"\n",(0,a.jsx)(t.h3,{id:"save-the-hauler-store",children:"Save the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# save and export the content in the local hauler store\nhauler store save --filename haul.tar.zst\n"})}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsxs)(t.strong,{children:["airgap the ",(0,a.jsx)(t.code,{children:"haul.tar.zst"})," to the disconnected environment"]})}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.h3,{id:"load-the-airgapped-hauler-store",children:"Load the Airgapped Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# load and import the airgapped content to the new local hauler store\nhauler store load haul.tar.zst\n"})}),"\n",(0,a.jsx)(t.h3,{id:"serve-the-hauler-store",children:"Serve the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# serve the content as a registry from the hauler store\nhauler store serve registry\n\n# serve the file content as a fileserver from the hauler store\nhauler store serve fileserver\n"})}),"\n",(0,a.jsx)(t.h3,{id:"copy-the-hauler-store-to-a-registry",children:"Copy the Hauler Store to a Registry"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# copy the content to a registry from the hauler store\nhauler store copy registry://harbor.example.com\n"})}),"\n",(0,a.jsx)(t.h3,{id:"copy-the-hauler-store-to-a-directory",children:"Copy the Hauler Store to a Directory"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# copy the content to a directory from the hauler store\nhauler store copy dir://hauler-files\n"})})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(c,{...e})}):c(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>l,x:()=>o});var a=r(6540);const n={},s=a.createContext(n);function l(e){const t=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:l(e.components),a.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/37803b2d.a997c7a2.js b/assets/js/37803b2d.a997c7a2.js deleted file mode 100644 index 4eb36b7d2..000000000 --- a/assets/js/37803b2d.a997c7a2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7060],{4129:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>i,contentTitle:()=>l,default:()=>u,frontMatter:()=>a,metadata:()=>s,toc:()=>c});var o=r(4848),t=r(8453);const a={title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},l=void 0,s={id:"guides-references/command-line/hauler",title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",source:"@site/docs/guides-references/command-line/hauler.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler",permalink:"/hauler-docs/docs/next/guides-references/command-line/hauler",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/docs/guides-references/command-line/hauler.md",tags:[],version:"current",frontMatter:{title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},sidebar:"haulerSidebar",previous:{title:"Files",permalink:"/hauler-docs/docs/next/guides-references/hauler-content/files"},next:{title:"Hauler Store",permalink:"/hauler-docs/docs/next/guides-references/command-line/hauler-store"}},i={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Interact with Hauler's command line."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler [flags]\n hauler [command]\n\nAvailable Commands:\n completion Generates completion scripts for various shells\n help Help about any command\n login Log in to a registry\n store Interact with hauler\'s embedded content store\n version Print the current version\n\nFlags:\n -h, --help help for hauler\n -l, --log-level string (default "info")\n\nUse "hauler [command] --help" for more information about a command.\n'})})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>s});var o=r(6540);const t={},a=o.createContext(t);function l(e){const n=o.useContext(a);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),o.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/37803b2d.ad9838ef.js b/assets/js/37803b2d.ad9838ef.js new file mode 100644 index 000000000..e452684e1 --- /dev/null +++ b/assets/js/37803b2d.ad9838ef.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7060],{4129:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>i,contentTitle:()=>l,default:()=>u,frontMatter:()=>a,metadata:()=>s,toc:()=>c});var t=r(4848),o=r(8453);const a={title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},l=void 0,s={id:"guides-references/command-line/hauler",title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",source:"@site/docs/guides-references/command-line/hauler.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler",permalink:"/docs/next/guides-references/command-line/hauler",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/docs/guides-references/command-line/hauler.md",tags:[],version:"current",frontMatter:{title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},sidebar:"haulerSidebar",previous:{title:"Files",permalink:"/docs/next/guides-references/hauler-content/files"},next:{title:"Hauler Store",permalink:"/docs/next/guides-references/command-line/hauler-store"}},i={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Interact with Hauler's command line."}),"\n"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler [flags]\n hauler [command]\n\nAvailable Commands:\n completion Generates completion scripts for various shells\n help Help about any command\n login Log in to a registry\n store Interact with hauler\'s embedded content store\n version Print the current version\n\nFlags:\n -h, --help help for hauler\n -l, --log-level string (default "info")\n\nUse "hauler [command] --help" for more information about a command.\n'})})]})}function u(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>s});var t=r(6540);const o={},a=t.createContext(o);function l(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:l(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/37e3f54f.33f40b93.js b/assets/js/37e3f54f.33f40b93.js new file mode 100644 index 000000000..d31633c2a --- /dev/null +++ b/assets/js/37e3f54f.33f40b93.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8852],{498:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>i,contentTitle:()=>l,default:()=>u,frontMatter:()=>a,metadata:()=>s,toc:()=>c});var o=r(4848),t=r(8453);const a={title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},l=void 0,s={id:"guides-references/command-line/hauler",title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",source:"@site/versioned_docs/version-1.0.0/guides-references/command-line/hauler.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler",permalink:"/docs/1.0.0/guides-references/command-line/hauler",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.0/guides-references/command-line/hauler.md",tags:[],version:"1.0.0",frontMatter:{title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},sidebar:"haulerSidebar",previous:{title:"Files",permalink:"/docs/1.0.0/guides-references/hauler-content/files"},next:{title:"Hauler Store",permalink:"/docs/1.0.0/guides-references/command-line/hauler-store"}},i={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Interact with Hauler's command line."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler [flags]\n hauler [command]\n\nAvailable Commands:\n completion Generates completion scripts for various shells\n help Help about any command\n login Log in to a registry\n store Interact with hauler\'s embedded content store\n version Print the current version\n\nFlags:\n -h, --help help for hauler\n -l, --log-level string (default "info")\n\nUse "hauler [command] --help" for more information about a command.\n'})})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>s});var o=r(6540);const t={},a=o.createContext(t);function l(e){const n=o.useContext(a);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),o.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/37e3f54f.e953a92c.js b/assets/js/37e3f54f.e953a92c.js deleted file mode 100644 index a69e53692..000000000 --- a/assets/js/37e3f54f.e953a92c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8852],{498:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>i,contentTitle:()=>t,default:()=>u,frontMatter:()=>l,metadata:()=>s,toc:()=>c});var o=r(4848),a=r(8453);const l={title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},t=void 0,s={id:"guides-references/command-line/hauler",title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",source:"@site/versioned_docs/version-1.0.0/guides-references/command-line/hauler.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler",permalink:"/hauler-docs/docs/1.0.0/guides-references/command-line/hauler",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.0/guides-references/command-line/hauler.md",tags:[],version:"1.0.0",frontMatter:{title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},sidebar:"haulerSidebar",previous:{title:"Files",permalink:"/hauler-docs/docs/1.0.0/guides-references/hauler-content/files"},next:{title:"Hauler Store",permalink:"/hauler-docs/docs/1.0.0/guides-references/command-line/hauler-store"}},i={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Interact with Hauler's command line."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler [flags]\n hauler [command]\n\nAvailable Commands:\n completion Generates completion scripts for various shells\n help Help about any command\n login Log in to a registry\n store Interact with hauler\'s embedded content store\n version Print the current version\n\nFlags:\n -h, --help help for hauler\n -l, --log-level string (default "info")\n\nUse "hauler [command] --help" for more information about a command.\n'})})]})}function u(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>t,x:()=>s});var o=r(6540);const a={},l=o.createContext(a);function t(e){const n=o.useContext(l);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:t(e.components),o.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/380c291a.bf7d5bf7.js b/assets/js/380c291a.bf7d5bf7.js deleted file mode 100644 index cd89cc6e6..000000000 --- a/assets/js/380c291a.bf7d5bf7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3492],{1335:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var n=r(4848),i=r(8453);const s={title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},l=void 0,c={id:"guides-references/overview",title:"Overview",description:"Reference Guides Overview Documentation for Hauler",source:"@site/versioned_docs/version-0.4.3/guides-references/overview.md",sourceDirName:"guides-references",slug:"/guides-references/overview",permalink:"/hauler-docs/docs/0.4.3/guides-references/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.3/guides-references/overview.md",tags:[],version:"0.4.3",frontMatter:{title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Uninstall",permalink:"/hauler-docs/docs/0.4.3/introduction/uninstall"},next:{title:"Fetch Cluster Images",permalink:"/hauler-docs/docs/0.4.3/guides-references/cluster-images"}},o={},d=[{value:"Hauler Guides & Reference Documentation",id:"hauler-guides--reference-documentation",level:2}];function a(e){const t={a:"a",h2:"h2",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Additional Overview Documentation pending a future release!"}),"\n",(0,n.jsx)(t.h2,{id:"hauler-guides--reference-documentation",children:"Hauler Guides & Reference Documentation"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Guide or Reference Documentation"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"cluster-images",children:"Cluster Images"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Create a Hauler Store from Images on a Cluster"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-collections/overview",children:"Hauler Collections"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of Hauler Collections"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-content/overview",children:"Hauler Content"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of Hauler Content"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"command-line/hauler",children:"Hauler Command Line"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of the Hauler Command Line Interface"})]})]})]})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>l,x:()=>c});var n=r(6540);const i={},s=n.createContext(i);function l(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/380c291a.f736c0dc.js b/assets/js/380c291a.f736c0dc.js new file mode 100644 index 000000000..c9fdc8bf4 --- /dev/null +++ b/assets/js/380c291a.f736c0dc.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3492],{1335:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var n=r(4848),i=r(8453);const s={title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},l=void 0,c={id:"guides-references/overview",title:"Overview",description:"Reference Guides Overview Documentation for Hauler",source:"@site/versioned_docs/version-0.4.3/guides-references/overview.md",sourceDirName:"guides-references",slug:"/guides-references/overview",permalink:"/docs/0.4.3/guides-references/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.3/guides-references/overview.md",tags:[],version:"0.4.3",frontMatter:{title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Uninstall",permalink:"/docs/0.4.3/introduction/uninstall"},next:{title:"Fetch Cluster Images",permalink:"/docs/0.4.3/guides-references/cluster-images"}},o={},d=[{value:"Hauler Guides & Reference Documentation",id:"hauler-guides--reference-documentation",level:2}];function a(e){const t={a:"a",h2:"h2",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Additional Overview Documentation pending a future release!"}),"\n",(0,n.jsx)(t.h2,{id:"hauler-guides--reference-documentation",children:"Hauler Guides & Reference Documentation"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Guide or Reference Documentation"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"cluster-images",children:"Cluster Images"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Create a Hauler Store from Images on a Cluster"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-collections/overview",children:"Hauler Collections"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of Hauler Collections"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-content/overview",children:"Hauler Content"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of Hauler Content"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"command-line/hauler",children:"Hauler Command Line"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of the Hauler Command Line Interface"})]})]})]})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>l,x:()=>c});var n=r(6540);const i={},s=n.createContext(i);function l(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/393be207.25849df8.js b/assets/js/393be207.25849df8.js new file mode 100644 index 000000000..f8b2d86c3 --- /dev/null +++ b/assets/js/393be207.25849df8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4134],{6602:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>i,frontMatter:()=>r,metadata:()=>p,toc:()=>d});var o=t(4848),a=t(8453);const r={title:"Markdown page example"},s="Markdown page example",p={type:"mdx",permalink:"/markdown-page",source:"@site/src/pages/markdown-page.md",title:"Markdown page example",description:"You don't need React to write simple standalone pages.",frontMatter:{title:"Markdown page example"},unlisted:!1},c={},d=[];function l(e){const n={h1:"h1",p:"p",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"markdown-page-example",children:"Markdown page example"}),"\n",(0,o.jsx)(n.p,{children:"You don't need React to write simple standalone pages."})]})}function i(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>p});var o=t(6540);const a={},r=o.createContext(a);function s(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function p(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/393be207.d3940a94.js b/assets/js/393be207.d3940a94.js deleted file mode 100644 index a50a40bee..000000000 --- a/assets/js/393be207.d3940a94.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4134],{6602:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>s,default:()=>i,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var o=t(4848),a=t(8453);const r={title:"Markdown page example"},s="Markdown page example",c={type:"mdx",permalink:"/hauler-docs/markdown-page",source:"@site/src/pages/markdown-page.md",title:"Markdown page example",description:"You don't need React to write simple standalone pages.",frontMatter:{title:"Markdown page example"},unlisted:!1},p={},d=[];function l(e){const n={h1:"h1",p:"p",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"markdown-page-example",children:"Markdown page example"}),"\n",(0,o.jsx)(n.p,{children:"You don't need React to write simple standalone pages."})]})}function i(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var o=t(6540);const a={},r=o.createContext(a);function s(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3a764183.29c868a0.js b/assets/js/3a764183.29c868a0.js deleted file mode 100644 index 2cd57587e..000000000 --- a/assets/js/3a764183.29c868a0.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2370],{7412:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"0.4.3","label":"0.4.3","banner":"unmaintained","badge":true,"noIndex":false,"className":"docs-version-0.4.3","isLast":false,"docsSidebars":{"haulerSidebar":[{"type":"link","label":"Introduction","href":"/hauler-docs/docs/0.4.3/intro","docId":"intro","unlisted":false},{"type":"link","label":"Core Concepts","href":"/hauler-docs/docs/0.4.3/core-concepts","docId":"core-concepts","unlisted":false},{"type":"link","label":"Airgap Workflow","href":"/hauler-docs/docs/0.4.3/airgap-workflow","docId":"airgap-workflow","unlisted":false},{"type":"category","label":"Introduction","description":"Introduction Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Quickstart","href":"/hauler-docs/docs/0.4.3/introduction/quickstart","docId":"introduction/quickstart","unlisted":false},{"type":"link","label":"Installation","href":"/hauler-docs/docs/0.4.3/introduction/install","docId":"introduction/install","unlisted":false},{"type":"link","label":"Uninstall","href":"/hauler-docs/docs/0.4.3/introduction/uninstall","docId":"introduction/uninstall","unlisted":false}],"collapsible":true},{"type":"category","label":"Guides & References","description":"Guides and References Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Overview","href":"/hauler-docs/docs/0.4.3/guides-references/overview","docId":"guides-references/overview","unlisted":false},{"type":"link","label":"Fetch Cluster Images","href":"/hauler-docs/docs/0.4.3/guides-references/cluster-images","docId":"guides-references/cluster-images","unlisted":false},{"type":"link","label":"RGS Carbide Customers","href":"/hauler-docs/docs/0.4.3/guides-references/carbide-customers","docId":"guides-references/carbide-customers","unlisted":false},{"type":"category","label":"Hauler Collections","description":"Guides and References for Hauler Collections","items":[{"type":"link","label":"Overview","href":"/hauler-docs/docs/0.4.3/guides-references/hauler-collections/overview","docId":"guides-references/hauler-collections/overview","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Hauler Content","description":"Guides and References for Hauler Content Types","items":[{"type":"link","label":"Overview","href":"/hauler-docs/docs/0.4.3/guides-references/hauler-content/overview","docId":"guides-references/hauler-content/overview","unlisted":false},{"type":"link","label":"Images","href":"/hauler-docs/docs/0.4.3/guides-references/hauler-content/images","docId":"guides-references/hauler-content/images","unlisted":false},{"type":"link","label":"Charts","href":"/hauler-docs/docs/0.4.3/guides-references/hauler-content/charts","docId":"guides-references/hauler-content/charts","unlisted":false},{"type":"link","label":"Files","href":"/hauler-docs/docs/0.4.3/guides-references/hauler-content/files","docId":"guides-references/hauler-content/files","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Command Line Interface","description":"Guides and References for the Hauler Command Line","items":[{"type":"link","label":"Hauler","href":"/hauler-docs/docs/0.4.3/guides-references/command-line/hauler","docId":"guides-references/command-line/hauler","unlisted":false},{"type":"link","label":"Hauler Store","href":"/hauler-docs/docs/0.4.3/guides-references/command-line/hauler-store","docId":"guides-references/command-line/hauler-store","unlisted":false},{"type":"link","label":"Hauler Completion","href":"/hauler-docs/docs/0.4.3/guides-references/command-line/hauler-completion","docId":"guides-references/command-line/hauler-completion","unlisted":false},{"type":"link","label":"Hauler Version","href":"/hauler-docs/docs/0.4.3/guides-references/command-line/hauler-version","docId":"guides-references/command-line/hauler-version","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true},{"type":"link","label":"Known Issues/Limits","href":"/hauler-docs/docs/0.4.3/known-limits","docId":"known-limits","unlisted":false}]},"docs":{"airgap-workflow":{"id":"airgap-workflow","title":"Airgap Workflow","description":"Airgap Workflow Documentation for Hauler","sidebar":"haulerSidebar"},"core-concepts":{"id":"core-concepts","title":"Core Concepts","description":"Core Concepts Documentation for Hauler","sidebar":"haulerSidebar"},"guides-references/carbide-customers":{"id":"guides-references/carbide-customers","title":"RGS Carbide Customers","description":"RGS Carbide Customers Documentation","sidebar":"haulerSidebar"},"guides-references/cluster-images":{"id":"guides-references/cluster-images","title":"Fetching Cluster Images","description":"Fetching Images on a Cluster Documentation","sidebar":"haulerSidebar"},"guides-references/command-line/hauler":{"id":"guides-references/command-line/hauler","title":"Hauler (Command)","description":"Hauler CLI Reference for hauler","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-completion":{"id":"guides-references/command-line/hauler-completion","title":"Hauler Completion (Command)","description":"Hauler CLI Reference for hauler completion","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-store":{"id":"guides-references/command-line/hauler-store","title":"Hauler Store (Command)","description":"Hauler CLI Reference for hauler store","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-version":{"id":"guides-references/command-line/hauler-version","title":"Hauler Version (Command)","description":"Hauler CLI Reference for hauler version","sidebar":"haulerSidebar"},"guides-references/hauler-collections/overview":{"id":"guides-references/hauler-collections/overview","title":"Overview of Hauler Collections","description":"Hauler Collections Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/charts":{"id":"guides-references/hauler-content/charts","title":"Charts (Content Type)","description":"Hauler \\"Charts\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/files":{"id":"guides-references/hauler-content/files","title":"Files (Content Type)","description":"Hauler \\"Files\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/images":{"id":"guides-references/hauler-content/images","title":"Images (Content Type)","description":"Hauler \\"Images\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/overview":{"id":"guides-references/hauler-content/overview","title":"Overview of Hauler Content","description":"Hauler Content Documentation","sidebar":"haulerSidebar"},"guides-references/overview":{"id":"guides-references/overview","title":"Overview","description":"Reference Guides Overview Documentation for Hauler","sidebar":"haulerSidebar"},"intro":{"id":"intro","title":"Introduction","description":"Introduction to Rancher Government Hauler","sidebar":"haulerSidebar"},"introduction/install":{"id":"introduction/install","title":"Installation","description":"Installation Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/quickstart":{"id":"introduction/quickstart","title":"Quickstart","description":"Quickstart Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/uninstall":{"id":"introduction/uninstall","title":"Uninstall","description":"Uninstall Documentation for Hauler","sidebar":"haulerSidebar"},"known-limits":{"id":"known-limits","title":"Known Issues and Limits","description":"Known Issues and Limitations for Hauler","sidebar":"haulerSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/3ba2d46d.4afff138.js b/assets/js/3ba2d46d.4afff138.js new file mode 100644 index 000000000..a06a9b654 --- /dev/null +++ b/assets/js/3ba2d46d.4afff138.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3779],{7209:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>h,frontMatter:()=>s,metadata:()=>a,toc:()=>c});var l=t(4848),r=t(8453);const s={title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},i=void 0,a={id:"introduction/install",title:"Installation",description:"Installation Documentation for Hauler",source:"@site/versioned_docs/version-1.0.0/introduction/install.md",sourceDirName:"introduction",slug:"/introduction/install",permalink:"/docs/1.0.0/introduction/install",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.0/introduction/install.md",tags:[],version:"1.0.0",frontMatter:{title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},sidebar:"haulerSidebar",previous:{title:"Quickstart",permalink:"/docs/1.0.0/introduction/quickstart"},next:{title:"Uninstall",permalink:"/docs/1.0.0/introduction/uninstall"}},d={},c=[{value:"Overview",id:"overview",level:2},{value:"Supported Architectures",id:"supported-architectures",level:2},{value:"Installation Steps",id:"installation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin",level:3},{value:"Homebrew",id:"homebrew",level:3},{value:"Windows",id:"windows",level:3},{value:"Manual Installation Steps",id:"manual-installation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin-1",level:3},{value:"Homebrew",id:"homebrew-1",level:3},{value:"Windows",id:"windows-1",level:3}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.h2,{id:"overview",children:"Overview"}),"\n",(0,l.jsxs)(n.p,{children:["Hauler is a purpose built to be a single binary with no specific prerequistes, depedencies, or runtime environment. It's installation is very simple and easy to follow. To view the latest release, please view our ",(0,l.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"GitHub Release"})," page."]}),"\n",(0,l.jsx)(n.h2,{id:"supported-architectures",children:"Supported Architectures"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"center"},children:"Base Platform"}),(0,l.jsx)(n.th,{style:{textAlign:"center"},children:"Architecture"}),(0,l.jsx)(n.th,{style:{textAlign:"center"},children:"Latest Release"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"center"},children:"Linux"}),(0,l.jsxs)(n.td,{style:{textAlign:"center"},children:[(0,l.jsx)(n.code,{children:"amd64"})," and ",(0,l.jsx)(n.code,{children:"arm64"})]}),(0,l.jsx)(n.td,{style:{textAlign:"center"},children:(0,l.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"center"},children:"Darwin"}),(0,l.jsxs)(n.td,{style:{textAlign:"center"},children:[(0,l.jsx)(n.code,{children:"amd64"})," and ",(0,l.jsx)(n.code,{children:"arm64"})]}),(0,l.jsx)(n.td,{style:{textAlign:"center"},children:(0,l.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"center"},children:"Windows"}),(0,l.jsxs)(n.td,{style:{textAlign:"center"},children:[(0,l.jsx)(n.code,{children:"amd64"})," and ",(0,l.jsx)(n.code,{children:"arm64"})]}),(0,l.jsx)(n.td,{style:{textAlign:"center"},children:(0,l.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]})]})]}),"\n",(0,l.jsx)(n.h2,{id:"installation-steps",children:"Installation Steps"}),"\n",(0,l.jsx)(n.h3,{id:"linuxdarwin",children:"Linux/Darwin"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n\n# install specific release\ncurl -sfL https://get.hauler.dev | HAULER_VERSION=1.0.0 bash\n"})}),"\n",(0,l.jsx)(n.h3,{id:"homebrew",children:"Homebrew"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"# installs latest release\nbrew tap rancherfederal/homebrew-tap\nbrew install hauler\n"})}),"\n",(0,l.jsx)(n.h3,{id:"windows",children:"Windows"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,l.jsx)(n.h2,{id:"manual-installation-steps",children:"Manual Installation Steps"}),"\n",(0,l.jsx)(n.h3,{id:"linuxdarwin-1",children:"Linux/Darwin"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:'# set the hauler version (i.e. "1.0.0")\nexport vHauler=HAULER_VERSION\n\n# set the specific platform (i.e. "linux")\nexport platform=PLATFORM\n\n# set the specific arch (i.e. "amd64")\nexport arch=ARCH\n\ncurl -sOL https://github.com/rancherfederal/hauler/releases/download/v${vHauler}/hauler_${vHauler}_${platform}_${arch}.tar.gz\ntar -xf hauler_${vHauler}_${platform}_${arch}.tar.gz\nsudo mv hauler /usr/bin/hauler\n'})}),"\n",(0,l.jsx)(n.h3,{id:"homebrew-1",children:"Homebrew"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"# not applicable\n"})}),"\n",(0,l.jsx)(n.h3,{id:"windows-1",children:"Windows"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"# coming soon\n"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(o,{...e})}):o(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>a});var l=t(6540);const r={},s=l.createContext(r);function i(e){const n=l.useContext(s);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),l.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3ba2d46d.80148a88.js b/assets/js/3ba2d46d.80148a88.js deleted file mode 100644 index 50fe6a06b..000000000 --- a/assets/js/3ba2d46d.80148a88.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3779],{7209:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>h,frontMatter:()=>s,metadata:()=>a,toc:()=>c});var r=t(4848),l=t(8453);const s={title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},i=void 0,a={id:"introduction/install",title:"Installation",description:"Installation Documentation for Hauler",source:"@site/versioned_docs/version-1.0.0/introduction/install.md",sourceDirName:"introduction",slug:"/introduction/install",permalink:"/hauler-docs/docs/1.0.0/introduction/install",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.0/introduction/install.md",tags:[],version:"1.0.0",frontMatter:{title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},sidebar:"haulerSidebar",previous:{title:"Quickstart",permalink:"/hauler-docs/docs/1.0.0/introduction/quickstart"},next:{title:"Uninstall",permalink:"/hauler-docs/docs/1.0.0/introduction/uninstall"}},d={},c=[{value:"Overview",id:"overview",level:2},{value:"Supported Architectures",id:"supported-architectures",level:2},{value:"Installation Steps",id:"installation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin",level:3},{value:"Homebrew",id:"homebrew",level:3},{value:"Windows",id:"windows",level:3},{value:"Manual Installation Steps",id:"manual-installation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin-1",level:3},{value:"Homebrew",id:"homebrew-1",level:3},{value:"Windows",id:"windows-1",level:3}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"overview",children:"Overview"}),"\n",(0,r.jsxs)(n.p,{children:["Hauler is a purpose built to be a single binary with no specific prerequistes, depedencies, or runtime environment. It's installation is very simple and easy to follow. To view the latest release, please view our ",(0,r.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"GitHub Release"})," page."]}),"\n",(0,r.jsx)(n.h2,{id:"supported-architectures",children:"Supported Architectures"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"center"},children:"Base Platform"}),(0,r.jsx)(n.th,{style:{textAlign:"center"},children:"Architecture"}),(0,r.jsx)(n.th,{style:{textAlign:"center"},children:"Latest Release"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"Linux"}),(0,r.jsxs)(n.td,{style:{textAlign:"center"},children:[(0,r.jsx)(n.code,{children:"amd64"})," and ",(0,r.jsx)(n.code,{children:"arm64"})]}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:(0,r.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"Darwin"}),(0,r.jsxs)(n.td,{style:{textAlign:"center"},children:[(0,r.jsx)(n.code,{children:"amd64"})," and ",(0,r.jsx)(n.code,{children:"arm64"})]}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:(0,r.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"Windows"}),(0,r.jsxs)(n.td,{style:{textAlign:"center"},children:[(0,r.jsx)(n.code,{children:"amd64"})," and ",(0,r.jsx)(n.code,{children:"arm64"})]}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:(0,r.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]})]})]}),"\n",(0,r.jsx)(n.h2,{id:"installation-steps",children:"Installation Steps"}),"\n",(0,r.jsx)(n.h3,{id:"linuxdarwin",children:"Linux/Darwin"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n\n# install specific release\ncurl -sfL https://get.hauler.dev | HAULER_VERSION=1.0.0 bash\n"})}),"\n",(0,r.jsx)(n.h3,{id:"homebrew",children:"Homebrew"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"# installs latest release\nbrew tap rancherfederal/homebrew-tap\nbrew install hauler\n"})}),"\n",(0,r.jsx)(n.h3,{id:"windows",children:"Windows"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,r.jsx)(n.h2,{id:"manual-installation-steps",children:"Manual Installation Steps"}),"\n",(0,r.jsx)(n.h3,{id:"linuxdarwin-1",children:"Linux/Darwin"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:'# set the hauler version (i.e. "1.0.0")\nexport vHauler=HAULER_VERSION\n\n# set the specific platform (i.e. "linux")\nexport platform=PLATFORM\n\n# set the specific arch (i.e. "amd64")\nexport arch=ARCH\n\ncurl -sOL https://github.com/rancherfederal/hauler/releases/download/v${vHauler}/hauler_${vHauler}_${platform}_${arch}.tar.gz\ntar -xf hauler_${vHauler}_${platform}_${arch}.tar.gz\nsudo mv hauler /usr/bin/hauler\n'})}),"\n",(0,r.jsx)(n.h3,{id:"homebrew-1",children:"Homebrew"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"# not applicable\n"})}),"\n",(0,r.jsx)(n.h3,{id:"windows-1",children:"Windows"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"# coming soon\n"})})]})}function h(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>a});var r=t(6540);const l={},s=r.createContext(l);function i(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:i(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3c47159d.d474a799.js b/assets/js/3c47159d.d474a799.js new file mode 100644 index 000000000..7c5d2c471 --- /dev/null +++ b/assets/js/3c47159d.d474a799.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4087],{3955:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"0.4.1","label":"0.4.1","banner":"unmaintained","badge":true,"noIndex":false,"className":"docs-version-0.4.1","isLast":false,"docsSidebars":{"haulerSidebar":[{"type":"link","label":"Introduction","href":"/docs/0.4.1/intro","docId":"intro","unlisted":false},{"type":"link","label":"Core Concepts","href":"/docs/0.4.1/core-concepts","docId":"core-concepts","unlisted":false},{"type":"link","label":"Airgap Workflow","href":"/docs/0.4.1/airgap-workflow","docId":"airgap-workflow","unlisted":false},{"type":"category","label":"Introduction","description":"Introduction Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Quickstart","href":"/docs/0.4.1/introduction/quickstart","docId":"introduction/quickstart","unlisted":false},{"type":"link","label":"Installation","href":"/docs/0.4.1/introduction/install","docId":"introduction/install","unlisted":false},{"type":"link","label":"Uninstall","href":"/docs/0.4.1/introduction/uninstall","docId":"introduction/uninstall","unlisted":false}],"collapsible":true},{"type":"category","label":"Guides & References","description":"Guides and References Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Overview","href":"/docs/0.4.1/guides-references/overview","docId":"guides-references/overview","unlisted":false},{"type":"link","label":"Fetch Cluster Images","href":"/docs/0.4.1/guides-references/cluster-images","docId":"guides-references/cluster-images","unlisted":false},{"type":"category","label":"Hauler Collections","description":"Guides and References for Hauler Collections","items":[{"type":"link","label":"Overview","href":"/docs/0.4.1/guides-references/hauler-collections/overview","docId":"guides-references/hauler-collections/overview","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Hauler Content","description":"Guides and References for Hauler Content Types","items":[{"type":"link","label":"Overview","href":"/docs/0.4.1/guides-references/hauler-content/overview","docId":"guides-references/hauler-content/overview","unlisted":false},{"type":"link","label":"Images","href":"/docs/0.4.1/guides-references/hauler-content/images","docId":"guides-references/hauler-content/images","unlisted":false},{"type":"link","label":"Charts","href":"/docs/0.4.1/guides-references/hauler-content/charts","docId":"guides-references/hauler-content/charts","unlisted":false},{"type":"link","label":"Files","href":"/docs/0.4.1/guides-references/hauler-content/files","docId":"guides-references/hauler-content/files","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Command Line Interface","description":"Guides and References for the Hauler Command Line","items":[{"type":"link","label":"Hauler","href":"/docs/0.4.1/guides-references/command-line/hauler","docId":"guides-references/command-line/hauler","unlisted":false},{"type":"link","label":"Hauler Store","href":"/docs/0.4.1/guides-references/command-line/hauler-store","docId":"guides-references/command-line/hauler-store","unlisted":false},{"type":"link","label":"Hauler Completion","href":"/docs/0.4.1/guides-references/command-line/hauler-completion","docId":"guides-references/command-line/hauler-completion","unlisted":false},{"type":"link","label":"Hauler Version","href":"/docs/0.4.1/guides-references/command-line/hauler-version","docId":"guides-references/command-line/hauler-version","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true},{"type":"link","label":"Known Issues/Limits","href":"/docs/0.4.1/known-limits","docId":"known-limits","unlisted":false}]},"docs":{"airgap-workflow":{"id":"airgap-workflow","title":"Airgap Workflow","description":"Airgap Workflow Documentation for Hauler","sidebar":"haulerSidebar"},"core-concepts":{"id":"core-concepts","title":"Core Concepts","description":"Core Concepts Documentation for Hauler","sidebar":"haulerSidebar"},"guides-references/cluster-images":{"id":"guides-references/cluster-images","title":"Fetching Cluster Images","description":"Fetching Images on a Cluster Documentation","sidebar":"haulerSidebar"},"guides-references/command-line/hauler":{"id":"guides-references/command-line/hauler","title":"Hauler (Command)","description":"Hauler CLI Reference for hauler","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-completion":{"id":"guides-references/command-line/hauler-completion","title":"Hauler Completion (Command)","description":"Hauler CLI Reference for hauler completion","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-store":{"id":"guides-references/command-line/hauler-store","title":"Hauler Store (Command)","description":"Hauler CLI Reference for hauler store","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-version":{"id":"guides-references/command-line/hauler-version","title":"Hauler Version (Command)","description":"Hauler CLI Reference for hauler version","sidebar":"haulerSidebar"},"guides-references/hauler-collections/overview":{"id":"guides-references/hauler-collections/overview","title":"Overview of Hauler Collections","description":"Hauler Collections Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/charts":{"id":"guides-references/hauler-content/charts","title":"Charts (Content Type)","description":"Hauler \\"Charts\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/files":{"id":"guides-references/hauler-content/files","title":"Files (Content Type)","description":"Hauler \\"Files\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/images":{"id":"guides-references/hauler-content/images","title":"Images (Content Type)","description":"Hauler \\"Images\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/overview":{"id":"guides-references/hauler-content/overview","title":"Overview of Hauler Content","description":"Hauler Content Documentation","sidebar":"haulerSidebar"},"guides-references/overview":{"id":"guides-references/overview","title":"Overview","description":"Reference Guides Overview Documentation for Hauler","sidebar":"haulerSidebar"},"intro":{"id":"intro","title":"Introduction","description":"Introduction to Rancher Government Hauler","sidebar":"haulerSidebar"},"introduction/install":{"id":"introduction/install","title":"Installation","description":"Installation Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/quickstart":{"id":"introduction/quickstart","title":"Quickstart","description":"Quickstart Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/uninstall":{"id":"introduction/uninstall","title":"Uninstall","description":"Uninstall Documentation for Hauler","sidebar":"haulerSidebar"},"known-limits":{"id":"known-limits","title":"Known Issues and Limits","description":"Known Issues and Limitations for Hauler","sidebar":"haulerSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/3ed46708.971312e5.js b/assets/js/3ed46708.971312e5.js deleted file mode 100644 index 82c0b89b8..000000000 --- a/assets/js/3ed46708.971312e5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[41],{280:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var n=r(4848),i=r(8453);const s={title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},l=void 0,c={id:"guides-references/overview",title:"Overview",description:"Reference Guides Overview Documentation for Hauler",source:"@site/versioned_docs/version-0.4.4/guides-references/overview.md",sourceDirName:"guides-references",slug:"/guides-references/overview",permalink:"/hauler-docs/docs/0.4.4/guides-references/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.4/guides-references/overview.md",tags:[],version:"0.4.4",frontMatter:{title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Uninstall",permalink:"/hauler-docs/docs/0.4.4/introduction/uninstall"},next:{title:"Fetch Cluster Images",permalink:"/hauler-docs/docs/0.4.4/guides-references/cluster-images"}},o={},d=[{value:"Hauler Guides & Reference Documentation",id:"hauler-guides--reference-documentation",level:2}];function a(e){const t={a:"a",h2:"h2",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Additional Overview Documentation pending a future release!"}),"\n",(0,n.jsx)(t.h2,{id:"hauler-guides--reference-documentation",children:"Hauler Guides & Reference Documentation"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Guide or Reference Documentation"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"cluster-images",children:"Cluster Images"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Create a Hauler Store from Images on a Cluster"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-collections/overview",children:"Hauler Collections"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of Hauler Collections"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-content/overview",children:"Hauler Content"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of Hauler Content"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"command-line/hauler",children:"Hauler Command Line"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of the Hauler Command Line Interface"})]})]})]})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>l,x:()=>c});var n=r(6540);const i={},s=n.createContext(i);function l(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3ed46708.d8eb4908.js b/assets/js/3ed46708.d8eb4908.js new file mode 100644 index 000000000..be2008883 --- /dev/null +++ b/assets/js/3ed46708.d8eb4908.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[41],{280:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var n=r(4848),i=r(8453);const s={title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},l=void 0,c={id:"guides-references/overview",title:"Overview",description:"Reference Guides Overview Documentation for Hauler",source:"@site/versioned_docs/version-0.4.4/guides-references/overview.md",sourceDirName:"guides-references",slug:"/guides-references/overview",permalink:"/docs/0.4.4/guides-references/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.4/guides-references/overview.md",tags:[],version:"0.4.4",frontMatter:{title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Uninstall",permalink:"/docs/0.4.4/introduction/uninstall"},next:{title:"Fetch Cluster Images",permalink:"/docs/0.4.4/guides-references/cluster-images"}},o={},d=[{value:"Hauler Guides & Reference Documentation",id:"hauler-guides--reference-documentation",level:2}];function a(e){const t={a:"a",h2:"h2",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Additional Overview Documentation pending a future release!"}),"\n",(0,n.jsx)(t.h2,{id:"hauler-guides--reference-documentation",children:"Hauler Guides & Reference Documentation"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Guide or Reference Documentation"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"cluster-images",children:"Cluster Images"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Create a Hauler Store from Images on a Cluster"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-collections/overview",children:"Hauler Collections"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of Hauler Collections"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-content/overview",children:"Hauler Content"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of Hauler Content"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"command-line/hauler",children:"Hauler Command Line"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of the Hauler Command Line Interface"})]})]})]})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>l,x:()=>c});var n=r(6540);const i={},s=n.createContext(i);function l(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4121d743.907828da.js b/assets/js/4121d743.907828da.js new file mode 100644 index 000000000..3a01d4581 --- /dev/null +++ b/assets/js/4121d743.907828da.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[6753],{2651:(n,t,e)=>{e.r(t),e.d(t,{assets:()=>a,contentTitle:()=>s,default:()=>d,frontMatter:()=>r,metadata:()=>l,toc:()=>c});var i=e(4848),o=e(8453);const r={title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},s=void 0,l={id:"introduction/uninstall",title:"Uninstall",description:"Uninstall Documentation for Hauler",source:"@site/versioned_docs/version-0.4.2/introduction/uninstall.md",sourceDirName:"introduction",slug:"/introduction/uninstall",permalink:"/docs/0.4.2/introduction/uninstall",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.2/introduction/uninstall.md",tags:[],version:"0.4.2",frontMatter:{title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},sidebar:"haulerSidebar",previous:{title:"Installation",permalink:"/docs/0.4.2/introduction/install"},next:{title:"Overview",permalink:"/docs/0.4.2/guides-references/overview"}},a={},c=[];function u(n){const t={p:"p",...(0,o.R)(),...n.components};return(0,i.jsx)(t.p,{children:"Uninstall Documentation pending a future release!"})}function d(n={}){const{wrapper:t}={...(0,o.R)(),...n.components};return t?(0,i.jsx)(t,{...n,children:(0,i.jsx)(u,{...n})}):u(n)}},8453:(n,t,e)=>{e.d(t,{R:()=>s,x:()=>l});var i=e(6540);const o={},r=i.createContext(o);function s(n){const t=i.useContext(r);return i.useMemo((function(){return"function"==typeof n?n(t):{...t,...n}}),[t,n])}function l(n){let t;return t=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:s(n.components),i.createElement(r.Provider,{value:t},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/4121d743.b977e6d2.js b/assets/js/4121d743.b977e6d2.js deleted file mode 100644 index 64270a834..000000000 --- a/assets/js/4121d743.b977e6d2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[6753],{2651:(n,t,e)=>{e.r(t),e.d(t,{assets:()=>a,contentTitle:()=>s,default:()=>d,frontMatter:()=>r,metadata:()=>l,toc:()=>c});var o=e(4848),i=e(8453);const r={title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},s=void 0,l={id:"introduction/uninstall",title:"Uninstall",description:"Uninstall Documentation for Hauler",source:"@site/versioned_docs/version-0.4.2/introduction/uninstall.md",sourceDirName:"introduction",slug:"/introduction/uninstall",permalink:"/hauler-docs/docs/0.4.2/introduction/uninstall",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.2/introduction/uninstall.md",tags:[],version:"0.4.2",frontMatter:{title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},sidebar:"haulerSidebar",previous:{title:"Installation",permalink:"/hauler-docs/docs/0.4.2/introduction/install"},next:{title:"Overview",permalink:"/hauler-docs/docs/0.4.2/guides-references/overview"}},a={},c=[];function u(n){const t={p:"p",...(0,i.R)(),...n.components};return(0,o.jsx)(t.p,{children:"Uninstall Documentation pending a future release!"})}function d(n={}){const{wrapper:t}={...(0,i.R)(),...n.components};return t?(0,o.jsx)(t,{...n,children:(0,o.jsx)(u,{...n})}):u(n)}},8453:(n,t,e)=>{e.d(t,{R:()=>s,x:()=>l});var o=e(6540);const i={},r=o.createContext(i);function s(n){const t=o.useContext(r);return o.useMemo((function(){return"function"==typeof n?n(t):{...t,...n}}),[t,n])}function l(n){let t;return t=n.disableParentContext?"function"==typeof n.components?n.components(i):n.components||i:s(n.components),o.createElement(r.Provider,{value:t},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/427729a3.3114c0cf.js b/assets/js/427729a3.3114c0cf.js new file mode 100644 index 000000000..3413cf250 --- /dev/null +++ b/assets/js/427729a3.3114c0cf.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[6848],{9875:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>i,contentTitle:()=>l,default:()=>u,frontMatter:()=>t,metadata:()=>s,toc:()=>c});var o=r(4848),a=r(8453);const t={title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},l=void 0,s={id:"guides-references/command-line/hauler",title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",source:"@site/versioned_docs/version-0.4.2/guides-references/command-line/hauler.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler",permalink:"/docs/0.4.2/guides-references/command-line/hauler",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.2/guides-references/command-line/hauler.md",tags:[],version:"0.4.2",frontMatter:{title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},sidebar:"haulerSidebar",previous:{title:"Files",permalink:"/docs/0.4.2/guides-references/hauler-content/files"},next:{title:"Hauler Store",permalink:"/docs/0.4.2/guides-references/command-line/hauler-store"}},i={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Interact with Hauler's command line."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler [flags]\n hauler [command]\n\nAvailable Commands:\n completion Generates completion scripts for various shells\n download Download OCI content from a registry and populate it on disk\n help Help about any command\n serve Run one or more of hauler\'s embedded servers types\n store Interact with hauler\'s embedded content store\n version Print the current version\n\nFlags:\n -h, --help help for hauler\n -l, --log-level string (default "info")\n\nUse "hauler [command] --help" for more information about a command.\n'})})]})}function u(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>s});var o=r(6540);const a={},t=o.createContext(a);function l(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:l(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/427729a3.69f16914.js b/assets/js/427729a3.69f16914.js deleted file mode 100644 index 561a02f9b..000000000 --- a/assets/js/427729a3.69f16914.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[6848],{9875:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>i,contentTitle:()=>s,default:()=>u,frontMatter:()=>l,metadata:()=>t,toc:()=>c});var o=r(4848),a=r(8453);const l={title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},s=void 0,t={id:"guides-references/command-line/hauler",title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",source:"@site/versioned_docs/version-0.4.2/guides-references/command-line/hauler.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler",permalink:"/hauler-docs/docs/0.4.2/guides-references/command-line/hauler",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.2/guides-references/command-line/hauler.md",tags:[],version:"0.4.2",frontMatter:{title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},sidebar:"haulerSidebar",previous:{title:"Files",permalink:"/hauler-docs/docs/0.4.2/guides-references/hauler-content/files"},next:{title:"Hauler Store",permalink:"/hauler-docs/docs/0.4.2/guides-references/command-line/hauler-store"}},i={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Interact with Hauler's command line."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler [flags]\n hauler [command]\n\nAvailable Commands:\n completion Generates completion scripts for various shells\n download Download OCI content from a registry and populate it on disk\n help Help about any command\n serve Run one or more of hauler\'s embedded servers types\n store Interact with hauler\'s embedded content store\n version Print the current version\n\nFlags:\n -h, --help help for hauler\n -l, --log-level string (default "info")\n\nUse "hauler [command] --help" for more information about a command.\n'})})]})}function u(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>t});var o=r(6540);const a={},l=o.createContext(a);function s(e){const n=o.useContext(l);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),o.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/43cd4838.780806d1.js b/assets/js/43cd4838.780806d1.js new file mode 100644 index 000000000..658d704b9 --- /dev/null +++ b/assets/js/43cd4838.780806d1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8184],{4393:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var o=t(4848),r=t(8453);const i={title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},c=void 0,s={id:"core-concepts",title:"Core Concepts",description:"Core Concepts Documentation for Hauler",source:"@site/docs/core-concepts.md",sourceDirName:".",slug:"/core-concepts",permalink:"/docs/next/core-concepts",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/docs/core-concepts.md",tags:[],version:"current",frontMatter:{title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},sidebar:"haulerSidebar",previous:{title:"Introduction",permalink:"/docs/next/intro"},next:{title:"Airgap Workflow",permalink:"/docs/next/airgap-workflow"}},a={},l=[{value:"Haul",id:"haul",level:2},{value:"Collections",id:"collections",level:2},{value:"Community Collections",id:"community-collections",level:3},{value:"RGS Carbide Collections",id:"rgs-carbide-collections",level:3},{value:"Content",id:"content",level:2},{value:"Declarative Content",id:"declarative-content",level:3}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"hauler-diagram",src:t(6178).A+"",width:"1949",height:"988"})}),"\n",(0,o.jsx)(n.h2,{id:"haul",children:"Haul"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauls"})," are Compressed Archive (Tarball) of Hauler Collections and Content."]})}),"\n",(0,o.jsxs)(n.p,{children:["At the heart of Hauler lies the concept of a ",(0,o.jsx)(n.code,{children:"Haul"}),". A ",(0,o.jsx)(n.code,{children:"Haul"})," is a compressed archive, often in the form of a tarball, containing Hauler collections and content. It serves as a container for grouping and transporting various data types, making it a fundamental element in the Hauler ecosystem."]}),"\n",(0,o.jsx)(n.h2,{id:"collections",children:"Collections"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are Grouping of one or more Hauler Contents."]})}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are the building blocks of Hauler. These are groupings of one or more Hauler ",(0,o.jsx)(n.code,{children:"contents"}),". Think of ",(0,o.jsx)(n.code,{children:"collections"})," as organized sets of data that collectively represent something desirable."]}),"\n",(0,o.jsx)(n.h3,{id:"community-collections",children:"Community Collections"}),"\n",(0,o.jsxs)(n.p,{children:["While ",(0,o.jsx)(n.code,{children:"collections"})," (and ",(0,o.jsx)(n.code,{children:"contents"}),") are built into Hauler, our goal is to empower operators to define their own ",(0,o.jsx)(n.code,{children:"collections"}),". This way, you can tailor Hauler to your unique requirements and take full control of your artifacts."]}),"\n",(0,o.jsx)(n.h3,{id:"rgs-carbide-collections",children:"RGS Carbide Collections"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauler"})," provides the ability to import ",(0,o.jsx)(n.code,{children:"collections"})," for the Rancher products, making it seamless for RGS Supported Customers to airgap any of the Rancher products or projects. If you haven't heard of Rancher Government Carbide, check it out ",(0,o.jsx)(n.a,{href:"https://ranchergovernment.com/carbide",children:"here"}),"!"]}),"\n",(0,o.jsx)(n.h2,{id:"content",children:"Content"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Contents"})," are Artifacts such as Images, Charts, or Files."]})}),"\n",(0,o.jsxs)(n.p,{children:["In Hauler's terminology, ",(0,o.jsx)(n.code,{children:"content"})," refers to artifacts such as ",(0,o.jsx)(n.strong,{children:"container images, helm charts, or files."})," These are the fundamental types of artifacts for ",(0,o.jsx)(n.code,{children:"Hauler"}),". To understand it a little bit better, let's break it down:"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Content"}),": The fundamental type of artifacts that Hauler recognizes (images, charts, and files)."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Artifact"}),": Anything that can be represented as an OCI (Open Container Initiative) Compliant Artifact.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"OCI Compliant Artifacts provide a standardized way to store arbitrary files, making it easier to manage content efficiently."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"declarative-content",children:"Declarative Content"}),"\n",(0,o.jsxs)(n.p,{children:["While manually adding content to ",(0,o.jsx)(n.code,{children:"Hauler"})," is an easy way to get started, there is a more sustainable approach... ",(0,o.jsx)(n.code,{children:"Hauler"})," provides a declarative and programmatic approach by allowing operators to define ",(0,o.jsx)(n.code,{children:"content"})," within a configuration file, known as a manifest. This approach ensures a more reproducable workflow for managing the lifecycle of your ",(0,o.jsx)(n.code,{children:"hauls"}),". Check it out ",(0,o.jsx)(n.a,{href:"/docs/next/guides-references/manifests",children:"here"}),"!"]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},6178:(e,n,t)=>{t.d(n,{A:()=>o});const o=t.p+"assets/images/hauler-diagram-53f9182c0d98fe871fb3cf7fe8cd475a.png"},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>s});var o=t(6540);const r={},i=o.createContext(r);function c(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/43cd4838.7e06d619.js b/assets/js/43cd4838.7e06d619.js deleted file mode 100644 index 9eb8d5d58..000000000 --- a/assets/js/43cd4838.7e06d619.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8184],{4393:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var o=t(4848),r=t(8453);const i={title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},c=void 0,s={id:"core-concepts",title:"Core Concepts",description:"Core Concepts Documentation for Hauler",source:"@site/docs/core-concepts.md",sourceDirName:".",slug:"/core-concepts",permalink:"/hauler-docs/docs/next/core-concepts",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/docs/core-concepts.md",tags:[],version:"current",frontMatter:{title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},sidebar:"haulerSidebar",previous:{title:"Introduction",permalink:"/hauler-docs/docs/next/intro"},next:{title:"Airgap Workflow",permalink:"/hauler-docs/docs/next/airgap-workflow"}},a={},l=[{value:"Haul",id:"haul",level:2},{value:"Collections",id:"collections",level:2},{value:"Community Collections",id:"community-collections",level:3},{value:"RGS Carbide Collections",id:"rgs-carbide-collections",level:3},{value:"Content",id:"content",level:2},{value:"Declarative Content",id:"declarative-content",level:3}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"hauler-diagram",src:t(6178).A+"",width:"1949",height:"988"})}),"\n",(0,o.jsx)(n.h2,{id:"haul",children:"Haul"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauls"})," are Compressed Archive (Tarball) of Hauler Collections and Content."]})}),"\n",(0,o.jsxs)(n.p,{children:["At the heart of Hauler lies the concept of a ",(0,o.jsx)(n.code,{children:"Haul"}),". A ",(0,o.jsx)(n.code,{children:"Haul"})," is a compressed archive, often in the form of a tarball, containing Hauler collections and content. It serves as a container for grouping and transporting various data types, making it a fundamental element in the Hauler ecosystem."]}),"\n",(0,o.jsx)(n.h2,{id:"collections",children:"Collections"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are Grouping of one or more Hauler Contents."]})}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are the building blocks of Hauler. These are groupings of one or more Hauler ",(0,o.jsx)(n.code,{children:"contents"}),". Think of ",(0,o.jsx)(n.code,{children:"collections"})," as organized sets of data that collectively represent something desirable."]}),"\n",(0,o.jsx)(n.h3,{id:"community-collections",children:"Community Collections"}),"\n",(0,o.jsxs)(n.p,{children:["While ",(0,o.jsx)(n.code,{children:"collections"})," (and ",(0,o.jsx)(n.code,{children:"contents"}),") are built into Hauler, our goal is to empower operators to define their own ",(0,o.jsx)(n.code,{children:"collections"}),". This way, you can tailor Hauler to your unique requirements and take full control of your artifacts."]}),"\n",(0,o.jsx)(n.h3,{id:"rgs-carbide-collections",children:"RGS Carbide Collections"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauler"})," provides the ability to import ",(0,o.jsx)(n.code,{children:"collections"})," for the Rancher products, making it seamless for RGS Supported Customers to airgap any of the Rancher products or projects. If you haven't heard of Rancher Government Carbide, check it out ",(0,o.jsx)(n.a,{href:"https://ranchergovernment.com/carbide",children:"here"}),"!"]}),"\n",(0,o.jsx)(n.h2,{id:"content",children:"Content"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Contents"})," are Artifacts such as Images, Charts, or Files."]})}),"\n",(0,o.jsxs)(n.p,{children:["In Hauler's terminology, ",(0,o.jsx)(n.code,{children:"content"})," refers to artifacts such as ",(0,o.jsx)(n.strong,{children:"container images, helm charts, or files."})," These are the fundamental types of artifacts for ",(0,o.jsx)(n.code,{children:"Hauler"}),". To understand it a little bit better, let's break it down:"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Content"}),": The fundamental type of artifacts that Hauler recognizes (images, charts, and files)."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Artifact"}),": Anything that can be represented as an OCI (Open Container Initiative) Compliant Artifact.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"OCI Compliant Artifacts provide a standardized way to store arbitrary files, making it easier to manage content efficiently."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"declarative-content",children:"Declarative Content"}),"\n",(0,o.jsxs)(n.p,{children:["While manually adding content to ",(0,o.jsx)(n.code,{children:"Hauler"})," is an easy way to get started, there is a more sustainable approach... ",(0,o.jsx)(n.code,{children:"Hauler"})," provides a declarative and programmatic approach by allowing operators to define ",(0,o.jsx)(n.code,{children:"content"})," within a configuration file, known as a manifest. This approach ensures a more reproducable workflow for managing the lifecycle of your ",(0,o.jsx)(n.code,{children:"hauls"}),". Check it out ",(0,o.jsx)(n.a,{href:"/hauler-docs/docs/next/guides-references/manifests",children:"here"}),"!"]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},6178:(e,n,t)=>{t.d(n,{A:()=>o});const o=t.p+"assets/images/hauler-diagram-53f9182c0d98fe871fb3cf7fe8cd475a.png"},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>s});var o=t(6540);const r={},i=o.createContext(r);function c(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/44768bd5.098fd5f0.js b/assets/js/44768bd5.098fd5f0.js new file mode 100644 index 000000000..ce69cb8ef --- /dev/null +++ b/assets/js/44768bd5.098fd5f0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[6867],{6341:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>i,contentTitle:()=>l,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>c});var t=n(4848),a=n(8453);const s={title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},l=void 0,o={id:"guides-references/command-line/hauler-store",title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",source:"@site/versioned_docs/version-1.0.x/guides-references/command-line/hauler-store.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-store",permalink:"/docs/guides-references/command-line/hauler-store",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/command-line/hauler-store.md",tags:[],version:"1.0.x",frontMatter:{title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},sidebar:"haulerSidebar",previous:{title:"Hauler",permalink:"/docs/guides-references/command-line/hauler"},next:{title:"Hauler Completion",permalink:"/docs/guides-references/command-line/hauler-completion"}},i={},c=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler store add:",id:"hauler-store-add",level:4},{value:"hauler store add image:",id:"hauler-store-add-image",level:4},{value:"hauler store add chart:",id:"hauler-store-add-chart",level:4},{value:"hauler store add file:",id:"hauler-store-add-file",level:4},{value:"hauler store copy:",id:"hauler-store-copy",level:4},{value:"hauler store extract:",id:"hauler-store-extract",level:4},{value:"hauler store info:",id:"hauler-store-info",level:4},{value:"hauler store load:",id:"hauler-store-load",level:4},{value:"hauler store save:",id:"hauler-store-save",level:4},{value:"hauler store sync:",id:"hauler-store-sync",level:4},{value:"hauler store serve:",id:"hauler-store-serve",level:4},{value:"hauler store serve registry:",id:"hauler-store-serve-registry",level:4},{value:"hauler store serve fileserver:",id:"hauler-store-serve-fileserver",level:4}];function d(e){const r={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Interact with Hauler's embedded content store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store [flags]\n hauler store [command]\n\nAliases:\n store, s\n\nAvailable Commands:\n add Add content to store\n copy Copy all store contents to another OCI registry\n extract Extract content from the store to disk\n info Print out information about the store\n load Load a content store from a store archive\n save Save a content store to a store archive\n serve Expose the content of a local store through an OCI compliant registry or file server\n sync Sync content to the embedded content store\n\nFlags:\n --cache string (deprecated flag and currently not used)\n -h, --help help for store\n -s, --store string Location to create store at (default "store")\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler store [command] --help" for more information about a command.\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-add",children:[(0,t.jsx)(r.code,{children:"hauler store add"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Add content to store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add [flags]\n hauler store add [command]\n\nAvailable Commands:\n chart Add a local or remote chart to the content store\n file Add a file to the content store\n image Add an image to the content store\n\nFlags:\n -h, --help help for add\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n\nUse "hauler store add [command] --help" for more information about a command.\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-add-image",children:[(0,t.jsx)(r.code,{children:"hauler store add image"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Add an image to the content store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add image [flags]\n\nFlags:\n -h, --help help for image\n -k, --key string (Optional) Path to the key for digital signature verification\n -p, --platform string (Optional) Specific platform to save. i.e. linux/amd64. Defaults to all if flag is omitted.\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-add-chart",children:[(0,t.jsx)(r.code,{children:"hauler store add chart"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Add a local or remote chart to the content store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add chart [flags]\n\nExamples:\n\n# add a local chart\nhauler store add chart path/to/chart/directory\n\n# add a local compressed chart\nhauler store add chart path/to/chart.tar.gz\n\n# add a remote chart\nhauler store add chart longhorn --repo "https://charts.longhorn.io"\n\n# add a specific version of a chart\nhauler store add chart rancher --repo "https://releases.rancher.com/server-charts/latest" --version "2.6.2"\n\n\nFlags:\n --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle\n --cert-file string identify HTTPS client using this SSL certificate file\n -h, --help help for chart\n --insecure-skip-tls-verify skip tls certificate checks for the chart download\n --key-file string identify HTTPS client using this SSL key file\n --password string chart repository password where to locate the requested chart\n --repo string chart repository url where to locate the requested chart\n --username string chart repository username where to locate the requested chart\n --verify verify the package before using it\n --version string specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-add-file",children:[(0,t.jsx)(r.code,{children:"hauler store add file"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Add a file to the content store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add file [flags]\n\nFlags:\n -h, --help help for file\n -n, --name string (Optional) Name to assign to file in store\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-copy",children:[(0,t.jsx)(r.code,{children:"hauler store copy"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Copy all store contents to another OCI registry."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store copy [flags]\n\nFlags:\n -h, --help help for copy\n --insecure Toggle allowing insecure connections when copying to a remote registry\n -p, --password string Password when copying to an authenticated remote registry\n --plain-http Toggle allowing plain http connections when copying to a remote registry\n -u, --username string Username when copying to an authenticated remote registry\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-extract",children:[(0,t.jsx)(r.code,{children:"hauler store extract"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Extract content from the store to disk."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store extract [flags]\n\nAliases:\n extract, x\n\nFlags:\n -h, --help help for extract\n -o, --output string Directory to save contents to (defaults to current directory)\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-info",children:[(0,t.jsx)(r.code,{children:"hauler store info"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Print out information about the store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store info [flags]\n\nAliases:\n info, i, list, ls\n\nFlags:\n -h, --help help for info\n -o, --output string Output format (table, json) (default "table")\n -t, --type string Filter on type (image, chart, file, sigs, atts, sbom) (default "all")\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-load",children:[(0,t.jsx)(r.code,{children:"hauler store load"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Load a content store from a store archive."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store load [flags]\n\nFlags:\n -h, --help help for load\n -t, --tempdir string overrides the default directory for temporary files, as returned by your OS.\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-save",children:[(0,t.jsx)(r.code,{children:"hauler store save"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Save a content store to a store archive."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store save [flags]\n\nFlags:\n -f, --filename string Name of archive (default "haul.tar.zst")\n -h, --help help for save\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-sync",children:[(0,t.jsx)(r.code,{children:"hauler store sync"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Sync content to the embedded content store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store sync [flags]\n\nFlags:\n -f, --files strings Path to content files\n -h, --help help for sync\n -k, --key string (Optional) Path to the key for signature verification\n -p, --platform string (Optional) Specific platform to save. i.e. linux/amd64. Defaults to all if flag is omitted.\n -c, --product-registry string (Optional) Specific Product Registry to use. Defaults to RGS Carbide Registry (rgcrprod.azurecr.us).\n --products strings Used for RGS Carbide customers to supply a product and version and Hauler will retrieve the images. i.e. \'--product rancher=v2.7.6\'\n -r, --registry string (Optional) Default pull registry for image refs that are not specifying a registry name.\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-serve",children:[(0,t.jsx)(r.code,{children:"hauler store serve"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Expose the content of a local store through an OCI compliant registry or file server."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve [flags]\n hauler store serve [command]\n\nAvailable Commands:\n fileserver Serve the file server\n registry Serve the embedded registry\n\nFlags:\n -h, --help help for serve\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n\nUse "hauler store serve [command] --help" for more information about a command.\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-serve-registry",children:[(0,t.jsx)(r.code,{children:"hauler store serve registry"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Serve the embedded registry"}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve registry [flags]\n\nFlags:\n -c, --config string Path to a config file, will override all other configs\n --directory string Directory to use for backend. Defaults to $PWD/registry (default "registry")\n -h, --help help for registry\n -p, --port int Port to listen on. (default 5000)\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-serve-fileserver",children:[(0,t.jsx)(r.code,{children:"hauler store serve fileserver"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Serve the fileserver"}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve fileserver [flags]\n\nFlags:\n --directory string Directory to use for backend. Defaults to $PWD/fileserver (default "fileserver")\n -h, --help help for fileserver\n -p, --port int Port to listen on. (default 8080)\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})})]})}function h(e={}){const{wrapper:r}={...(0,a.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>l,x:()=>o});var t=n(6540);const a={},s=t.createContext(a);function l(e){const r=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:l(e.components),t.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/44768bd5.f7fb0f0a.js b/assets/js/44768bd5.f7fb0f0a.js deleted file mode 100644 index 7b668779a..000000000 --- a/assets/js/44768bd5.f7fb0f0a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[6867],{6341:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>i,contentTitle:()=>l,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>c});var t=n(4848),a=n(8453);const s={title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},l=void 0,o={id:"guides-references/command-line/hauler-store",title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",source:"@site/versioned_docs/version-1.0.x/guides-references/command-line/hauler-store.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-store",permalink:"/hauler-docs/docs/guides-references/command-line/hauler-store",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/command-line/hauler-store.md",tags:[],version:"1.0.x",frontMatter:{title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},sidebar:"haulerSidebar",previous:{title:"Hauler",permalink:"/hauler-docs/docs/guides-references/command-line/hauler"},next:{title:"Hauler Completion",permalink:"/hauler-docs/docs/guides-references/command-line/hauler-completion"}},i={},c=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler store add:",id:"hauler-store-add",level:4},{value:"hauler store add image:",id:"hauler-store-add-image",level:4},{value:"hauler store add chart:",id:"hauler-store-add-chart",level:4},{value:"hauler store add file:",id:"hauler-store-add-file",level:4},{value:"hauler store copy:",id:"hauler-store-copy",level:4},{value:"hauler store extract:",id:"hauler-store-extract",level:4},{value:"hauler store info:",id:"hauler-store-info",level:4},{value:"hauler store load:",id:"hauler-store-load",level:4},{value:"hauler store save:",id:"hauler-store-save",level:4},{value:"hauler store sync:",id:"hauler-store-sync",level:4},{value:"hauler store serve:",id:"hauler-store-serve",level:4},{value:"hauler store serve registry:",id:"hauler-store-serve-registry",level:4},{value:"hauler store serve fileserver:",id:"hauler-store-serve-fileserver",level:4}];function d(e){const r={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Interact with Hauler's embedded content store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store [flags]\n hauler store [command]\n\nAliases:\n store, s\n\nAvailable Commands:\n add Add content to store\n copy Copy all store contents to another OCI registry\n extract Extract content from the store to disk\n info Print out information about the store\n load Load a content store from a store archive\n save Save a content store to a store archive\n serve Expose the content of a local store through an OCI compliant registry or file server\n sync Sync content to the embedded content store\n\nFlags:\n --cache string (deprecated flag and currently not used)\n -h, --help help for store\n -s, --store string Location to create store at (default "store")\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler store [command] --help" for more information about a command.\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-add",children:[(0,t.jsx)(r.code,{children:"hauler store add"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Add content to store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add [flags]\n hauler store add [command]\n\nAvailable Commands:\n chart Add a local or remote chart to the content store\n file Add a file to the content store\n image Add an image to the content store\n\nFlags:\n -h, --help help for add\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n\nUse "hauler store add [command] --help" for more information about a command.\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-add-image",children:[(0,t.jsx)(r.code,{children:"hauler store add image"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Add an image to the content store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add image [flags]\n\nFlags:\n -h, --help help for image\n -k, --key string (Optional) Path to the key for digital signature verification\n -p, --platform string (Optional) Specific platform to save. i.e. linux/amd64. Defaults to all if flag is omitted.\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-add-chart",children:[(0,t.jsx)(r.code,{children:"hauler store add chart"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Add a local or remote chart to the content store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add chart [flags]\n\nExamples:\n\n# add a local chart\nhauler store add chart path/to/chart/directory\n\n# add a local compressed chart\nhauler store add chart path/to/chart.tar.gz\n\n# add a remote chart\nhauler store add chart longhorn --repo "https://charts.longhorn.io"\n\n# add a specific version of a chart\nhauler store add chart rancher --repo "https://releases.rancher.com/server-charts/latest" --version "2.6.2"\n\n\nFlags:\n --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle\n --cert-file string identify HTTPS client using this SSL certificate file\n -h, --help help for chart\n --insecure-skip-tls-verify skip tls certificate checks for the chart download\n --key-file string identify HTTPS client using this SSL key file\n --password string chart repository password where to locate the requested chart\n --repo string chart repository url where to locate the requested chart\n --username string chart repository username where to locate the requested chart\n --verify verify the package before using it\n --version string specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-add-file",children:[(0,t.jsx)(r.code,{children:"hauler store add file"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Add a file to the content store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add file [flags]\n\nFlags:\n -h, --help help for file\n -n, --name string (Optional) Name to assign to file in store\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-copy",children:[(0,t.jsx)(r.code,{children:"hauler store copy"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Copy all store contents to another OCI registry."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store copy [flags]\n\nFlags:\n -h, --help help for copy\n --insecure Toggle allowing insecure connections when copying to a remote registry\n -p, --password string Password when copying to an authenticated remote registry\n --plain-http Toggle allowing plain http connections when copying to a remote registry\n -u, --username string Username when copying to an authenticated remote registry\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-extract",children:[(0,t.jsx)(r.code,{children:"hauler store extract"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Extract content from the store to disk."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store extract [flags]\n\nAliases:\n extract, x\n\nFlags:\n -h, --help help for extract\n -o, --output string Directory to save contents to (defaults to current directory)\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-info",children:[(0,t.jsx)(r.code,{children:"hauler store info"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Print out information about the store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store info [flags]\n\nAliases:\n info, i, list, ls\n\nFlags:\n -h, --help help for info\n -o, --output string Output format (table, json) (default "table")\n -t, --type string Filter on type (image, chart, file, sigs, atts, sbom) (default "all")\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-load",children:[(0,t.jsx)(r.code,{children:"hauler store load"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Load a content store from a store archive."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store load [flags]\n\nFlags:\n -h, --help help for load\n -t, --tempdir string overrides the default directory for temporary files, as returned by your OS.\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-save",children:[(0,t.jsx)(r.code,{children:"hauler store save"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Save a content store to a store archive."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store save [flags]\n\nFlags:\n -f, --filename string Name of archive (default "haul.tar.zst")\n -h, --help help for save\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-sync",children:[(0,t.jsx)(r.code,{children:"hauler store sync"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Sync content to the embedded content store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store sync [flags]\n\nFlags:\n -f, --files strings Path to content files\n -h, --help help for sync\n -k, --key string (Optional) Path to the key for signature verification\n -p, --platform string (Optional) Specific platform to save. i.e. linux/amd64. Defaults to all if flag is omitted.\n -c, --product-registry string (Optional) Specific Product Registry to use. Defaults to RGS Carbide Registry (rgcrprod.azurecr.us).\n --products strings Used for RGS Carbide customers to supply a product and version and Hauler will retrieve the images. i.e. \'--product rancher=v2.7.6\'\n -r, --registry string (Optional) Default pull registry for image refs that are not specifying a registry name.\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-serve",children:[(0,t.jsx)(r.code,{children:"hauler store serve"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Expose the content of a local store through an OCI compliant registry or file server."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve [flags]\n hauler store serve [command]\n\nAvailable Commands:\n fileserver Serve the file server\n registry Serve the embedded registry\n\nFlags:\n -h, --help help for serve\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n\nUse "hauler store serve [command] --help" for more information about a command.\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-serve-registry",children:[(0,t.jsx)(r.code,{children:"hauler store serve registry"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Serve the embedded registry"}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve registry [flags]\n\nFlags:\n -c, --config string Path to a config file, will override all other configs\n --directory string Directory to use for backend. Defaults to $PWD/registry (default "registry")\n -h, --help help for registry\n -p, --port int Port to listen on. (default 5000)\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-serve-fileserver",children:[(0,t.jsx)(r.code,{children:"hauler store serve fileserver"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Serve the fileserver"}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve fileserver [flags]\n\nFlags:\n --directory string Directory to use for backend. Defaults to $PWD/fileserver (default "fileserver")\n -h, --help help for fileserver\n -p, --port int Port to listen on. (default 8080)\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})})]})}function h(e={}){const{wrapper:r}={...(0,a.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>l,x:()=>o});var t=n(6540);const a={},s=t.createContext(a);function l(e){const r=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:l(e.components),t.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/450a63b5.61118264.js b/assets/js/450a63b5.61118264.js new file mode 100644 index 000000000..903eeee5c --- /dev/null +++ b/assets/js/450a63b5.61118264.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5481],{6908:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>i,contentTitle:()=>l,default:()=>d,frontMatter:()=>s,metadata:()=>o,toc:()=>h});var r=a(4848),n=a(8453);const s={title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},l=void 0,o={id:"introduction/quickstart",title:"Quickstart",description:"Quickstart Documentation for Hauler",source:"@site/versioned_docs/version-0.4.2/introduction/quickstart.md",sourceDirName:"introduction",slug:"/introduction/quickstart",permalink:"/docs/0.4.2/introduction/quickstart",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.2/introduction/quickstart.md",tags:[],version:"0.4.2",frontMatter:{title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},sidebar:"haulerSidebar",previous:{title:"Airgap Workflow",permalink:"/docs/0.4.2/airgap-workflow"},next:{title:"Installation",permalink:"/docs/0.4.2/introduction/install"}},i={},h=[{value:"Quick Installation",id:"quick-installation",level:2},{value:"Example Use of Hauler",id:"example-use-of-hauler",level:2},{value:"Add Content to the Hauler Store",id:"add-content-to-the-hauler-store",level:3},{value:"Using the Command Line:",id:"using-the-command-line",level:4},{value:"Using a Hauler Manifest:",id:"using-a-hauler-manifest",level:4},{value:"View the Hauler Store",id:"view-the-hauler-store",level:3},{value:"Save the Hauler Store",id:"save-the-hauler-store",level:3},{value:"Load the Airgapped Hauler Store",id:"load-the-airgapped-hauler-store",level:3},{value:"Serve the Hauler Store",id:"serve-the-hauler-store",level:3},{value:"Copy the Hauler Store to a Registry",id:"copy-the-hauler-store-to-a-registry",level:3},{value:"Copy the Hauler Store to a Directory",id:"copy-the-hauler-store-to-a-directory",level:3}];function c(e){const t={code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.p,{children:"Skipping past most of the documentation? Here's an easy to follow Quick Start Guide:"}),"\n",(0,r.jsx)(t.h2,{id:"quick-installation",children:"Quick Installation"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n"})}),"\n",(0,r.jsx)(t.h2,{id:"example-use-of-hauler",children:"Example Use of Hauler"}),"\n",(0,r.jsx)(t.h3,{id:"add-content-to-the-hauler-store",children:"Add Content to the Hauler Store"}),"\n",(0,r.jsx)(t.h4,{id:"using-the-command-line",children:"Using the Command Line:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# add a image: neuvector/scanner:latest\nhauler store add image neuvector/scanner:latest\n\n# add a image with supply chain artifacts\nhauler store add image rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.2 --key carbide-key.pub\n\n# add a chart: rancher-stable/rancher (v2.7.9)\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.7.9\n\n# add a file: rke2-install.sh\nhauler store add file https://get.rke2.io --name install.sh\n"})}),"\n",(0,r.jsx)(t.h4,{id:"using-a-hauler-manifest",children:"Using a Hauler Manifest:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"hauler store sync --files hauler-manfiest.yaml\n"})}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\nspec:\n images:\n - name: neuvector/scanner:latest\n - name: rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.1\n key: carbide-key.pub\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.7.9\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n - path: https://get.rke2.io\n name: install.sh\n"})}),"\n",(0,r.jsx)(t.h3,{id:"view-the-hauler-store",children:"View the Hauler Store"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# view and verify the content in the local hauler store\nhauler store info\n"})}),"\n",(0,r.jsx)(t.h3,{id:"save-the-hauler-store",children:"Save the Hauler Store"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# save and export the content in the local hauler store\nhauler store save --filename haul.tar.zst\n"})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsxs)(t.strong,{children:["airgap the ",(0,r.jsx)(t.code,{children:"haul.tar.zst"})," to the disconnected environment"]})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"load-the-airgapped-hauler-store",children:"Load the Airgapped Hauler Store"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# load and import the airgapped content to the new local hauler store\nhauler store load haul.tar.zst\n"})}),"\n",(0,r.jsx)(t.h3,{id:"serve-the-hauler-store",children:"Serve the Hauler Store"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# serve the content as a registry from the hauler store\nhauler store serve\n"})}),"\n",(0,r.jsx)(t.h3,{id:"copy-the-hauler-store-to-a-registry",children:"Copy the Hauler Store to a Registry"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# copy the content to a registry from the hauler store\nhauler store copy registry://harbor.example.com\n"})}),"\n",(0,r.jsx)(t.h3,{id:"copy-the-hauler-store-to-a-directory",children:"Copy the Hauler Store to a Directory"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# copy the content to a directory from the hauler store\nhauler store copy dir://hauler-files\n"})})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},8453:(e,t,a)=>{a.d(t,{R:()=>l,x:()=>o});var r=a(6540);const n={},s=r.createContext(n);function l(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:l(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/450a63b5.9c236b98.js b/assets/js/450a63b5.9c236b98.js deleted file mode 100644 index ce2ace5eb..000000000 --- a/assets/js/450a63b5.9c236b98.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5481],{6908:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>i,contentTitle:()=>l,default:()=>d,frontMatter:()=>s,metadata:()=>o,toc:()=>h});var r=a(4848),n=a(8453);const s={title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},l=void 0,o={id:"introduction/quickstart",title:"Quickstart",description:"Quickstart Documentation for Hauler",source:"@site/versioned_docs/version-0.4.2/introduction/quickstart.md",sourceDirName:"introduction",slug:"/introduction/quickstart",permalink:"/hauler-docs/docs/0.4.2/introduction/quickstart",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.2/introduction/quickstart.md",tags:[],version:"0.4.2",frontMatter:{title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},sidebar:"haulerSidebar",previous:{title:"Airgap Workflow",permalink:"/hauler-docs/docs/0.4.2/airgap-workflow"},next:{title:"Installation",permalink:"/hauler-docs/docs/0.4.2/introduction/install"}},i={},h=[{value:"Quick Installation",id:"quick-installation",level:2},{value:"Example Use of Hauler",id:"example-use-of-hauler",level:2},{value:"Add Content to the Hauler Store",id:"add-content-to-the-hauler-store",level:3},{value:"Using the Command Line:",id:"using-the-command-line",level:4},{value:"Using a Hauler Manifest:",id:"using-a-hauler-manifest",level:4},{value:"View the Hauler Store",id:"view-the-hauler-store",level:3},{value:"Save the Hauler Store",id:"save-the-hauler-store",level:3},{value:"Load the Airgapped Hauler Store",id:"load-the-airgapped-hauler-store",level:3},{value:"Serve the Hauler Store",id:"serve-the-hauler-store",level:3},{value:"Copy the Hauler Store to a Registry",id:"copy-the-hauler-store-to-a-registry",level:3},{value:"Copy the Hauler Store to a Directory",id:"copy-the-hauler-store-to-a-directory",level:3}];function c(e){const t={code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.p,{children:"Skipping past most of the documentation? Here's an easy to follow Quick Start Guide:"}),"\n",(0,r.jsx)(t.h2,{id:"quick-installation",children:"Quick Installation"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n"})}),"\n",(0,r.jsx)(t.h2,{id:"example-use-of-hauler",children:"Example Use of Hauler"}),"\n",(0,r.jsx)(t.h3,{id:"add-content-to-the-hauler-store",children:"Add Content to the Hauler Store"}),"\n",(0,r.jsx)(t.h4,{id:"using-the-command-line",children:"Using the Command Line:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# add a image: neuvector/scanner:latest\nhauler store add image neuvector/scanner:latest\n\n# add a image with supply chain artifacts\nhauler store add image rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.2 --key carbide-key.pub\n\n# add a chart: rancher-stable/rancher (v2.7.9)\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.7.9\n\n# add a file: rke2-install.sh\nhauler store add file https://get.rke2.io --name install.sh\n"})}),"\n",(0,r.jsx)(t.h4,{id:"using-a-hauler-manifest",children:"Using a Hauler Manifest:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"hauler store sync --files hauler-manfiest.yaml\n"})}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\nspec:\n images:\n - name: neuvector/scanner:latest\n - name: rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.1\n key: carbide-key.pub\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.7.9\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n - path: https://get.rke2.io\n name: install.sh\n"})}),"\n",(0,r.jsx)(t.h3,{id:"view-the-hauler-store",children:"View the Hauler Store"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# view and verify the content in the local hauler store\nhauler store info\n"})}),"\n",(0,r.jsx)(t.h3,{id:"save-the-hauler-store",children:"Save the Hauler Store"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# save and export the content in the local hauler store\nhauler store save --filename haul.tar.zst\n"})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsxs)(t.strong,{children:["airgap the ",(0,r.jsx)(t.code,{children:"haul.tar.zst"})," to the disconnected environment"]})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"load-the-airgapped-hauler-store",children:"Load the Airgapped Hauler Store"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# load and import the airgapped content to the new local hauler store\nhauler store load haul.tar.zst\n"})}),"\n",(0,r.jsx)(t.h3,{id:"serve-the-hauler-store",children:"Serve the Hauler Store"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# serve the content as a registry from the hauler store\nhauler store serve\n"})}),"\n",(0,r.jsx)(t.h3,{id:"copy-the-hauler-store-to-a-registry",children:"Copy the Hauler Store to a Registry"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# copy the content to a registry from the hauler store\nhauler store copy registry://harbor.example.com\n"})}),"\n",(0,r.jsx)(t.h3,{id:"copy-the-hauler-store-to-a-directory",children:"Copy the Hauler Store to a Directory"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# copy the content to a directory from the hauler store\nhauler store copy dir://hauler-files\n"})})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},8453:(e,t,a)=>{a.d(t,{R:()=>l,x:()=>o});var r=a(6540);const n={},s=r.createContext(n);function l(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:l(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/473c7268.89fbe483.js b/assets/js/473c7268.89fbe483.js new file mode 100644 index 000000000..b2bca9aa8 --- /dev/null +++ b/assets/js/473c7268.89fbe483.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5851],{2802:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>t,toc:()=>c});var o=l(4848),s=l(8453);const r={title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},i=void 0,t={id:"guides-references/command-line/hauler-completion",title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",source:"@site/versioned_docs/version-0.4.2/guides-references/command-line/hauler-completion.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-completion",permalink:"/docs/0.4.2/guides-references/command-line/hauler-completion",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.2/guides-references/command-line/hauler-completion.md",tags:[],version:"0.4.2",frontMatter:{title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},sidebar:"haulerSidebar",previous:{title:"Hauler Store",permalink:"/docs/0.4.2/guides-references/command-line/hauler-store"},next:{title:"Hauler Version",permalink:"/docs/0.4.2/guides-references/command-line/hauler-version"}},a={},c=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler completion bash:",id:"hauler-completion-bash",level:4},{value:"hauler completion fish:",id:"hauler-completion-fish",level:4},{value:"hauler completion powershell:",id:"hauler-completion-powershell",level:4},{value:"hauler completion zsh:",id:"hauler-completion-zsh",level:4}];function h(e){const n={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate an autocompletion script for hauler for the specified shell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler completion [command]\n\nAvailable Commands:\n bash Generates bash completion scripts\n fish Generates fish completion scripts\n powershell Generates powershell completion scripts\n zsh Generates zsh completion scripts\n\nFlags:\n -h, --help help for completion\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler completion [command] --help" for more information about a command.\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-bash",children:[(0,o.jsx)(n.code,{children:"hauler completion bash"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Generate the autocompletion script for the bash shell.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Note:"})," This script depends on the 'bash-completion' package."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion bash)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion bash > /etc/bash_completion.d/hauler\n\n#### macOS:\n\n hauler completion bash > $(brew --prefix)/etc/bash_completion.d/hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion bash\n\nFlags:\n -h, --help help for bash\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-fish",children:[(0,o.jsx)(n.code,{children:"hauler completion fish"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate the autocompletion script for the fish shell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion fish | source\n\nTo load completions for every new session, execute once:\n\n hauler completion fish > ~/.config/fish/completions/hauler.fish\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion fish [flags]\n\nFlags:\n -h, --help help for fish\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-powershell",children:[(0,o.jsx)(n.code,{children:"hauler completion powershell"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate the autocompletion script for powershell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion powershell | Out-String | Invoke-Expression\n\nTo load completions for every new session, add the output of the above command\nto your powershell profile.\n\nUsage:\n hauler completion powershell [flags]\n\nFlags:\n -h, --help help for powershell\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-zsh",children:[(0,o.jsx)(n.code,{children:"hauler completion zsh"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Generate the autocompletion script for the zsh shell.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Note:"})," If shell completion is not already enabled in your environment you will need to enable it."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion zsh)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion zsh > "${fpath[1]}/_hauler"\n\n#### macOS:\n\n hauler completion zsh > $(brew --prefix)/share/zsh/site-functions/_hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion zsh [flags]\n\nFlags:\n -h, --help help for zsh\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n'})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},8453:(e,n,l)=>{l.d(n,{R:()=>i,x:()=>t});var o=l(6540);const s={},r=o.createContext(s);function i(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/473c7268.d8d4f3a0.js b/assets/js/473c7268.d8d4f3a0.js deleted file mode 100644 index 439937603..000000000 --- a/assets/js/473c7268.d8d4f3a0.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5851],{2802:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>t,toc:()=>c});var o=l(4848),s=l(8453);const r={title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},i=void 0,t={id:"guides-references/command-line/hauler-completion",title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",source:"@site/versioned_docs/version-0.4.2/guides-references/command-line/hauler-completion.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-completion",permalink:"/hauler-docs/docs/0.4.2/guides-references/command-line/hauler-completion",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.2/guides-references/command-line/hauler-completion.md",tags:[],version:"0.4.2",frontMatter:{title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},sidebar:"haulerSidebar",previous:{title:"Hauler Store",permalink:"/hauler-docs/docs/0.4.2/guides-references/command-line/hauler-store"},next:{title:"Hauler Version",permalink:"/hauler-docs/docs/0.4.2/guides-references/command-line/hauler-version"}},a={},c=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler completion bash:",id:"hauler-completion-bash",level:4},{value:"hauler completion fish:",id:"hauler-completion-fish",level:4},{value:"hauler completion powershell:",id:"hauler-completion-powershell",level:4},{value:"hauler completion zsh:",id:"hauler-completion-zsh",level:4}];function h(e){const n={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate an autocompletion script for hauler for the specified shell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler completion [command]\n\nAvailable Commands:\n bash Generates bash completion scripts\n fish Generates fish completion scripts\n powershell Generates powershell completion scripts\n zsh Generates zsh completion scripts\n\nFlags:\n -h, --help help for completion\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler completion [command] --help" for more information about a command.\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-bash",children:[(0,o.jsx)(n.code,{children:"hauler completion bash"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Generate the autocompletion script for the bash shell.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Note:"})," This script depends on the 'bash-completion' package."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion bash)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion bash > /etc/bash_completion.d/hauler\n\n#### macOS:\n\n hauler completion bash > $(brew --prefix)/etc/bash_completion.d/hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion bash\n\nFlags:\n -h, --help help for bash\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-fish",children:[(0,o.jsx)(n.code,{children:"hauler completion fish"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate the autocompletion script for the fish shell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion fish | source\n\nTo load completions for every new session, execute once:\n\n hauler completion fish > ~/.config/fish/completions/hauler.fish\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion fish [flags]\n\nFlags:\n -h, --help help for fish\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-powershell",children:[(0,o.jsx)(n.code,{children:"hauler completion powershell"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate the autocompletion script for powershell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion powershell | Out-String | Invoke-Expression\n\nTo load completions for every new session, add the output of the above command\nto your powershell profile.\n\nUsage:\n hauler completion powershell [flags]\n\nFlags:\n -h, --help help for powershell\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-zsh",children:[(0,o.jsx)(n.code,{children:"hauler completion zsh"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Generate the autocompletion script for the zsh shell.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Note:"})," If shell completion is not already enabled in your environment you will need to enable it."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion zsh)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion zsh > "${fpath[1]}/_hauler"\n\n#### macOS:\n\n hauler completion zsh > $(brew --prefix)/share/zsh/site-functions/_hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion zsh [flags]\n\nFlags:\n -h, --help help for zsh\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n'})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},8453:(e,n,l)=>{l.d(n,{R:()=>i,x:()=>t});var o=l(6540);const s={},r=o.createContext(s);function i(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4808dc98.97f5398c.js b/assets/js/4808dc98.97f5398c.js new file mode 100644 index 000000000..aeac74c3c --- /dev/null +++ b/assets/js/4808dc98.97f5398c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4407],{1217:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>h,frontMatter:()=>s,metadata:()=>a,toc:()=>c});var l=t(4848),r=t(8453);const s={title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},i=void 0,a={id:"introduction/install",title:"Installation",description:"Installation Documentation for Hauler",source:"@site/versioned_docs/version-1.0.x/introduction/install.md",sourceDirName:"introduction",slug:"/introduction/install",permalink:"/docs/introduction/install",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.x/introduction/install.md",tags:[],version:"1.0.x",frontMatter:{title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},sidebar:"haulerSidebar",previous:{title:"Quickstart",permalink:"/docs/introduction/quickstart"},next:{title:"Uninstall",permalink:"/docs/introduction/uninstall"}},d={},c=[{value:"Overview",id:"overview",level:2},{value:"Supported Architectures",id:"supported-architectures",level:2},{value:"Installation Steps",id:"installation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin",level:3},{value:"Homebrew",id:"homebrew",level:3},{value:"Windows",id:"windows",level:3},{value:"Manual Installation Steps",id:"manual-installation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin-1",level:3},{value:"Homebrew",id:"homebrew-1",level:3},{value:"Windows",id:"windows-1",level:3}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.h2,{id:"overview",children:"Overview"}),"\n",(0,l.jsxs)(n.p,{children:["Hauler is a purpose built to be a single binary with no specific prerequistes, depedencies, or runtime environment. It's installation is very simple and easy to follow. To view the latest release, please view our ",(0,l.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"GitHub Release"})," page."]}),"\n",(0,l.jsx)(n.h2,{id:"supported-architectures",children:"Supported Architectures"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"center"},children:"Base Platform"}),(0,l.jsx)(n.th,{style:{textAlign:"center"},children:"Architecture"}),(0,l.jsx)(n.th,{style:{textAlign:"center"},children:"Latest Release"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"center"},children:"Linux"}),(0,l.jsxs)(n.td,{style:{textAlign:"center"},children:[(0,l.jsx)(n.code,{children:"amd64"})," and ",(0,l.jsx)(n.code,{children:"arm64"})]}),(0,l.jsx)(n.td,{style:{textAlign:"center"},children:(0,l.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"center"},children:"Darwin"}),(0,l.jsxs)(n.td,{style:{textAlign:"center"},children:[(0,l.jsx)(n.code,{children:"amd64"})," and ",(0,l.jsx)(n.code,{children:"arm64"})]}),(0,l.jsx)(n.td,{style:{textAlign:"center"},children:(0,l.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"center"},children:"Windows"}),(0,l.jsxs)(n.td,{style:{textAlign:"center"},children:[(0,l.jsx)(n.code,{children:"amd64"})," and ",(0,l.jsx)(n.code,{children:"arm64"})]}),(0,l.jsx)(n.td,{style:{textAlign:"center"},children:(0,l.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]})]})]}),"\n",(0,l.jsx)(n.h2,{id:"installation-steps",children:"Installation Steps"}),"\n",(0,l.jsx)(n.h3,{id:"linuxdarwin",children:"Linux/Darwin"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n\n# install specific release\ncurl -sfL https://get.hauler.dev | HAULER_VERSION=1.0.0 bash\n"})}),"\n",(0,l.jsx)(n.h3,{id:"homebrew",children:"Homebrew"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"# installs latest release\nbrew tap rancherfederal/homebrew-tap\nbrew install hauler\n"})}),"\n",(0,l.jsx)(n.h3,{id:"windows",children:"Windows"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,l.jsx)(n.h2,{id:"manual-installation-steps",children:"Manual Installation Steps"}),"\n",(0,l.jsx)(n.h3,{id:"linuxdarwin-1",children:"Linux/Darwin"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:'# set the hauler version (i.e. "1.0.0")\nexport vHauler=HAULER_VERSION\n\n# set the specific platform (i.e. "linux")\nexport platform=PLATFORM\n\n# set the specific arch (i.e. "amd64")\nexport arch=ARCH\n\ncurl -sOL https://github.com/rancherfederal/hauler/releases/download/v${vHauler}/hauler_${vHauler}_${platform}_${arch}.tar.gz\ntar -xf hauler_${vHauler}_${platform}_${arch}.tar.gz\nsudo mv hauler /usr/bin/hauler\n'})}),"\n",(0,l.jsx)(n.h3,{id:"homebrew-1",children:"Homebrew"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"# not applicable\n"})}),"\n",(0,l.jsx)(n.h3,{id:"windows-1",children:"Windows"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"# coming soon\n"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(o,{...e})}):o(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>a});var l=t(6540);const r={},s=l.createContext(r);function i(e){const n=l.useContext(s);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),l.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4808dc98.f03bd4f6.js b/assets/js/4808dc98.f03bd4f6.js deleted file mode 100644 index 0c2a7dc37..000000000 --- a/assets/js/4808dc98.f03bd4f6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4407],{1217:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>i,default:()=>h,frontMatter:()=>s,metadata:()=>a,toc:()=>c});var r=t(4848),l=t(8453);const s={title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},i=void 0,a={id:"introduction/install",title:"Installation",description:"Installation Documentation for Hauler",source:"@site/versioned_docs/version-1.0.x/introduction/install.md",sourceDirName:"introduction",slug:"/introduction/install",permalink:"/hauler-docs/docs/introduction/install",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.x/introduction/install.md",tags:[],version:"1.0.x",frontMatter:{title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},sidebar:"haulerSidebar",previous:{title:"Quickstart",permalink:"/hauler-docs/docs/introduction/quickstart"},next:{title:"Uninstall",permalink:"/hauler-docs/docs/introduction/uninstall"}},d={},c=[{value:"Overview",id:"overview",level:2},{value:"Supported Architectures",id:"supported-architectures",level:2},{value:"Installation Steps",id:"installation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin",level:3},{value:"Homebrew",id:"homebrew",level:3},{value:"Windows",id:"windows",level:3},{value:"Manual Installation Steps",id:"manual-installation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin-1",level:3},{value:"Homebrew",id:"homebrew-1",level:3},{value:"Windows",id:"windows-1",level:3}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"overview",children:"Overview"}),"\n",(0,r.jsxs)(n.p,{children:["Hauler is a purpose built to be a single binary with no specific prerequistes, depedencies, or runtime environment. It's installation is very simple and easy to follow. To view the latest release, please view our ",(0,r.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"GitHub Release"})," page."]}),"\n",(0,r.jsx)(n.h2,{id:"supported-architectures",children:"Supported Architectures"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"center"},children:"Base Platform"}),(0,r.jsx)(n.th,{style:{textAlign:"center"},children:"Architecture"}),(0,r.jsx)(n.th,{style:{textAlign:"center"},children:"Latest Release"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"Linux"}),(0,r.jsxs)(n.td,{style:{textAlign:"center"},children:[(0,r.jsx)(n.code,{children:"amd64"})," and ",(0,r.jsx)(n.code,{children:"arm64"})]}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:(0,r.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"Darwin"}),(0,r.jsxs)(n.td,{style:{textAlign:"center"},children:[(0,r.jsx)(n.code,{children:"amd64"})," and ",(0,r.jsx)(n.code,{children:"arm64"})]}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:(0,r.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"center"},children:"Windows"}),(0,r.jsxs)(n.td,{style:{textAlign:"center"},children:[(0,r.jsx)(n.code,{children:"amd64"})," and ",(0,r.jsx)(n.code,{children:"arm64"})]}),(0,r.jsx)(n.td,{style:{textAlign:"center"},children:(0,r.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]})]})]}),"\n",(0,r.jsx)(n.h2,{id:"installation-steps",children:"Installation Steps"}),"\n",(0,r.jsx)(n.h3,{id:"linuxdarwin",children:"Linux/Darwin"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n\n# install specific release\ncurl -sfL https://get.hauler.dev | HAULER_VERSION=1.0.0 bash\n"})}),"\n",(0,r.jsx)(n.h3,{id:"homebrew",children:"Homebrew"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"# installs latest release\nbrew tap rancherfederal/homebrew-tap\nbrew install hauler\n"})}),"\n",(0,r.jsx)(n.h3,{id:"windows",children:"Windows"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,r.jsx)(n.h2,{id:"manual-installation-steps",children:"Manual Installation Steps"}),"\n",(0,r.jsx)(n.h3,{id:"linuxdarwin-1",children:"Linux/Darwin"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:'# set the hauler version (i.e. "1.0.0")\nexport vHauler=HAULER_VERSION\n\n# set the specific platform (i.e. "linux")\nexport platform=PLATFORM\n\n# set the specific arch (i.e. "amd64")\nexport arch=ARCH\n\ncurl -sOL https://github.com/rancherfederal/hauler/releases/download/v${vHauler}/hauler_${vHauler}_${platform}_${arch}.tar.gz\ntar -xf hauler_${vHauler}_${platform}_${arch}.tar.gz\nsudo mv hauler /usr/bin/hauler\n'})}),"\n",(0,r.jsx)(n.h3,{id:"homebrew-1",children:"Homebrew"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"# not applicable\n"})}),"\n",(0,r.jsx)(n.h3,{id:"windows-1",children:"Windows"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"# coming soon\n"})})]})}function h(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>a});var r=t(6540);const l={},s=r.createContext(l);function i(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:i(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4832a47a.47554766.js b/assets/js/4832a47a.47554766.js new file mode 100644 index 000000000..3154c9342 --- /dev/null +++ b/assets/js/4832a47a.47554766.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7795],{5477:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>c,default:()=>m,frontMatter:()=>s,metadata:()=>r,toc:()=>u});var o=n(4848),i=n(8453);const s={title:"Hauler Community Collections",description:"Hauler Community Collections Documentation",sidebar_label:"Community Collections"},c=void 0,r={id:"guides-references/hauler-collections/community-collections",title:"Hauler Community Collections",description:"Hauler Community Collections Documentation",source:"@site/versioned_docs/version-1.0.x/guides-references/hauler-collections/community-collections.md",sourceDirName:"guides-references/hauler-collections",slug:"/guides-references/hauler-collections/community-collections",permalink:"/docs/guides-references/hauler-collections/community-collections",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/hauler-collections/community-collections.md",tags:[],version:"1.0.x",frontMatter:{title:"Hauler Community Collections",description:"Hauler Community Collections Documentation",sidebar_label:"Community Collections"},sidebar:"haulerSidebar",previous:{title:"Hauler Manifests",permalink:"/docs/guides-references/manifests"},next:{title:"Images",permalink:"/docs/guides-references/hauler-content/images"}},l={},u=[];function a(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,o.jsx)(t.p,{children:"Hauler Community Collections are pending a future release!"})}function m(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(a,{...e})}):a(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>c,x:()=>r});var o=n(6540);const i={},s=o.createContext(i);function c(e){const t=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),o.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4832a47a.83751758.js b/assets/js/4832a47a.83751758.js deleted file mode 100644 index 6b4b8ffe3..000000000 --- a/assets/js/4832a47a.83751758.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7795],{5477:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>l,contentTitle:()=>c,default:()=>m,frontMatter:()=>i,metadata:()=>r,toc:()=>u});var n=t(4848),s=t(8453);const i={title:"Hauler Community Collections",description:"Hauler Community Collections Documentation",sidebar_label:"Community Collections"},c=void 0,r={id:"guides-references/hauler-collections/community-collections",title:"Hauler Community Collections",description:"Hauler Community Collections Documentation",source:"@site/versioned_docs/version-1.0.x/guides-references/hauler-collections/community-collections.md",sourceDirName:"guides-references/hauler-collections",slug:"/guides-references/hauler-collections/community-collections",permalink:"/hauler-docs/docs/guides-references/hauler-collections/community-collections",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/hauler-collections/community-collections.md",tags:[],version:"1.0.x",frontMatter:{title:"Hauler Community Collections",description:"Hauler Community Collections Documentation",sidebar_label:"Community Collections"},sidebar:"haulerSidebar",previous:{title:"Hauler Manifests",permalink:"/hauler-docs/docs/guides-references/manifests"},next:{title:"Images",permalink:"/hauler-docs/docs/guides-references/hauler-content/images"}},l={},u=[];function a(e){const o={p:"p",...(0,s.R)(),...e.components};return(0,n.jsx)(o.p,{children:"Hauler Community Collections are pending a future release!"})}function m(e={}){const{wrapper:o}={...(0,s.R)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},8453:(e,o,t)=>{t.d(o,{R:()=>c,x:()=>r});var n=t(6540);const s={},i=n.createContext(s);function c(e){const o=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function r(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),n.createElement(i.Provider,{value:o},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4996a385.30cfecc5.js b/assets/js/4996a385.30cfecc5.js deleted file mode 100644 index efd736341..000000000 --- a/assets/js/4996a385.30cfecc5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9902],{2665:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>t,toc:()=>c});var o=l(4848),s=l(8453);const r={title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},i=void 0,t={id:"guides-references/command-line/hauler-completion",title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",source:"@site/versioned_docs/version-1.0.x/guides-references/command-line/hauler-completion.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-completion",permalink:"/hauler-docs/docs/guides-references/command-line/hauler-completion",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/command-line/hauler-completion.md",tags:[],version:"1.0.x",frontMatter:{title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},sidebar:"haulerSidebar",previous:{title:"Hauler Store",permalink:"/hauler-docs/docs/guides-references/command-line/hauler-store"},next:{title:"Hauler Version",permalink:"/hauler-docs/docs/guides-references/command-line/hauler-version"}},a={},c=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler completion bash:",id:"hauler-completion-bash",level:4},{value:"hauler completion fish:",id:"hauler-completion-fish",level:4},{value:"hauler completion powershell:",id:"hauler-completion-powershell",level:4},{value:"hauler completion zsh:",id:"hauler-completion-zsh",level:4}];function h(e){const n={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate an autocompletion script for hauler for the specified shell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler completion [command]\n\nAvailable Commands:\n bash Generates bash completion scripts\n fish Generates fish completion scripts\n powershell Generates powershell completion scripts\n zsh Generates zsh completion scripts\n\nFlags:\n -h, --help help for completion\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler completion [command] --help" for more information about a command.\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-bash",children:[(0,o.jsx)(n.code,{children:"hauler completion bash"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Generate the autocompletion script for the bash shell.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Note:"})," This script depends on the 'bash-completion' package."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion bash)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion bash > /etc/bash_completion.d/hauler\n\n#### macOS:\n\n hauler completion bash > $(brew --prefix)/etc/bash_completion.d/hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion bash\n\nFlags:\n -h, --help help for bash\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-fish",children:[(0,o.jsx)(n.code,{children:"hauler completion fish"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate the autocompletion script for the fish shell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion fish | source\n\nTo load completions for every new session, execute once:\n\n hauler completion fish > ~/.config/fish/completions/hauler.fish\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion fish [flags]\n\nFlags:\n -h, --help help for fish\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-powershell",children:[(0,o.jsx)(n.code,{children:"hauler completion powershell"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate the autocompletion script for powershell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion powershell | Out-String | Invoke-Expression\n\nTo load completions for every new session, add the output of the above command\nto your powershell profile.\n\nUsage:\n hauler completion powershell [flags]\n\nFlags:\n -h, --help help for powershell\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-zsh",children:[(0,o.jsx)(n.code,{children:"hauler completion zsh"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Generate the autocompletion script for the zsh shell.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Note:"})," If shell completion is not already enabled in your environment you will need to enable it."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion zsh)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion zsh > "${fpath[1]}/_hauler"\n\n#### macOS:\n\n hauler completion zsh > $(brew --prefix)/share/zsh/site-functions/_hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion zsh [flags]\n\nFlags:\n -h, --help help for zsh\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n'})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},8453:(e,n,l)=>{l.d(n,{R:()=>i,x:()=>t});var o=l(6540);const s={},r=o.createContext(s);function i(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4996a385.bcb68908.js b/assets/js/4996a385.bcb68908.js new file mode 100644 index 000000000..8856c8c9a --- /dev/null +++ b/assets/js/4996a385.bcb68908.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9902],{2665:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>t,toc:()=>c});var o=l(4848),s=l(8453);const r={title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},i=void 0,t={id:"guides-references/command-line/hauler-completion",title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",source:"@site/versioned_docs/version-1.0.x/guides-references/command-line/hauler-completion.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-completion",permalink:"/docs/guides-references/command-line/hauler-completion",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/command-line/hauler-completion.md",tags:[],version:"1.0.x",frontMatter:{title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},sidebar:"haulerSidebar",previous:{title:"Hauler Store",permalink:"/docs/guides-references/command-line/hauler-store"},next:{title:"Hauler Version",permalink:"/docs/guides-references/command-line/hauler-version"}},a={},c=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler completion bash:",id:"hauler-completion-bash",level:4},{value:"hauler completion fish:",id:"hauler-completion-fish",level:4},{value:"hauler completion powershell:",id:"hauler-completion-powershell",level:4},{value:"hauler completion zsh:",id:"hauler-completion-zsh",level:4}];function h(e){const n={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate an autocompletion script for hauler for the specified shell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler completion [command]\n\nAvailable Commands:\n bash Generates bash completion scripts\n fish Generates fish completion scripts\n powershell Generates powershell completion scripts\n zsh Generates zsh completion scripts\n\nFlags:\n -h, --help help for completion\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler completion [command] --help" for more information about a command.\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-bash",children:[(0,o.jsx)(n.code,{children:"hauler completion bash"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Generate the autocompletion script for the bash shell.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Note:"})," This script depends on the 'bash-completion' package."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion bash)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion bash > /etc/bash_completion.d/hauler\n\n#### macOS:\n\n hauler completion bash > $(brew --prefix)/etc/bash_completion.d/hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion bash\n\nFlags:\n -h, --help help for bash\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-fish",children:[(0,o.jsx)(n.code,{children:"hauler completion fish"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate the autocompletion script for the fish shell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion fish | source\n\nTo load completions for every new session, execute once:\n\n hauler completion fish > ~/.config/fish/completions/hauler.fish\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion fish [flags]\n\nFlags:\n -h, --help help for fish\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-powershell",children:[(0,o.jsx)(n.code,{children:"hauler completion powershell"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate the autocompletion script for powershell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion powershell | Out-String | Invoke-Expression\n\nTo load completions for every new session, add the output of the above command\nto your powershell profile.\n\nUsage:\n hauler completion powershell [flags]\n\nFlags:\n -h, --help help for powershell\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-zsh",children:[(0,o.jsx)(n.code,{children:"hauler completion zsh"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Generate the autocompletion script for the zsh shell.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Note:"})," If shell completion is not already enabled in your environment you will need to enable it."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion zsh)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion zsh > "${fpath[1]}/_hauler"\n\n#### macOS:\n\n hauler completion zsh > $(brew --prefix)/share/zsh/site-functions/_hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion zsh [flags]\n\nFlags:\n -h, --help help for zsh\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n'})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},8453:(e,n,l)=>{l.d(n,{R:()=>i,x:()=>t});var o=l(6540);const s={},r=o.createContext(s);function i(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/49c5a881.18735327.js b/assets/js/49c5a881.18735327.js deleted file mode 100644 index 7334fa8b1..000000000 --- a/assets/js/49c5a881.18735327.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8236],{721:(n,e,l)=>{l.r(e),l.d(e,{assets:()=>o,contentTitle:()=>s,default:()=>u,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var i=l(4848),t=l(8453);const a={title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},s=void 0,r={id:"introduction/uninstall",title:"Uninstall",description:"Uninstall Documentation for Hauler",source:"@site/docs/introduction/uninstall.md",sourceDirName:"introduction",slug:"/introduction/uninstall",permalink:"/hauler-docs/docs/next/introduction/uninstall",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/docs/introduction/uninstall.md",tags:[],version:"current",frontMatter:{title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},sidebar:"haulerSidebar",previous:{title:"Installation",permalink:"/hauler-docs/docs/next/introduction/install"},next:{title:"Overview",permalink:"/hauler-docs/docs/next/guides-references/overview"}},o={},d=[{value:"Uninstallation Steps",id:"uninstallation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin",level:3},{value:"Homebrew",id:"homebrew",level:3},{value:"Windows",id:"windows",level:3},{value:"Manual Uninstallation Steps",id:"manual-uninstallation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin-1",level:3},{value:"Homebrew",id:"homebrew-1",level:3},{value:"Windows",id:"windows-1",level:3}];function c(n){const e={code:"code",h2:"h2",h3:"h3",pre:"pre",...(0,t.R)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h2,{id:"uninstallation-steps",children:"Uninstallation Steps"}),"\n",(0,i.jsx)(e.h3,{id:"linuxdarwin",children:"Linux/Darwin"}),"\n",(0,i.jsx)(e.pre,{children:(0,i.jsx)(e.code,{className:"language-bash",children:"# uninstall hauler\ncurl -sfL https://get.hauler.dev | HAULER_UNINSTALL=true bash\n"})}),"\n",(0,i.jsx)(e.h3,{id:"homebrew",children:"Homebrew"}),"\n",(0,i.jsx)(e.pre,{children:(0,i.jsx)(e.code,{className:"language-bash",children:"# installs latest release\nbrew uninstall hauler\n"})}),"\n",(0,i.jsx)(e.h3,{id:"windows",children:"Windows"}),"\n",(0,i.jsx)(e.pre,{children:(0,i.jsx)(e.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,i.jsx)(e.h2,{id:"manual-uninstallation-steps",children:"Manual Uninstallation Steps"}),"\n",(0,i.jsx)(e.h3,{id:"linuxdarwin-1",children:"Linux/Darwin"}),"\n",(0,i.jsx)(e.pre,{children:(0,i.jsx)(e.code,{className:"language-bash",children:'# remove the hauler binary\nsudo rm -f /usr/local/bin/hauler\n\n# remove the working/installation directory\nrm -rf "$HOME/.hauler"\n'})}),"\n",(0,i.jsx)(e.h3,{id:"homebrew-1",children:"Homebrew"}),"\n",(0,i.jsx)(e.pre,{children:(0,i.jsx)(e.code,{className:"language-bash",children:"# not applicable\n"})}),"\n",(0,i.jsx)(e.h3,{id:"windows-1",children:"Windows"}),"\n",(0,i.jsx)(e.pre,{children:(0,i.jsx)(e.code,{className:"language-bash",children:"# coming soon\n"})})]})}function u(n={}){const{wrapper:e}={...(0,t.R)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(c,{...n})}):c(n)}},8453:(n,e,l)=>{l.d(e,{R:()=>s,x:()=>r});var i=l(6540);const t={},a=i.createContext(t);function s(n){const e=i.useContext(a);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(t):n.components||t:s(n.components),i.createElement(a.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/49c5a881.65a74c90.js b/assets/js/49c5a881.65a74c90.js new file mode 100644 index 000000000..d36719f49 --- /dev/null +++ b/assets/js/49c5a881.65a74c90.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8236],{721:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>o,contentTitle:()=>s,default:()=>u,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var l=i(4848),t=i(8453);const a={title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},s=void 0,r={id:"introduction/uninstall",title:"Uninstall",description:"Uninstall Documentation for Hauler",source:"@site/docs/introduction/uninstall.md",sourceDirName:"introduction",slug:"/introduction/uninstall",permalink:"/docs/next/introduction/uninstall",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/docs/introduction/uninstall.md",tags:[],version:"current",frontMatter:{title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},sidebar:"haulerSidebar",previous:{title:"Installation",permalink:"/docs/next/introduction/install"},next:{title:"Overview",permalink:"/docs/next/guides-references/overview"}},o={},d=[{value:"Uninstallation Steps",id:"uninstallation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin",level:3},{value:"Homebrew",id:"homebrew",level:3},{value:"Windows",id:"windows",level:3},{value:"Manual Uninstallation Steps",id:"manual-uninstallation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin-1",level:3},{value:"Homebrew",id:"homebrew-1",level:3},{value:"Windows",id:"windows-1",level:3}];function c(n){const e={code:"code",h2:"h2",h3:"h3",pre:"pre",...(0,t.R)(),...n.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(e.h2,{id:"uninstallation-steps",children:"Uninstallation Steps"}),"\n",(0,l.jsx)(e.h3,{id:"linuxdarwin",children:"Linux/Darwin"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:"# uninstall hauler\ncurl -sfL https://get.hauler.dev | HAULER_UNINSTALL=true bash\n"})}),"\n",(0,l.jsx)(e.h3,{id:"homebrew",children:"Homebrew"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:"# installs latest release\nbrew uninstall hauler\n"})}),"\n",(0,l.jsx)(e.h3,{id:"windows",children:"Windows"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,l.jsx)(e.h2,{id:"manual-uninstallation-steps",children:"Manual Uninstallation Steps"}),"\n",(0,l.jsx)(e.h3,{id:"linuxdarwin-1",children:"Linux/Darwin"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:'# remove the hauler binary\nsudo rm -f /usr/local/bin/hauler\n\n# remove the working/installation directory\nrm -rf "$HOME/.hauler"\n'})}),"\n",(0,l.jsx)(e.h3,{id:"homebrew-1",children:"Homebrew"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:"# not applicable\n"})}),"\n",(0,l.jsx)(e.h3,{id:"windows-1",children:"Windows"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:"# coming soon\n"})})]})}function u(n={}){const{wrapper:e}={...(0,t.R)(),...n.components};return e?(0,l.jsx)(e,{...n,children:(0,l.jsx)(c,{...n})}):c(n)}},8453:(n,e,i)=>{i.d(e,{R:()=>s,x:()=>r});var l=i(6540);const t={},a=l.createContext(t);function s(n){const e=l.useContext(a);return l.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(t):n.components||t:s(n.components),l.createElement(a.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/4a727ec9.a17ccbd7.js b/assets/js/4a727ec9.a17ccbd7.js deleted file mode 100644 index 8d72a2c19..000000000 --- a/assets/js/4a727ec9.a17ccbd7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1081],{5611:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>t,toc:()=>c});var o=l(4848),s=l(8453);const r={title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},i=void 0,t={id:"guides-references/command-line/hauler-completion",title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",source:"@site/versioned_docs/version-0.4.3/guides-references/command-line/hauler-completion.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-completion",permalink:"/hauler-docs/docs/0.4.3/guides-references/command-line/hauler-completion",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.3/guides-references/command-line/hauler-completion.md",tags:[],version:"0.4.3",frontMatter:{title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},sidebar:"haulerSidebar",previous:{title:"Hauler Store",permalink:"/hauler-docs/docs/0.4.3/guides-references/command-line/hauler-store"},next:{title:"Hauler Version",permalink:"/hauler-docs/docs/0.4.3/guides-references/command-line/hauler-version"}},a={},c=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler completion bash:",id:"hauler-completion-bash",level:4},{value:"hauler completion fish:",id:"hauler-completion-fish",level:4},{value:"hauler completion powershell:",id:"hauler-completion-powershell",level:4},{value:"hauler completion zsh:",id:"hauler-completion-zsh",level:4}];function h(e){const n={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate an autocompletion script for hauler for the specified shell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler completion [command]\n\nAvailable Commands:\n bash Generates bash completion scripts\n fish Generates fish completion scripts\n powershell Generates powershell completion scripts\n zsh Generates zsh completion scripts\n\nFlags:\n -h, --help help for completion\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler completion [command] --help" for more information about a command.\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-bash",children:[(0,o.jsx)(n.code,{children:"hauler completion bash"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Generate the autocompletion script for the bash shell.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Note:"})," This script depends on the 'bash-completion' package."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion bash)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion bash > /etc/bash_completion.d/hauler\n\n#### macOS:\n\n hauler completion bash > $(brew --prefix)/etc/bash_completion.d/hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion bash\n\nFlags:\n -h, --help help for bash\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-fish",children:[(0,o.jsx)(n.code,{children:"hauler completion fish"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate the autocompletion script for the fish shell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion fish | source\n\nTo load completions for every new session, execute once:\n\n hauler completion fish > ~/.config/fish/completions/hauler.fish\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion fish [flags]\n\nFlags:\n -h, --help help for fish\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-powershell",children:[(0,o.jsx)(n.code,{children:"hauler completion powershell"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate the autocompletion script for powershell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion powershell | Out-String | Invoke-Expression\n\nTo load completions for every new session, add the output of the above command\nto your powershell profile.\n\nUsage:\n hauler completion powershell [flags]\n\nFlags:\n -h, --help help for powershell\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-zsh",children:[(0,o.jsx)(n.code,{children:"hauler completion zsh"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Generate the autocompletion script for the zsh shell.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Note:"})," If shell completion is not already enabled in your environment you will need to enable it."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion zsh)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion zsh > "${fpath[1]}/_hauler"\n\n#### macOS:\n\n hauler completion zsh > $(brew --prefix)/share/zsh/site-functions/_hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion zsh [flags]\n\nFlags:\n -h, --help help for zsh\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n'})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},8453:(e,n,l)=>{l.d(n,{R:()=>i,x:()=>t});var o=l(6540);const s={},r=o.createContext(s);function i(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4a727ec9.b2292910.js b/assets/js/4a727ec9.b2292910.js new file mode 100644 index 000000000..334082896 --- /dev/null +++ b/assets/js/4a727ec9.b2292910.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1081],{5611:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>t,toc:()=>c});var o=l(4848),s=l(8453);const r={title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},i=void 0,t={id:"guides-references/command-line/hauler-completion",title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",source:"@site/versioned_docs/version-0.4.3/guides-references/command-line/hauler-completion.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-completion",permalink:"/docs/0.4.3/guides-references/command-line/hauler-completion",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.3/guides-references/command-line/hauler-completion.md",tags:[],version:"0.4.3",frontMatter:{title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},sidebar:"haulerSidebar",previous:{title:"Hauler Store",permalink:"/docs/0.4.3/guides-references/command-line/hauler-store"},next:{title:"Hauler Version",permalink:"/docs/0.4.3/guides-references/command-line/hauler-version"}},a={},c=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler completion bash:",id:"hauler-completion-bash",level:4},{value:"hauler completion fish:",id:"hauler-completion-fish",level:4},{value:"hauler completion powershell:",id:"hauler-completion-powershell",level:4},{value:"hauler completion zsh:",id:"hauler-completion-zsh",level:4}];function h(e){const n={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate an autocompletion script for hauler for the specified shell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler completion [command]\n\nAvailable Commands:\n bash Generates bash completion scripts\n fish Generates fish completion scripts\n powershell Generates powershell completion scripts\n zsh Generates zsh completion scripts\n\nFlags:\n -h, --help help for completion\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler completion [command] --help" for more information about a command.\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-bash",children:[(0,o.jsx)(n.code,{children:"hauler completion bash"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Generate the autocompletion script for the bash shell.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Note:"})," This script depends on the 'bash-completion' package."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion bash)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion bash > /etc/bash_completion.d/hauler\n\n#### macOS:\n\n hauler completion bash > $(brew --prefix)/etc/bash_completion.d/hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion bash\n\nFlags:\n -h, --help help for bash\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-fish",children:[(0,o.jsx)(n.code,{children:"hauler completion fish"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate the autocompletion script for the fish shell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion fish | source\n\nTo load completions for every new session, execute once:\n\n hauler completion fish > ~/.config/fish/completions/hauler.fish\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion fish [flags]\n\nFlags:\n -h, --help help for fish\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-powershell",children:[(0,o.jsx)(n.code,{children:"hauler completion powershell"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate the autocompletion script for powershell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion powershell | Out-String | Invoke-Expression\n\nTo load completions for every new session, add the output of the above command\nto your powershell profile.\n\nUsage:\n hauler completion powershell [flags]\n\nFlags:\n -h, --help help for powershell\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-zsh",children:[(0,o.jsx)(n.code,{children:"hauler completion zsh"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Generate the autocompletion script for the zsh shell.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Note:"})," If shell completion is not already enabled in your environment you will need to enable it."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion zsh)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion zsh > "${fpath[1]}/_hauler"\n\n#### macOS:\n\n hauler completion zsh > $(brew --prefix)/share/zsh/site-functions/_hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion zsh [flags]\n\nFlags:\n -h, --help help for zsh\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n'})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},8453:(e,n,l)=>{l.d(n,{R:()=>i,x:()=>t});var o=l(6540);const s={},r=o.createContext(s);function i(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4a8152f5.b702abc8.js b/assets/js/4a8152f5.b702abc8.js new file mode 100644 index 000000000..b6f1821ee --- /dev/null +++ b/assets/js/4a8152f5.b702abc8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2217],{2673:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>l,toc:()=>a});var r=n(4848),s=n(8453);const o={title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',sidebar_label:"Files"},i=void 0,l={id:"guides-references/hauler-content/files",title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',source:"@site/versioned_docs/version-0.4.3/guides-references/hauler-content/files.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/files",permalink:"/docs/0.4.3/guides-references/hauler-content/files",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.3/guides-references/hauler-content/files.md",tags:[],version:"0.4.3",frontMatter:{title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',sidebar_label:"Files"},sidebar:"haulerSidebar",previous:{title:"Charts",permalink:"/docs/0.4.3/guides-references/hauler-content/charts"},next:{title:"Hauler",permalink:"/docs/0.4.3/guides-references/command-line/hauler"}},c={},a=[];function u(e){const t={code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.p,{children:"Generic content that can be represented as a file, either sourced locally or remotely:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-yaml",children:"# local file\nhauler store add file path/to/local/file.txt\n\n# remote file with name\nhauler store add file https://get.rke2.io --name install.sh\n"})})]})}function d(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>l});var r=n(6540);const s={},o=r.createContext(s);function i(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4a8152f5.cd7ed0db.js b/assets/js/4a8152f5.cd7ed0db.js deleted file mode 100644 index 5a80e28f9..000000000 --- a/assets/js/4a8152f5.cd7ed0db.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2217],{2673:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>l,toc:()=>a});var r=n(4848),s=n(8453);const o={title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',sidebar_label:"Files"},i=void 0,l={id:"guides-references/hauler-content/files",title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',source:"@site/versioned_docs/version-0.4.3/guides-references/hauler-content/files.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/files",permalink:"/hauler-docs/docs/0.4.3/guides-references/hauler-content/files",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.3/guides-references/hauler-content/files.md",tags:[],version:"0.4.3",frontMatter:{title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',sidebar_label:"Files"},sidebar:"haulerSidebar",previous:{title:"Charts",permalink:"/hauler-docs/docs/0.4.3/guides-references/hauler-content/charts"},next:{title:"Hauler",permalink:"/hauler-docs/docs/0.4.3/guides-references/command-line/hauler"}},c={},a=[];function u(e){const t={code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.p,{children:"Generic content that can be represented as a file, either sourced locally or remotely:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-yaml",children:"# local file\nhauler store add file path/to/local/file.txt\n\n# remote file with name\nhauler store add file https://get.rke2.io --name install.sh\n"})})]})}function d(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>l});var r=n(6540);const s={},o=r.createContext(s);function i(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4aedc38e.2db335ed.js b/assets/js/4aedc38e.2db335ed.js new file mode 100644 index 000000000..ee67eec40 --- /dev/null +++ b/assets/js/4aedc38e.2db335ed.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2186],{6167:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>a});var r=n(4848),o=n(8453);const i={title:"Overview of Hauler Content",description:"Hauler Content Documentation",sidebar_label:"Overview"},s=void 0,c={id:"guides-references/hauler-content/overview",title:"Overview of Hauler Content",description:"Hauler Content Documentation",source:"@site/versioned_docs/version-0.4.3/guides-references/hauler-content/overview.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/overview",permalink:"/docs/0.4.3/guides-references/hauler-content/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.3/guides-references/hauler-content/overview.md",tags:[],version:"0.4.3",frontMatter:{title:"Overview of Hauler Content",description:"Hauler Content Documentation",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/docs/0.4.3/guides-references/hauler-collections/overview"},next:{title:"Images",permalink:"/docs/0.4.3/guides-references/hauler-content/images"}},u={},a=[];function l(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,r.jsx)(t.p,{children:"Hauler Content Overview Documentation pending a future release!"})}function d(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>c});var r=n(6540);const o={},i=r.createContext(o);function s(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4aedc38e.c7ede552.js b/assets/js/4aedc38e.c7ede552.js deleted file mode 100644 index 49c07eed5..000000000 --- a/assets/js/4aedc38e.c7ede552.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2186],{6167:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>u});var r=n(4848),o=n(8453);const i={title:"Overview of Hauler Content",description:"Hauler Content Documentation",sidebar_label:"Overview"},s=void 0,c={id:"guides-references/hauler-content/overview",title:"Overview of Hauler Content",description:"Hauler Content Documentation",source:"@site/versioned_docs/version-0.4.3/guides-references/hauler-content/overview.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/overview",permalink:"/hauler-docs/docs/0.4.3/guides-references/hauler-content/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.3/guides-references/hauler-content/overview.md",tags:[],version:"0.4.3",frontMatter:{title:"Overview of Hauler Content",description:"Hauler Content Documentation",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/hauler-docs/docs/0.4.3/guides-references/hauler-collections/overview"},next:{title:"Images",permalink:"/hauler-docs/docs/0.4.3/guides-references/hauler-content/images"}},a={},u=[];function l(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,r.jsx)(t.p,{children:"Hauler Content Overview Documentation pending a future release!"})}function d(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>c});var r=n(6540);const o={},i=r.createContext(o);function s(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4b93f48b.403b7ec8.js b/assets/js/4b93f48b.403b7ec8.js new file mode 100644 index 000000000..3117c39c4 --- /dev/null +++ b/assets/js/4b93f48b.403b7ec8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2669],{4733:(n,t,e)=>{e.r(t),e.d(t,{assets:()=>a,contentTitle:()=>s,default:()=>d,frontMatter:()=>r,metadata:()=>l,toc:()=>c});var i=e(4848),o=e(8453);const r={title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},s=void 0,l={id:"introduction/uninstall",title:"Uninstall",description:"Uninstall Documentation for Hauler",source:"@site/versioned_docs/version-0.4.4/introduction/uninstall.md",sourceDirName:"introduction",slug:"/introduction/uninstall",permalink:"/docs/0.4.4/introduction/uninstall",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.4/introduction/uninstall.md",tags:[],version:"0.4.4",frontMatter:{title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},sidebar:"haulerSidebar",previous:{title:"Installation",permalink:"/docs/0.4.4/introduction/install"},next:{title:"Overview",permalink:"/docs/0.4.4/guides-references/overview"}},a={},c=[];function u(n){const t={p:"p",...(0,o.R)(),...n.components};return(0,i.jsx)(t.p,{children:"Uninstall Documentation pending a future release!"})}function d(n={}){const{wrapper:t}={...(0,o.R)(),...n.components};return t?(0,i.jsx)(t,{...n,children:(0,i.jsx)(u,{...n})}):u(n)}},8453:(n,t,e)=>{e.d(t,{R:()=>s,x:()=>l});var i=e(6540);const o={},r=i.createContext(o);function s(n){const t=i.useContext(r);return i.useMemo((function(){return"function"==typeof n?n(t):{...t,...n}}),[t,n])}function l(n){let t;return t=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:s(n.components),i.createElement(r.Provider,{value:t},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/4b93f48b.a488a0a9.js b/assets/js/4b93f48b.a488a0a9.js deleted file mode 100644 index 9f07f3ada..000000000 --- a/assets/js/4b93f48b.a488a0a9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2669],{4733:(n,t,e)=>{e.r(t),e.d(t,{assets:()=>a,contentTitle:()=>s,default:()=>d,frontMatter:()=>r,metadata:()=>l,toc:()=>c});var o=e(4848),i=e(8453);const r={title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},s=void 0,l={id:"introduction/uninstall",title:"Uninstall",description:"Uninstall Documentation for Hauler",source:"@site/versioned_docs/version-0.4.4/introduction/uninstall.md",sourceDirName:"introduction",slug:"/introduction/uninstall",permalink:"/hauler-docs/docs/0.4.4/introduction/uninstall",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.4/introduction/uninstall.md",tags:[],version:"0.4.4",frontMatter:{title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},sidebar:"haulerSidebar",previous:{title:"Installation",permalink:"/hauler-docs/docs/0.4.4/introduction/install"},next:{title:"Overview",permalink:"/hauler-docs/docs/0.4.4/guides-references/overview"}},a={},c=[];function u(n){const t={p:"p",...(0,i.R)(),...n.components};return(0,o.jsx)(t.p,{children:"Uninstall Documentation pending a future release!"})}function d(n={}){const{wrapper:t}={...(0,i.R)(),...n.components};return t?(0,o.jsx)(t,{...n,children:(0,o.jsx)(u,{...n})}):u(n)}},8453:(n,t,e)=>{e.d(t,{R:()=>s,x:()=>l});var o=e(6540);const i={},r=o.createContext(i);function s(n){const t=o.useContext(r);return o.useMemo((function(){return"function"==typeof n?n(t):{...t,...n}}),[t,n])}function l(n){let t;return t=n.disableParentContext?"function"==typeof n.components?n.components(i):n.components||i:s(n.components),o.createElement(r.Provider,{value:t},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/4b9ecfb3.aeb3fe60.js b/assets/js/4b9ecfb3.aeb3fe60.js new file mode 100644 index 000000000..41eff6032 --- /dev/null +++ b/assets/js/4b9ecfb3.aeb3fe60.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[557],{7569:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>l});var r=t(4848),s=t(8453);const i={title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},o="Rancher Government Hauler",a={id:"intro",title:"Introduction",description:"Introduction to Rancher Government Hauler",source:"@site/versioned_docs/version-0.4.3/intro.md",sourceDirName:".",slug:"/intro",permalink:"/docs/0.4.3/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.3/intro.md",tags:[],version:"0.4.3",frontMatter:{title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},sidebar:"haulerSidebar",next:{title:"Core Concepts",permalink:"/docs/0.4.3/core-concepts"}},c={},l=[{value:"What's Hauler?",id:"whats-hauler",level:2},{value:"Acknowledgements",id:"acknowledgements",level:2}];function d(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"rancher-government-hauler",children:"Rancher Government Hauler"}),"\n",(0,r.jsx)(n.h1,{id:"airgap-swiss-army-knife",children:"Airgap Swiss Army Knife"}),"\n",(0,r.jsxs)(n.admonition,{type:"caution",children:[(0,r.jsx)(n.p,{children:(0,r.jsxs)(n.strong,{children:["Note: Hauler and it's documentation are in active development and ",(0,r.jsx)(n.em,{children:"not Generally Available (GA)"}),"."]})}),(0,r.jsxs)(n.p,{children:["Most of the core functionality and features are ready for use, but may have breaking changes in future releases. Please help us by submitting any issues via ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler-docs/issues",children:"GitHub Issues"})})," and make sure to review the ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"/docs/known-limits",children:"Known Issues and Limitations"})}),"!"]})]}),"\n",(0,r.jsx)(n.h2,{id:"whats-hauler",children:"What's Hauler?"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Rancher Government Hauler"})," simplifies the airgap experience without requiring users to adopt a specific workflow. ",(0,r.jsx)(n.code,{children:"Hauler"})," simplifies the airgapping process, by representing assets (images, charts, files, etc...) as content and collections to allow users to easily fetch, store, package, and distribute these assets with declarative manifests or through the command line."]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Hauler"})," does this by storing contents and collections as OCI Artifacts and allows users to serve contents and collections with an embedded registry and fileserver. Additionally, ",(0,r.jsx)(n.code,{children:"Hauler"})," has the ability to store and inspect various non-image OCI Artifacts."]}),"\n",(0,r.jsx)(n.h2,{id:"acknowledgements",children:"Acknowledgements"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Hauler"})," wouldn't be possible without the open-source community, but there are a few projects that stand out:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/google/go-containerregistry",children:"go-containerregistry"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/oras-project/oras",children:"oras cli"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/sigstore/cosign",children:"cosign"})}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var r=t(6540);const s={},i=r.createContext(s);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4b9ecfb3.cd4a8037.js b/assets/js/4b9ecfb3.cd4a8037.js deleted file mode 100644 index 1724d4e69..000000000 --- a/assets/js/4b9ecfb3.cd4a8037.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[557],{7569:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>l});var r=t(4848),s=t(8453);const i={title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},o="Rancher Government Hauler",a={id:"intro",title:"Introduction",description:"Introduction to Rancher Government Hauler",source:"@site/versioned_docs/version-0.4.3/intro.md",sourceDirName:".",slug:"/intro",permalink:"/hauler-docs/docs/0.4.3/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.3/intro.md",tags:[],version:"0.4.3",frontMatter:{title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},sidebar:"haulerSidebar",next:{title:"Core Concepts",permalink:"/hauler-docs/docs/0.4.3/core-concepts"}},c={},l=[{value:"What's Hauler?",id:"whats-hauler",level:2},{value:"Acknowledgements",id:"acknowledgements",level:2}];function d(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"rancher-government-hauler",children:"Rancher Government Hauler"}),"\n",(0,r.jsx)(n.h1,{id:"airgap-swiss-army-knife",children:"Airgap Swiss Army Knife"}),"\n",(0,r.jsxs)(n.admonition,{type:"caution",children:[(0,r.jsx)(n.p,{children:(0,r.jsxs)(n.strong,{children:["Note: Hauler and it's documentation are in active development and ",(0,r.jsx)(n.em,{children:"not Generally Available (GA)"}),"."]})}),(0,r.jsxs)(n.p,{children:["Most of the core functionality and features are ready for use, but may have breaking changes in future releases. Please help us by submitting any issues via ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler-docs/issues",children:"GitHub Issues"})})," and make sure to review the ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"/docs/known-limits",children:"Known Issues and Limitations"})}),"!"]})]}),"\n",(0,r.jsx)(n.h2,{id:"whats-hauler",children:"What's Hauler?"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Rancher Government Hauler"})," simplifies the airgap experience without requiring users to adopt a specific workflow. ",(0,r.jsx)(n.code,{children:"Hauler"})," simplifies the airgapping process, by representing assets (images, charts, files, etc...) as content and collections to allow users to easily fetch, store, package, and distribute these assets with declarative manifests or through the command line."]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Hauler"})," does this by storing contents and collections as OCI Artifacts and allows users to serve contents and collections with an embedded registry and fileserver. Additionally, ",(0,r.jsx)(n.code,{children:"Hauler"})," has the ability to store and inspect various non-image OCI Artifacts."]}),"\n",(0,r.jsx)(n.h2,{id:"acknowledgements",children:"Acknowledgements"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Hauler"})," wouldn't be possible without the open-source community, but there are a few projects that stand out:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/google/go-containerregistry",children:"go-containerregistry"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/oras-project/oras",children:"oras cli"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/sigstore/cosign",children:"cosign"})}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var r=t(6540);const s={},i=r.createContext(s);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4c3097c2.727e4bc2.js b/assets/js/4c3097c2.727e4bc2.js new file mode 100644 index 000000000..b6d9cc2c4 --- /dev/null +++ b/assets/js/4c3097c2.727e4bc2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4130],{5308:(e,r,o)=>{o.r(r),o.d(r,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>u});var t=o(4848),n=o(8453);const i={title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",sidebar_label:"Overview"},s=void 0,c={id:"guides-references/hauler-collections/overview",title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",source:"@site/versioned_docs/version-0.4.2/guides-references/hauler-collections/overview.md",sourceDirName:"guides-references/hauler-collections",slug:"/guides-references/hauler-collections/overview",permalink:"/docs/0.4.2/guides-references/hauler-collections/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.2/guides-references/hauler-collections/overview.md",tags:[],version:"0.4.2",frontMatter:{title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"RGS Carbide Customers",permalink:"/docs/0.4.2/guides-references/carbide-customers"},next:{title:"Overview",permalink:"/docs/0.4.2/guides-references/hauler-content/overview"}},l={},u=[];function a(e){const r={p:"p",...(0,n.R)(),...e.components};return(0,t.jsx)(r.p,{children:"Hauler Collections Overview Documentation pending a future release!"})}function d(e={}){const{wrapper:r}={...(0,n.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},8453:(e,r,o)=>{o.d(r,{R:()=>s,x:()=>c});var t=o(6540);const n={},i=t.createContext(n);function s(e){const r=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:s(e.components),t.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4c3097c2.c3f27054.js b/assets/js/4c3097c2.c3f27054.js deleted file mode 100644 index 35aa1c15f..000000000 --- a/assets/js/4c3097c2.c3f27054.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4130],{5308:(e,r,o)=>{o.r(r),o.d(r,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>s,metadata:()=>c,toc:()=>u});var t=o(4848),n=o(8453);const s={title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",sidebar_label:"Overview"},i=void 0,c={id:"guides-references/hauler-collections/overview",title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",source:"@site/versioned_docs/version-0.4.2/guides-references/hauler-collections/overview.md",sourceDirName:"guides-references/hauler-collections",slug:"/guides-references/hauler-collections/overview",permalink:"/hauler-docs/docs/0.4.2/guides-references/hauler-collections/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.2/guides-references/hauler-collections/overview.md",tags:[],version:"0.4.2",frontMatter:{title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"RGS Carbide Customers",permalink:"/hauler-docs/docs/0.4.2/guides-references/carbide-customers"},next:{title:"Overview",permalink:"/hauler-docs/docs/0.4.2/guides-references/hauler-content/overview"}},l={},u=[];function a(e){const r={p:"p",...(0,n.R)(),...e.components};return(0,t.jsx)(r.p,{children:"Hauler Collections Overview Documentation pending a future release!"})}function d(e={}){const{wrapper:r}={...(0,n.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},8453:(e,r,o)=>{o.d(r,{R:()=>i,x:()=>c});var t=o(6540);const n={},s=t.createContext(n);function i(e){const r=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),t.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4c39d837.6c043fce.js b/assets/js/4c39d837.6c043fce.js deleted file mode 100644 index ab315cbd3..000000000 --- a/assets/js/4c39d837.6c043fce.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[570],{6002:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"0.4.2","label":"0.4.2","banner":"unmaintained","badge":true,"noIndex":false,"className":"docs-version-0.4.2","isLast":false,"docsSidebars":{"haulerSidebar":[{"type":"link","label":"Introduction","href":"/hauler-docs/docs/0.4.2/intro","docId":"intro","unlisted":false},{"type":"link","label":"Core Concepts","href":"/hauler-docs/docs/0.4.2/core-concepts","docId":"core-concepts","unlisted":false},{"type":"link","label":"Airgap Workflow","href":"/hauler-docs/docs/0.4.2/airgap-workflow","docId":"airgap-workflow","unlisted":false},{"type":"category","label":"Introduction","description":"Introduction Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Quickstart","href":"/hauler-docs/docs/0.4.2/introduction/quickstart","docId":"introduction/quickstart","unlisted":false},{"type":"link","label":"Installation","href":"/hauler-docs/docs/0.4.2/introduction/install","docId":"introduction/install","unlisted":false},{"type":"link","label":"Uninstall","href":"/hauler-docs/docs/0.4.2/introduction/uninstall","docId":"introduction/uninstall","unlisted":false}],"collapsible":true},{"type":"category","label":"Guides & References","description":"Guides and References Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Overview","href":"/hauler-docs/docs/0.4.2/guides-references/overview","docId":"guides-references/overview","unlisted":false},{"type":"link","label":"Fetch Cluster Images","href":"/hauler-docs/docs/0.4.2/guides-references/cluster-images","docId":"guides-references/cluster-images","unlisted":false},{"type":"link","label":"RGS Carbide Customers","href":"/hauler-docs/docs/0.4.2/guides-references/carbide-customers","docId":"guides-references/carbide-customers","unlisted":false},{"type":"category","label":"Hauler Collections","description":"Guides and References for Hauler Collections","items":[{"type":"link","label":"Overview","href":"/hauler-docs/docs/0.4.2/guides-references/hauler-collections/overview","docId":"guides-references/hauler-collections/overview","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Hauler Content","description":"Guides and References for Hauler Content Types","items":[{"type":"link","label":"Overview","href":"/hauler-docs/docs/0.4.2/guides-references/hauler-content/overview","docId":"guides-references/hauler-content/overview","unlisted":false},{"type":"link","label":"Images","href":"/hauler-docs/docs/0.4.2/guides-references/hauler-content/images","docId":"guides-references/hauler-content/images","unlisted":false},{"type":"link","label":"Charts","href":"/hauler-docs/docs/0.4.2/guides-references/hauler-content/charts","docId":"guides-references/hauler-content/charts","unlisted":false},{"type":"link","label":"Files","href":"/hauler-docs/docs/0.4.2/guides-references/hauler-content/files","docId":"guides-references/hauler-content/files","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Command Line Interface","description":"Guides and References for the Hauler Command Line","items":[{"type":"link","label":"Hauler","href":"/hauler-docs/docs/0.4.2/guides-references/command-line/hauler","docId":"guides-references/command-line/hauler","unlisted":false},{"type":"link","label":"Hauler Store","href":"/hauler-docs/docs/0.4.2/guides-references/command-line/hauler-store","docId":"guides-references/command-line/hauler-store","unlisted":false},{"type":"link","label":"Hauler Completion","href":"/hauler-docs/docs/0.4.2/guides-references/command-line/hauler-completion","docId":"guides-references/command-line/hauler-completion","unlisted":false},{"type":"link","label":"Hauler Version","href":"/hauler-docs/docs/0.4.2/guides-references/command-line/hauler-version","docId":"guides-references/command-line/hauler-version","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true},{"type":"link","label":"Known Issues/Limits","href":"/hauler-docs/docs/0.4.2/known-limits","docId":"known-limits","unlisted":false}]},"docs":{"airgap-workflow":{"id":"airgap-workflow","title":"Airgap Workflow","description":"Airgap Workflow Documentation for Hauler","sidebar":"haulerSidebar"},"core-concepts":{"id":"core-concepts","title":"Core Concepts","description":"Core Concepts Documentation for Hauler","sidebar":"haulerSidebar"},"guides-references/carbide-customers":{"id":"guides-references/carbide-customers","title":"RGS Carbide Customers","description":"RGS Carbide Customers Documentation","sidebar":"haulerSidebar"},"guides-references/cluster-images":{"id":"guides-references/cluster-images","title":"Fetching Cluster Images","description":"Fetching Images on a Cluster Documentation","sidebar":"haulerSidebar"},"guides-references/command-line/hauler":{"id":"guides-references/command-line/hauler","title":"Hauler (Command)","description":"Hauler CLI Reference for hauler","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-completion":{"id":"guides-references/command-line/hauler-completion","title":"Hauler Completion (Command)","description":"Hauler CLI Reference for hauler completion","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-store":{"id":"guides-references/command-line/hauler-store","title":"Hauler Store (Command)","description":"Hauler CLI Reference for hauler store","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-version":{"id":"guides-references/command-line/hauler-version","title":"Hauler Version (Command)","description":"Hauler CLI Reference for hauler version","sidebar":"haulerSidebar"},"guides-references/hauler-collections/overview":{"id":"guides-references/hauler-collections/overview","title":"Overview of Hauler Collections","description":"Hauler Collections Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/charts":{"id":"guides-references/hauler-content/charts","title":"Charts (Content Type)","description":"Hauler \\"Charts\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/files":{"id":"guides-references/hauler-content/files","title":"Files (Content Type)","description":"Hauler \\"Files\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/images":{"id":"guides-references/hauler-content/images","title":"Images (Content Type)","description":"Hauler \\"Images\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/overview":{"id":"guides-references/hauler-content/overview","title":"Overview of Hauler Content","description":"Hauler Content Documentation","sidebar":"haulerSidebar"},"guides-references/overview":{"id":"guides-references/overview","title":"Overview","description":"Reference Guides Overview Documentation for Hauler","sidebar":"haulerSidebar"},"intro":{"id":"intro","title":"Introduction","description":"Introduction to Rancher Government Hauler","sidebar":"haulerSidebar"},"introduction/install":{"id":"introduction/install","title":"Installation","description":"Installation Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/quickstart":{"id":"introduction/quickstart","title":"Quickstart","description":"Quickstart Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/uninstall":{"id":"introduction/uninstall","title":"Uninstall","description":"Uninstall Documentation for Hauler","sidebar":"haulerSidebar"},"known-limits":{"id":"known-limits","title":"Known Issues and Limits","description":"Known Issues and Limitations for Hauler","sidebar":"haulerSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/5180c9e5.8d190343.js b/assets/js/5180c9e5.8d190343.js deleted file mode 100644 index e058c4978..000000000 --- a/assets/js/5180c9e5.8d190343.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7079],{4142:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>i,contentTitle:()=>l,default:()=>u,frontMatter:()=>t,metadata:()=>s,toc:()=>c});var o=r(4848),a=r(8453);const t={title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},l=void 0,s={id:"guides-references/command-line/hauler",title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",source:"@site/versioned_docs/version-0.4.1/guides-references/command-line/hauler.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler",permalink:"/hauler-docs/docs/0.4.1/guides-references/command-line/hauler",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.1/guides-references/command-line/hauler.md",tags:[],version:"0.4.1",frontMatter:{title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},sidebar:"haulerSidebar",previous:{title:"Files",permalink:"/hauler-docs/docs/0.4.1/guides-references/hauler-content/files"},next:{title:"Hauler Store",permalink:"/hauler-docs/docs/0.4.1/guides-references/command-line/hauler-store"}},i={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Interact with Hauler's command line."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler [flags]\n hauler [command]\n\nAvailable Commands:\n completion Generate the autocompletion script for the specified shell\n download Download OCI content from a registry and populate it on disk\n help Help about any command\n serve Run one or more of hauler\'s embedded servers types\n store Interact with hauler\'s embedded content store\n version Print the current version\n\nFlags:\n -h, --help help for hauler\n -l, --log-level string (default "info")\n\nUse "hauler [command] --help" for more information about a command.\n'})})]})}function u(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>s});var o=r(6540);const a={},t=o.createContext(a);function l(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:l(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5180c9e5.8d1f2601.js b/assets/js/5180c9e5.8d1f2601.js new file mode 100644 index 000000000..aab177551 --- /dev/null +++ b/assets/js/5180c9e5.8d1f2601.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7079],{4142:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>i,contentTitle:()=>l,default:()=>u,frontMatter:()=>a,metadata:()=>s,toc:()=>c});var o=r(4848),t=r(8453);const a={title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},l=void 0,s={id:"guides-references/command-line/hauler",title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",source:"@site/versioned_docs/version-0.4.1/guides-references/command-line/hauler.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler",permalink:"/docs/0.4.1/guides-references/command-line/hauler",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.1/guides-references/command-line/hauler.md",tags:[],version:"0.4.1",frontMatter:{title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},sidebar:"haulerSidebar",previous:{title:"Files",permalink:"/docs/0.4.1/guides-references/hauler-content/files"},next:{title:"Hauler Store",permalink:"/docs/0.4.1/guides-references/command-line/hauler-store"}},i={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Interact with Hauler's command line."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler [flags]\n hauler [command]\n\nAvailable Commands:\n completion Generate the autocompletion script for the specified shell\n download Download OCI content from a registry and populate it on disk\n help Help about any command\n serve Run one or more of hauler\'s embedded servers types\n store Interact with hauler\'s embedded content store\n version Print the current version\n\nFlags:\n -h, --help help for hauler\n -l, --log-level string (default "info")\n\nUse "hauler [command] --help" for more information about a command.\n'})})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>s});var o=r(6540);const t={},a=o.createContext(t);function l(e){const n=o.useContext(a);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),o.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/52604abb.98beda2d.js b/assets/js/52604abb.98beda2d.js deleted file mode 100644 index b1443c3e6..000000000 --- a/assets/js/52604abb.98beda2d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[421],{7095:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>o,contentTitle:()=>s,default:()=>f,frontMatter:()=>i,metadata:()=>r,toc:()=>c});var t=l(4848),a=l(8453);const i={title:"Hauler Content - Files",description:"Hauler Content - Files Documentation",sidebar_label:"Files"},s=void 0,r={id:"guides-references/hauler-content/files",title:"Hauler Content - Files",description:"Hauler Content - Files Documentation",source:"@site/versioned_docs/version-1.0.0/guides-references/hauler-content/files.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/files",permalink:"/hauler-docs/docs/1.0.0/guides-references/hauler-content/files",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.0/guides-references/hauler-content/files.md",tags:[],version:"1.0.0",frontMatter:{title:"Hauler Content - Files",description:"Hauler Content - Files Documentation",sidebar_label:"Files"},sidebar:"haulerSidebar",previous:{title:"Charts",permalink:"/hauler-docs/docs/1.0.0/guides-references/hauler-content/charts"},next:{title:"Hauler",permalink:"/hauler-docs/docs/1.0.0/guides-references/command-line/hauler"}},o={},c=[{value:"Hauler Command Line for Files",id:"hauler-command-line-for-files",level:2},{value:"Example Commands for Files",id:"example-commands-for-files",level:2},{value:"Hauler Manifest for Files",id:"hauler-manifest-for-files",level:2},{value:"Example Manifest for Files",id:"example-manifest-for-files",level:2}];function d(e){const n={code:"code",h2:"h2",pre:"pre",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"hauler-command-line-for-files",children:"Hauler Command Line for Files"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"hauler store add file --name \n"})}),"\n",(0,t.jsx)(n.h2,{id:"example-commands-for-files",children:"Example Commands for Files"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"# fetch remote file\nhauler store add file https://get.rke2.io\n\n# fetch local file and assign new name\nhauler store add file path/to/local/file.txt --name local-file.txt\n"})}),"\n",(0,t.jsx)(n.h2,{id:"hauler-manifest-for-files",children:"Hauler Manifest for Files"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-file-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n - path: \n name: \n"})}),"\n",(0,t.jsx)(n.h2,{id:"example-manifest-for-files",children:"Example Manifest for Files"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-file-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n # fetch remote file\n - path: https://get.rke2.io\n # fetch remote file and assign new name\n - path: https://get.rke2.io\n name: install.sh\n # fetch local file\n - path: path/to/local/file.txt\n # fetch local file and assign new name\n - path: path/to/local/file.txt\n name: local-file.txt\n"})})]})}function f(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,n,l)=>{l.d(n,{R:()=>s,x:()=>r});var t=l(6540);const a={},i=t.createContext(a);function s(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/52604abb.d5e29187.js b/assets/js/52604abb.d5e29187.js new file mode 100644 index 000000000..44c2ca024 --- /dev/null +++ b/assets/js/52604abb.d5e29187.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[421],{7095:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>o,contentTitle:()=>s,default:()=>f,frontMatter:()=>i,metadata:()=>r,toc:()=>c});var t=l(4848),a=l(8453);const i={title:"Hauler Content - Files",description:"Hauler Content - Files Documentation",sidebar_label:"Files"},s=void 0,r={id:"guides-references/hauler-content/files",title:"Hauler Content - Files",description:"Hauler Content - Files Documentation",source:"@site/versioned_docs/version-1.0.0/guides-references/hauler-content/files.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/files",permalink:"/docs/1.0.0/guides-references/hauler-content/files",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.0/guides-references/hauler-content/files.md",tags:[],version:"1.0.0",frontMatter:{title:"Hauler Content - Files",description:"Hauler Content - Files Documentation",sidebar_label:"Files"},sidebar:"haulerSidebar",previous:{title:"Charts",permalink:"/docs/1.0.0/guides-references/hauler-content/charts"},next:{title:"Hauler",permalink:"/docs/1.0.0/guides-references/command-line/hauler"}},o={},c=[{value:"Hauler Command Line for Files",id:"hauler-command-line-for-files",level:2},{value:"Example Commands for Files",id:"example-commands-for-files",level:2},{value:"Hauler Manifest for Files",id:"hauler-manifest-for-files",level:2},{value:"Example Manifest for Files",id:"example-manifest-for-files",level:2}];function d(e){const n={code:"code",h2:"h2",pre:"pre",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"hauler-command-line-for-files",children:"Hauler Command Line for Files"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"hauler store add file --name \n"})}),"\n",(0,t.jsx)(n.h2,{id:"example-commands-for-files",children:"Example Commands for Files"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"# fetch remote file\nhauler store add file https://get.rke2.io\n\n# fetch local file and assign new name\nhauler store add file path/to/local/file.txt --name local-file.txt\n"})}),"\n",(0,t.jsx)(n.h2,{id:"hauler-manifest-for-files",children:"Hauler Manifest for Files"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-file-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n - path: \n name: \n"})}),"\n",(0,t.jsx)(n.h2,{id:"example-manifest-for-files",children:"Example Manifest for Files"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-file-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n # fetch remote file\n - path: https://get.rke2.io\n # fetch remote file and assign new name\n - path: https://get.rke2.io\n name: install.sh\n # fetch local file\n - path: path/to/local/file.txt\n # fetch local file and assign new name\n - path: path/to/local/file.txt\n name: local-file.txt\n"})})]})}function f(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,n,l)=>{l.d(n,{R:()=>s,x:()=>r});var t=l(6540);const a={},i=t.createContext(a);function s(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/52a6cb34.356b3072.js b/assets/js/52a6cb34.356b3072.js deleted file mode 100644 index 7e152d899..000000000 --- a/assets/js/52a6cb34.356b3072.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[617],{1100:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>l});var r=t(4848),s=t(8453);const i={title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},o="Rancher Government Hauler",a={id:"intro",title:"Introduction",description:"Introduction to Rancher Government Hauler",source:"@site/versioned_docs/version-0.4.4/intro.md",sourceDirName:".",slug:"/intro",permalink:"/hauler-docs/docs/0.4.4/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.4/intro.md",tags:[],version:"0.4.4",frontMatter:{title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},sidebar:"haulerSidebar",next:{title:"Core Concepts",permalink:"/hauler-docs/docs/0.4.4/core-concepts"}},c={},l=[{value:"What's Hauler?",id:"whats-hauler",level:2},{value:"Acknowledgements",id:"acknowledgements",level:2}];function d(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"rancher-government-hauler",children:"Rancher Government Hauler"}),"\n",(0,r.jsx)(n.h1,{id:"airgap-swiss-army-knife",children:"Airgap Swiss Army Knife"}),"\n",(0,r.jsxs)(n.admonition,{type:"caution",children:[(0,r.jsx)(n.p,{children:(0,r.jsxs)(n.strong,{children:["Note: Hauler and the Hauler Documentation are in active development and ",(0,r.jsx)(n.em,{children:"not Generally Available (GA)"}),"."]})}),(0,r.jsxs)(n.p,{children:["Most of the core functionality and features are ready for use, but may have breaking changes in future releases. Please help us by submitting any issues via ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler-docs/issues",children:"GitHub Issues"})})," and make sure to review the ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"/docs/known-limits",children:"Known Issues and Limitations"})}),"!"]})]}),"\n",(0,r.jsx)(n.h2,{id:"whats-hauler",children:"What's Hauler?"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Rancher Government Hauler"})," simplifies the airgap experience without requiring users to adopt a specific workflow. ",(0,r.jsx)(n.code,{children:"Hauler"})," simplifies the airgapping process, by representing assets (images, charts, files, etc...) as content and collections to allow users to easily fetch, store, package, and distribute these assets with declarative manifests or through the command line."]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Hauler"})," does this by storing contents and collections as OCI Artifacts and allows users to serve contents and collections with an embedded registry and fileserver. Additionally, ",(0,r.jsx)(n.code,{children:"Hauler"})," has the ability to store and inspect various non-image OCI Artifacts."]}),"\n",(0,r.jsx)(n.h2,{id:"acknowledgements",children:"Acknowledgements"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Hauler"})," wouldn't be possible without the open-source community, but there are a few projects that stand out:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/google/go-containerregistry",children:"go-containerregistry"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/oras-project/oras",children:"oras cli"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/sigstore/cosign",children:"cosign"})}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var r=t(6540);const s={},i=r.createContext(s);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/52a6cb34.806931a9.js b/assets/js/52a6cb34.806931a9.js new file mode 100644 index 000000000..c3912cce2 --- /dev/null +++ b/assets/js/52a6cb34.806931a9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[617],{1100:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>l});var r=t(4848),s=t(8453);const i={title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},o="Rancher Government Hauler",a={id:"intro",title:"Introduction",description:"Introduction to Rancher Government Hauler",source:"@site/versioned_docs/version-0.4.4/intro.md",sourceDirName:".",slug:"/intro",permalink:"/docs/0.4.4/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.4/intro.md",tags:[],version:"0.4.4",frontMatter:{title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},sidebar:"haulerSidebar",next:{title:"Core Concepts",permalink:"/docs/0.4.4/core-concepts"}},c={},l=[{value:"What's Hauler?",id:"whats-hauler",level:2},{value:"Acknowledgements",id:"acknowledgements",level:2}];function d(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"rancher-government-hauler",children:"Rancher Government Hauler"}),"\n",(0,r.jsx)(n.h1,{id:"airgap-swiss-army-knife",children:"Airgap Swiss Army Knife"}),"\n",(0,r.jsxs)(n.admonition,{type:"caution",children:[(0,r.jsx)(n.p,{children:(0,r.jsxs)(n.strong,{children:["Note: Hauler and the Hauler Documentation are in active development and ",(0,r.jsx)(n.em,{children:"not Generally Available (GA)"}),"."]})}),(0,r.jsxs)(n.p,{children:["Most of the core functionality and features are ready for use, but may have breaking changes in future releases. Please help us by submitting any issues via ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler-docs/issues",children:"GitHub Issues"})})," and make sure to review the ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"/docs/known-limits",children:"Known Issues and Limitations"})}),"!"]})]}),"\n",(0,r.jsx)(n.h2,{id:"whats-hauler",children:"What's Hauler?"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Rancher Government Hauler"})," simplifies the airgap experience without requiring users to adopt a specific workflow. ",(0,r.jsx)(n.code,{children:"Hauler"})," simplifies the airgapping process, by representing assets (images, charts, files, etc...) as content and collections to allow users to easily fetch, store, package, and distribute these assets with declarative manifests or through the command line."]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Hauler"})," does this by storing contents and collections as OCI Artifacts and allows users to serve contents and collections with an embedded registry and fileserver. Additionally, ",(0,r.jsx)(n.code,{children:"Hauler"})," has the ability to store and inspect various non-image OCI Artifacts."]}),"\n",(0,r.jsx)(n.h2,{id:"acknowledgements",children:"Acknowledgements"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Hauler"})," wouldn't be possible without the open-source community, but there are a few projects that stand out:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/google/go-containerregistry",children:"go-containerregistry"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/oras-project/oras",children:"oras cli"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/sigstore/cosign",children:"cosign"})}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var r=t(6540);const s={},i=r.createContext(s);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/52ca3a3f.4dcc5d03.js b/assets/js/52ca3a3f.4dcc5d03.js new file mode 100644 index 000000000..753617880 --- /dev/null +++ b/assets/js/52ca3a3f.4dcc5d03.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9481],{2738:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var o=t(4848),r=t(8453);const i={title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},s=void 0,c={id:"core-concepts",title:"Core Concepts",description:"Core Concepts Documentation for Hauler",source:"@site/versioned_docs/version-1.0.x/core-concepts.md",sourceDirName:".",slug:"/core-concepts",permalink:"/docs/core-concepts",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.x/core-concepts.md",tags:[],version:"1.0.x",frontMatter:{title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},sidebar:"haulerSidebar",previous:{title:"Introduction",permalink:"/docs/intro"},next:{title:"Airgap Workflow",permalink:"/docs/airgap-workflow"}},a={},l=[{value:"Haul",id:"haul",level:2},{value:"Collections",id:"collections",level:2},{value:"Community Collections",id:"community-collections",level:3},{value:"RGS Carbide Collections",id:"rgs-carbide-collections",level:3},{value:"Content",id:"content",level:2},{value:"Declarative Content",id:"declarative-content",level:3}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"hauler-diagram",src:t(6178).A+"",width:"1949",height:"988"})}),"\n",(0,o.jsx)(n.h2,{id:"haul",children:"Haul"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauls"})," are Compressed Archive (Tarball) of Hauler Collections and Content."]})}),"\n",(0,o.jsxs)(n.p,{children:["At the heart of Hauler lies the concept of a ",(0,o.jsx)(n.code,{children:"Haul"}),". A ",(0,o.jsx)(n.code,{children:"Haul"})," is a compressed archive, often in the form of a tarball, containing Hauler collections and content. It serves as a container for grouping and transporting various data types, making it a fundamental element in the Hauler ecosystem."]}),"\n",(0,o.jsx)(n.h2,{id:"collections",children:"Collections"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are Grouping of one or more Hauler Contents."]})}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are the building blocks of Hauler. These are groupings of one or more Hauler ",(0,o.jsx)(n.code,{children:"contents"}),". Think of ",(0,o.jsx)(n.code,{children:"collections"})," as organized sets of data that collectively represent something desirable."]}),"\n",(0,o.jsx)(n.h3,{id:"community-collections",children:"Community Collections"}),"\n",(0,o.jsxs)(n.p,{children:["While ",(0,o.jsx)(n.code,{children:"collections"})," (and ",(0,o.jsx)(n.code,{children:"contents"}),") are built into Hauler, our goal is to empower operators to define their own ",(0,o.jsx)(n.code,{children:"collections"}),". This way, you can tailor Hauler to your unique requirements and take full control of your artifacts."]}),"\n",(0,o.jsx)(n.h3,{id:"rgs-carbide-collections",children:"RGS Carbide Collections"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauler"})," provides the ability to import ",(0,o.jsx)(n.code,{children:"collections"})," for the Rancher products, making it seamless for RGS Supported Customers to airgap any of the Rancher products or projects. If you haven't heard of Rancher Government Carbide, check it out ",(0,o.jsx)(n.a,{href:"https://ranchergovernment.com/carbide",children:"here"}),"!"]}),"\n",(0,o.jsx)(n.h2,{id:"content",children:"Content"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Contents"})," are Artifacts such as Images, Charts, or Files."]})}),"\n",(0,o.jsxs)(n.p,{children:["In Hauler's terminology, ",(0,o.jsx)(n.code,{children:"content"})," refers to artifacts such as ",(0,o.jsx)(n.strong,{children:"container images, helm charts, or files."})," These are the fundamental types of artifacts for ",(0,o.jsx)(n.code,{children:"Hauler"}),". To understand it a little bit better, let's break it down:"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Content"}),": The fundamental type of artifacts that Hauler recognizes (images, charts, and files)."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Artifact"}),": Anything that can be represented as an OCI (Open Container Initiative) Compliant Artifact.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"OCI Compliant Artifacts provide a standardized way to store arbitrary files, making it easier to manage content efficiently."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"declarative-content",children:"Declarative Content"}),"\n",(0,o.jsxs)(n.p,{children:["While manually adding content to ",(0,o.jsx)(n.code,{children:"Hauler"})," is an easy way to get started, there is a more sustainable approach... ",(0,o.jsx)(n.code,{children:"Hauler"})," provides a declarative and programmatic approach by allowing operators to define ",(0,o.jsx)(n.code,{children:"content"})," within a configuration file, known as a manifest. This approach ensures a more reproducable workflow for managing the lifecycle of your ",(0,o.jsx)(n.code,{children:"hauls"}),". Check it out ",(0,o.jsx)(n.a,{href:"/docs/guides-references/manifests",children:"here"}),"!"]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},6178:(e,n,t)=>{t.d(n,{A:()=>o});const o=t.p+"assets/images/hauler-diagram-53f9182c0d98fe871fb3cf7fe8cd475a.png"},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var o=t(6540);const r={},i=o.createContext(r);function s(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/52ca3a3f.be2da7ed.js b/assets/js/52ca3a3f.be2da7ed.js deleted file mode 100644 index 82a43ed0d..000000000 --- a/assets/js/52ca3a3f.be2da7ed.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9481],{2738:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var o=t(4848),r=t(8453);const i={title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},s=void 0,c={id:"core-concepts",title:"Core Concepts",description:"Core Concepts Documentation for Hauler",source:"@site/versioned_docs/version-1.0.x/core-concepts.md",sourceDirName:".",slug:"/core-concepts",permalink:"/hauler-docs/docs/core-concepts",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.x/core-concepts.md",tags:[],version:"1.0.x",frontMatter:{title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},sidebar:"haulerSidebar",previous:{title:"Introduction",permalink:"/hauler-docs/docs/intro"},next:{title:"Airgap Workflow",permalink:"/hauler-docs/docs/airgap-workflow"}},a={},l=[{value:"Haul",id:"haul",level:2},{value:"Collections",id:"collections",level:2},{value:"Community Collections",id:"community-collections",level:3},{value:"RGS Carbide Collections",id:"rgs-carbide-collections",level:3},{value:"Content",id:"content",level:2},{value:"Declarative Content",id:"declarative-content",level:3}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"hauler-diagram",src:t(6178).A+"",width:"1949",height:"988"})}),"\n",(0,o.jsx)(n.h2,{id:"haul",children:"Haul"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauls"})," are Compressed Archive (Tarball) of Hauler Collections and Content."]})}),"\n",(0,o.jsxs)(n.p,{children:["At the heart of Hauler lies the concept of a ",(0,o.jsx)(n.code,{children:"Haul"}),". A ",(0,o.jsx)(n.code,{children:"Haul"})," is a compressed archive, often in the form of a tarball, containing Hauler collections and content. It serves as a container for grouping and transporting various data types, making it a fundamental element in the Hauler ecosystem."]}),"\n",(0,o.jsx)(n.h2,{id:"collections",children:"Collections"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are Grouping of one or more Hauler Contents."]})}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are the building blocks of Hauler. These are groupings of one or more Hauler ",(0,o.jsx)(n.code,{children:"contents"}),". Think of ",(0,o.jsx)(n.code,{children:"collections"})," as organized sets of data that collectively represent something desirable."]}),"\n",(0,o.jsx)(n.h3,{id:"community-collections",children:"Community Collections"}),"\n",(0,o.jsxs)(n.p,{children:["While ",(0,o.jsx)(n.code,{children:"collections"})," (and ",(0,o.jsx)(n.code,{children:"contents"}),") are built into Hauler, our goal is to empower operators to define their own ",(0,o.jsx)(n.code,{children:"collections"}),". This way, you can tailor Hauler to your unique requirements and take full control of your artifacts."]}),"\n",(0,o.jsx)(n.h3,{id:"rgs-carbide-collections",children:"RGS Carbide Collections"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauler"})," provides the ability to import ",(0,o.jsx)(n.code,{children:"collections"})," for the Rancher products, making it seamless for RGS Supported Customers to airgap any of the Rancher products or projects. If you haven't heard of Rancher Government Carbide, check it out ",(0,o.jsx)(n.a,{href:"https://ranchergovernment.com/carbide",children:"here"}),"!"]}),"\n",(0,o.jsx)(n.h2,{id:"content",children:"Content"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Contents"})," are Artifacts such as Images, Charts, or Files."]})}),"\n",(0,o.jsxs)(n.p,{children:["In Hauler's terminology, ",(0,o.jsx)(n.code,{children:"content"})," refers to artifacts such as ",(0,o.jsx)(n.strong,{children:"container images, helm charts, or files."})," These are the fundamental types of artifacts for ",(0,o.jsx)(n.code,{children:"Hauler"}),". To understand it a little bit better, let's break it down:"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Content"}),": The fundamental type of artifacts that Hauler recognizes (images, charts, and files)."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Artifact"}),": Anything that can be represented as an OCI (Open Container Initiative) Compliant Artifact.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"OCI Compliant Artifacts provide a standardized way to store arbitrary files, making it easier to manage content efficiently."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"declarative-content",children:"Declarative Content"}),"\n",(0,o.jsxs)(n.p,{children:["While manually adding content to ",(0,o.jsx)(n.code,{children:"Hauler"})," is an easy way to get started, there is a more sustainable approach... ",(0,o.jsx)(n.code,{children:"Hauler"})," provides a declarative and programmatic approach by allowing operators to define ",(0,o.jsx)(n.code,{children:"content"})," within a configuration file, known as a manifest. This approach ensures a more reproducable workflow for managing the lifecycle of your ",(0,o.jsx)(n.code,{children:"hauls"}),". Check it out ",(0,o.jsx)(n.a,{href:"/hauler-docs/docs/guides-references/manifests",children:"here"}),"!"]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},6178:(e,n,t)=>{t.d(n,{A:()=>o});const o=t.p+"assets/images/hauler-diagram-53f9182c0d98fe871fb3cf7fe8cd475a.png"},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var o=t(6540);const r={},i=o.createContext(r);function s(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/534a9f50.3e30b89e.js b/assets/js/534a9f50.3e30b89e.js deleted file mode 100644 index 7405cc1df..000000000 --- a/assets/js/534a9f50.3e30b89e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3920],{2097:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>u,frontMatter:()=>i,metadata:()=>c,toc:()=>a});var r=n(4848),s=n(8453);const i={title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},l=void 0,c={id:"guides-references/overview",title:"Overview",description:"Reference Guides Overview Documentation for Hauler",source:"@site/versioned_docs/version-1.0.0/guides-references/overview.md",sourceDirName:"guides-references",slug:"/guides-references/overview",permalink:"/hauler-docs/docs/1.0.0/guides-references/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.0/guides-references/overview.md",tags:[],version:"1.0.0",frontMatter:{title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Uninstall",permalink:"/hauler-docs/docs/1.0.0/introduction/uninstall"},next:{title:"Hauler Manifests",permalink:"/hauler-docs/docs/1.0.0/guides-references/manifests"}},d={},a=[{value:"Hauler Guides & Reference Documentation",id:"hauler-guides--reference-documentation",level:2}];function o(e){const t={a:"a",h2:"h2",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.p,{children:"Additional Overview Documentation pending a future release!"}),"\n",(0,r.jsx)(t.h2,{id:"hauler-guides--reference-documentation",children:"Hauler Guides & Reference Documentation"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Guide or Reference Documentation"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Description"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"manifests",children:"Hauler Manifests"})}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Example Hauler Manifests"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"cluster-images",children:"Cluster Images"})}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Create a Hauler Store from Images on a Cluster"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"hauler-collections/community-collections",children:"Hauler Collections"})}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of Hauler Collections"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"hauler-content/images",children:"Hauler Content - Images"})}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Hauler Content Type - Images"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"hauler-content/charts",children:"Hauler Content - Charts"})}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Hauler Content Type - Charts"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"hauler-content/files",children:"Hauler Content - Files"})}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Hauler Content Type - Files"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"command-line/hauler",children:"Hauler Command Line"})}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of the Hauler Command Line Interface"})]})]})]})]})}function u(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>l,x:()=>c});var r=n(6540);const s={},i=r.createContext(s);function l(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/534a9f50.86e1547c.js b/assets/js/534a9f50.86e1547c.js new file mode 100644 index 000000000..c62efab44 --- /dev/null +++ b/assets/js/534a9f50.86e1547c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3920],{2097:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>a});var r=n(4848),i=n(8453);const s={title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},l=void 0,c={id:"guides-references/overview",title:"Overview",description:"Reference Guides Overview Documentation for Hauler",source:"@site/versioned_docs/version-1.0.0/guides-references/overview.md",sourceDirName:"guides-references",slug:"/guides-references/overview",permalink:"/docs/1.0.0/guides-references/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.0/guides-references/overview.md",tags:[],version:"1.0.0",frontMatter:{title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Uninstall",permalink:"/docs/1.0.0/introduction/uninstall"},next:{title:"Hauler Manifests",permalink:"/docs/1.0.0/guides-references/manifests"}},d={},a=[{value:"Hauler Guides & Reference Documentation",id:"hauler-guides--reference-documentation",level:2}];function o(e){const t={a:"a",h2:"h2",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.p,{children:"Additional Overview Documentation pending a future release!"}),"\n",(0,r.jsx)(t.h2,{id:"hauler-guides--reference-documentation",children:"Hauler Guides & Reference Documentation"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Guide or Reference Documentation"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Description"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"manifests",children:"Hauler Manifests"})}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Example Hauler Manifests"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"cluster-images",children:"Cluster Images"})}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Create a Hauler Store from Images on a Cluster"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"hauler-collections/community-collections",children:"Hauler Collections"})}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of Hauler Collections"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"hauler-content/images",children:"Hauler Content - Images"})}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Hauler Content Type - Images"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"hauler-content/charts",children:"Hauler Content - Charts"})}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Hauler Content Type - Charts"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"hauler-content/files",children:"Hauler Content - Files"})}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Hauler Content Type - Files"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"command-line/hauler",children:"Hauler Command Line"})}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of the Hauler Command Line Interface"})]})]})]})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>l,x:()=>c});var r=n(6540);const i={},s=r.createContext(i);function l(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/53eeb07f.42df1032.js b/assets/js/53eeb07f.42df1032.js deleted file mode 100644 index ccf02b11d..000000000 --- a/assets/js/53eeb07f.42df1032.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1260],{9675:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>t,contentTitle:()=>l,default:()=>u,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var o=r(4848),s=r(8453);const i={title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},l=void 0,a={id:"guides-references/command-line/hauler-version",title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",source:"@site/versioned_docs/version-1.0.0/guides-references/command-line/hauler-version.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-version",permalink:"/hauler-docs/docs/1.0.0/guides-references/command-line/hauler-version",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.0/guides-references/command-line/hauler-version.md",tags:[],version:"1.0.0",frontMatter:{title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},sidebar:"haulerSidebar",previous:{title:"Hauler Completion",permalink:"/hauler-docs/docs/1.0.0/guides-references/command-line/hauler-completion"},next:{title:"Known Issues/Limits",permalink:"/hauler-docs/docs/1.0.0/known-limits"}},t={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Print Hauler's current version."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler version [flags]\n\nAliases:\n version, v\n\nFlags:\n -h, --help help for version\n --json toggle output in JSON\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>a});var o=r(6540);const s={},i=o.createContext(s);function l(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/53eeb07f.9ff4c5b7.js b/assets/js/53eeb07f.9ff4c5b7.js new file mode 100644 index 000000000..8c1fe4d9d --- /dev/null +++ b/assets/js/53eeb07f.9ff4c5b7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1260],{9675:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>t,toc:()=>c});var o=r(4848),s=r(8453);const i={title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},l=void 0,t={id:"guides-references/command-line/hauler-version",title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",source:"@site/versioned_docs/version-1.0.0/guides-references/command-line/hauler-version.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-version",permalink:"/docs/1.0.0/guides-references/command-line/hauler-version",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.0/guides-references/command-line/hauler-version.md",tags:[],version:"1.0.0",frontMatter:{title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},sidebar:"haulerSidebar",previous:{title:"Hauler Completion",permalink:"/docs/1.0.0/guides-references/command-line/hauler-completion"},next:{title:"Known Issues/Limits",permalink:"/docs/1.0.0/known-limits"}},a={},c=[{value:"Command Overview",id:"command-overview",level:3}];function u(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Print Hauler's current version."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler version [flags]\n\nAliases:\n version, v\n\nFlags:\n -h, --help help for version\n --json toggle output in JSON\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>t});var o=r(6540);const s={},i=o.createContext(s);function l(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/541c05f8.1acad78b.js b/assets/js/541c05f8.1acad78b.js deleted file mode 100644 index 33612502d..000000000 --- a/assets/js/541c05f8.1acad78b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[271],{7730:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"0.4.4","label":"0.4.4","banner":"unmaintained","badge":true,"noIndex":false,"className":"docs-version-0.4.4","isLast":false,"docsSidebars":{"haulerSidebar":[{"type":"link","label":"Introduction","href":"/hauler-docs/docs/0.4.4/intro","docId":"intro","unlisted":false},{"type":"link","label":"Core Concepts","href":"/hauler-docs/docs/0.4.4/core-concepts","docId":"core-concepts","unlisted":false},{"type":"link","label":"Airgap Workflow","href":"/hauler-docs/docs/0.4.4/airgap-workflow","docId":"airgap-workflow","unlisted":false},{"type":"category","label":"Introduction","description":"Introduction Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Quickstart","href":"/hauler-docs/docs/0.4.4/introduction/quickstart","docId":"introduction/quickstart","unlisted":false},{"type":"link","label":"Installation","href":"/hauler-docs/docs/0.4.4/introduction/install","docId":"introduction/install","unlisted":false},{"type":"link","label":"Uninstall","href":"/hauler-docs/docs/0.4.4/introduction/uninstall","docId":"introduction/uninstall","unlisted":false}],"collapsible":true},{"type":"category","label":"Guides & References","description":"Guides and References Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Overview","href":"/hauler-docs/docs/0.4.4/guides-references/overview","docId":"guides-references/overview","unlisted":false},{"type":"link","label":"Fetch Cluster Images","href":"/hauler-docs/docs/0.4.4/guides-references/cluster-images","docId":"guides-references/cluster-images","unlisted":false},{"type":"link","label":"RGS Carbide Customers","href":"/hauler-docs/docs/0.4.4/guides-references/carbide-customers","docId":"guides-references/carbide-customers","unlisted":false},{"type":"category","label":"Hauler Collections","description":"Guides and References for Hauler Collections","items":[{"type":"link","label":"Overview","href":"/hauler-docs/docs/0.4.4/guides-references/hauler-collections/overview","docId":"guides-references/hauler-collections/overview","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Hauler Content","description":"Guides and References for Hauler Content Types","items":[{"type":"link","label":"Overview","href":"/hauler-docs/docs/0.4.4/guides-references/hauler-content/overview","docId":"guides-references/hauler-content/overview","unlisted":false},{"type":"link","label":"Images","href":"/hauler-docs/docs/0.4.4/guides-references/hauler-content/images","docId":"guides-references/hauler-content/images","unlisted":false},{"type":"link","label":"Charts","href":"/hauler-docs/docs/0.4.4/guides-references/hauler-content/charts","docId":"guides-references/hauler-content/charts","unlisted":false},{"type":"link","label":"Files","href":"/hauler-docs/docs/0.4.4/guides-references/hauler-content/files","docId":"guides-references/hauler-content/files","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Command Line Interface","description":"Guides and References for the Hauler Command Line","items":[{"type":"link","label":"Hauler","href":"/hauler-docs/docs/0.4.4/guides-references/command-line/hauler","docId":"guides-references/command-line/hauler","unlisted":false},{"type":"link","label":"Hauler Store","href":"/hauler-docs/docs/0.4.4/guides-references/command-line/hauler-store","docId":"guides-references/command-line/hauler-store","unlisted":false},{"type":"link","label":"Hauler Completion","href":"/hauler-docs/docs/0.4.4/guides-references/command-line/hauler-completion","docId":"guides-references/command-line/hauler-completion","unlisted":false},{"type":"link","label":"Hauler Version","href":"/hauler-docs/docs/0.4.4/guides-references/command-line/hauler-version","docId":"guides-references/command-line/hauler-version","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true},{"type":"link","label":"Known Issues/Limits","href":"/hauler-docs/docs/0.4.4/known-limits","docId":"known-limits","unlisted":false}]},"docs":{"airgap-workflow":{"id":"airgap-workflow","title":"Airgap Workflow","description":"Airgap Workflow Documentation for Hauler","sidebar":"haulerSidebar"},"core-concepts":{"id":"core-concepts","title":"Core Concepts","description":"Core Concepts Documentation for Hauler","sidebar":"haulerSidebar"},"guides-references/carbide-customers":{"id":"guides-references/carbide-customers","title":"RGS Carbide Customers","description":"RGS Carbide Customers Documentation","sidebar":"haulerSidebar"},"guides-references/cluster-images":{"id":"guides-references/cluster-images","title":"Fetching Cluster Images","description":"Fetching Images on a Cluster Documentation","sidebar":"haulerSidebar"},"guides-references/command-line/hauler":{"id":"guides-references/command-line/hauler","title":"Hauler (Command)","description":"Hauler CLI Reference for hauler","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-completion":{"id":"guides-references/command-line/hauler-completion","title":"Hauler Completion (Command)","description":"Hauler CLI Reference for hauler completion","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-store":{"id":"guides-references/command-line/hauler-store","title":"Hauler Store (Command)","description":"Hauler CLI Reference for hauler store","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-version":{"id":"guides-references/command-line/hauler-version","title":"Hauler Version (Command)","description":"Hauler CLI Reference for hauler version","sidebar":"haulerSidebar"},"guides-references/hauler-collections/overview":{"id":"guides-references/hauler-collections/overview","title":"Overview of Hauler Collections","description":"Hauler Collections Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/charts":{"id":"guides-references/hauler-content/charts","title":"Charts (Content Type)","description":"Hauler \\"Charts\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/files":{"id":"guides-references/hauler-content/files","title":"Files (Content Type)","description":"Hauler \\"Files\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/images":{"id":"guides-references/hauler-content/images","title":"Images (Content Type)","description":"Hauler \\"Images\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/overview":{"id":"guides-references/hauler-content/overview","title":"Overview of Hauler Content","description":"Hauler Content Documentation","sidebar":"haulerSidebar"},"guides-references/overview":{"id":"guides-references/overview","title":"Overview","description":"Reference Guides Overview Documentation for Hauler","sidebar":"haulerSidebar"},"intro":{"id":"intro","title":"Introduction","description":"Introduction to Rancher Government Hauler","sidebar":"haulerSidebar"},"introduction/install":{"id":"introduction/install","title":"Installation","description":"Installation Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/quickstart":{"id":"introduction/quickstart","title":"Quickstart","description":"Quickstart Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/uninstall":{"id":"introduction/uninstall","title":"Uninstall","description":"Uninstall Documentation for Hauler","sidebar":"haulerSidebar"},"known-limits":{"id":"known-limits","title":"Known Issues and Limits","description":"Known Issues and Limitations for Hauler","sidebar":"haulerSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/558b039e.ce368409.js b/assets/js/558b039e.ce368409.js deleted file mode 100644 index 0c7b5b54a..000000000 --- a/assets/js/558b039e.ce368409.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7858],{4019:(r,e,o)=>{o.r(e),o.d(e,{assets:()=>c,contentTitle:()=>n,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var t=o(4848),a=o(8453);const i={title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},n=void 0,s={id:"airgap-workflow",title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",source:"@site/versioned_docs/version-0.4.1/airgap-workflow.md",sourceDirName:".",slug:"/airgap-workflow",permalink:"/hauler-docs/docs/0.4.1/airgap-workflow",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.1/airgap-workflow.md",tags:[],version:"0.4.1",frontMatter:{title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},sidebar:"haulerSidebar",previous:{title:"Core Concepts",permalink:"/hauler-docs/docs/0.4.1/core-concepts"},next:{title:"Quickstart",permalink:"/hauler-docs/docs/0.4.1/introduction/quickstart"}},c={},l=[{value:"Workflow Diagram",id:"workflow-diagram",level:2}];function d(r){const e={h2:"h2",img:"img",p:"p",...(0,a.R)(),...r.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h2,{id:"workflow-diagram",children:"Workflow Diagram"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.img,{alt:"hauler-workflow-diagram",src:o(8010).A+"",width:"2883",height:"1013"})}),"\n",(0,t.jsx)(e.p,{children:"Airgap Workflow Documentation pending a future release!"})]})}function u(r={}){const{wrapper:e}={...(0,a.R)(),...r.components};return e?(0,t.jsx)(e,{...r,children:(0,t.jsx)(d,{...r})}):d(r)}},8010:(r,e,o)=>{o.d(e,{A:()=>t});const t=o.p+"assets/images/hauler-workflow-diagram-a0761cc99fb86b21c4ca1a7d8a31dfc4.png"},8453:(r,e,o)=>{o.d(e,{R:()=>n,x:()=>s});var t=o(6540);const a={},i=t.createContext(a);function n(r){const e=t.useContext(i);return t.useMemo((function(){return"function"==typeof r?r(e):{...e,...r}}),[e,r])}function s(r){let e;return e=r.disableParentContext?"function"==typeof r.components?r.components(a):r.components||a:n(r.components),t.createElement(i.Provider,{value:e},r.children)}}}]); \ No newline at end of file diff --git a/assets/js/558b039e.dff6c474.js b/assets/js/558b039e.dff6c474.js new file mode 100644 index 000000000..77478d7b2 --- /dev/null +++ b/assets/js/558b039e.dff6c474.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7858],{4019:(o,r,e)=>{e.r(r),e.d(r,{assets:()=>l,contentTitle:()=>n,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>c});var t=e(4848),a=e(8453);const i={title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},n=void 0,s={id:"airgap-workflow",title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",source:"@site/versioned_docs/version-0.4.1/airgap-workflow.md",sourceDirName:".",slug:"/airgap-workflow",permalink:"/docs/0.4.1/airgap-workflow",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.1/airgap-workflow.md",tags:[],version:"0.4.1",frontMatter:{title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},sidebar:"haulerSidebar",previous:{title:"Core Concepts",permalink:"/docs/0.4.1/core-concepts"},next:{title:"Quickstart",permalink:"/docs/0.4.1/introduction/quickstart"}},l={},c=[{value:"Workflow Diagram",id:"workflow-diagram",level:2}];function d(o){const r={h2:"h2",img:"img",p:"p",...(0,a.R)(),...o.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h2,{id:"workflow-diagram",children:"Workflow Diagram"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.img,{alt:"hauler-workflow-diagram",src:e(8010).A+"",width:"2883",height:"1013"})}),"\n",(0,t.jsx)(r.p,{children:"Airgap Workflow Documentation pending a future release!"})]})}function u(o={}){const{wrapper:r}={...(0,a.R)(),...o.components};return r?(0,t.jsx)(r,{...o,children:(0,t.jsx)(d,{...o})}):d(o)}},8010:(o,r,e)=>{e.d(r,{A:()=>t});const t=e.p+"assets/images/hauler-workflow-diagram-a0761cc99fb86b21c4ca1a7d8a31dfc4.png"},8453:(o,r,e)=>{e.d(r,{R:()=>n,x:()=>s});var t=e(6540);const a={},i=t.createContext(a);function n(o){const r=t.useContext(i);return t.useMemo((function(){return"function"==typeof o?o(r):{...r,...o}}),[r,o])}function s(o){let r;return r=o.disableParentContext?"function"==typeof o.components?o.components(a):o.components||a:n(o.components),t.createElement(i.Provider,{value:r},o.children)}}}]); \ No newline at end of file diff --git a/assets/js/55e387c7.24f50d57.js b/assets/js/55e387c7.24f50d57.js new file mode 100644 index 000000000..0e8753456 --- /dev/null +++ b/assets/js/55e387c7.24f50d57.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4288],{3001:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>o,contentTitle:()=>i,default:()=>m,frontMatter:()=>s,metadata:()=>l,toc:()=>c});var t=a(4848),r=a(8453);const s={title:"Hauler Manifests",description:"Hauler Manifests Documentation",sidebar_label:"Hauler Manifests"},i=void 0,l={id:"guides-references/manifests",title:"Hauler Manifests",description:"Hauler Manifests Documentation",source:"@site/docs/guides-references/manifests.md",sourceDirName:"guides-references",slug:"/guides-references/manifests",permalink:"/docs/next/guides-references/manifests",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/docs/guides-references/manifests.md",tags:[],version:"current",frontMatter:{title:"Hauler Manifests",description:"Hauler Manifests Documentation",sidebar_label:"Hauler Manifests"},sidebar:"haulerSidebar",previous:{title:"Hauler Fileserver",permalink:"/docs/next/guides-references/utilities/fileserver"},next:{title:"Community Collections",permalink:"/docs/next/guides-references/hauler-collections/community-collections"}},o={},c=[{value:"Example Manifest for Images",id:"example-manifest-for-images",level:2},{value:"Example Manifest for Charts",id:"example-manifest-for-charts",level:2},{value:"Example Manifest for Files",id:"example-manifest-for-files",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"example-manifest-for-images",children:"Example Manifest for Images"}),"\n",(0,t.jsxs)(n.p,{children:["Please review the Hauler Content Pages for ",(0,t.jsx)(n.a,{href:"/docs/next/guides-references/hauler-content/images",children:"Images"})," for more detailed information."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-image-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\n annotations:\n # global flags for all images in the manifest\n # image flags override global flags\n hauler.dev/key: \n hauler.dev/platform: \n hauler.dev/registry: \nspec:\n images:\n # fetch image\n - name: neuvector/scanner\n # fetch image with full image reference\n - name: docker.io/neuvector/updater:latest\n # fetch image with full image reference with digest\n - name: docker.io/neuvector/updater@sha256:0076b356368c9988eec5f3cead771d29a377074b982f22800f4d9c8c3b215a56\n # fetch image with full image reference, specific version, specific platform\n - name: docker.io/longhornio/longhorn-ui:v1.6.0\n platform: linux/amd64\n # fetch image with full image reference, specific version, specific platform, and signature verification\n - name: docker.io/longhornio/longhorn-manager:v1.6.0\n key: cosign-public-key.pub\n platform: linux/amd64\n"})}),"\n",(0,t.jsx)(n.h2,{id:"example-manifest-for-charts",children:"Example Manifest for Charts"}),"\n",(0,t.jsxs)(n.p,{children:["Please review the Hauler Content Pages for ",(0,t.jsx)(n.a,{href:"/docs/next/guides-references/hauler-content/charts",children:"Charts"})," for more detailed information."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-chart-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n # fetch helm chart\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n # fetch helm chart with specific version\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.8.2\n"})}),"\n",(0,t.jsx)(n.h2,{id:"example-manifest-for-files",children:"Example Manifest for Files"}),"\n",(0,t.jsxs)(n.p,{children:["Please review the Hauler Content Pages for ",(0,t.jsx)(n.a,{href:"/docs/next/guides-references/hauler-content/files",children:"Files"})," for more detailed information."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-file-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n # fetch remote file\n - path: https://get.rke2.io\n # fetch remote file and assign new name\n - path: https://get.rke2.io\n name: install.sh\n # fetch local file\n - path: path/to/local/file.txt\n # fetch local file and assign new name\n - path: path/to/local/file.txt\n name: local-file.txt\n"})})]})}function m(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}},8453:(e,n,a)=>{a.d(n,{R:()=>i,x:()=>l});var t=a(6540);const r={},s=t.createContext(r);function i(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/55e387c7.4e1bb8ee.js b/assets/js/55e387c7.4e1bb8ee.js deleted file mode 100644 index 02dddf052..000000000 --- a/assets/js/55e387c7.4e1bb8ee.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4288],{3001:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>o,contentTitle:()=>i,default:()=>m,frontMatter:()=>s,metadata:()=>l,toc:()=>c});var t=a(4848),r=a(8453);const s={title:"Hauler Manifests",description:"Hauler Manifests Documentation",sidebar_label:"Hauler Manifests"},i=void 0,l={id:"guides-references/manifests",title:"Hauler Manifests",description:"Hauler Manifests Documentation",source:"@site/docs/guides-references/manifests.md",sourceDirName:"guides-references",slug:"/guides-references/manifests",permalink:"/hauler-docs/docs/next/guides-references/manifests",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/docs/guides-references/manifests.md",tags:[],version:"current",frontMatter:{title:"Hauler Manifests",description:"Hauler Manifests Documentation",sidebar_label:"Hauler Manifests"},sidebar:"haulerSidebar",previous:{title:"Hauler Fileserver",permalink:"/hauler-docs/docs/next/guides-references/utilities/fileserver"},next:{title:"Community Collections",permalink:"/hauler-docs/docs/next/guides-references/hauler-collections/community-collections"}},o={},c=[{value:"Example Manifest for Images",id:"example-manifest-for-images",level:2},{value:"Example Manifest for Charts",id:"example-manifest-for-charts",level:2},{value:"Example Manifest for Files",id:"example-manifest-for-files",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"example-manifest-for-images",children:"Example Manifest for Images"}),"\n",(0,t.jsxs)(n.p,{children:["Please review the Hauler Content Pages for ",(0,t.jsx)(n.a,{href:"/hauler-docs/docs/next/guides-references/hauler-content/images",children:"Images"})," for more detailed information."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-image-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\n annotations:\n # global flags for all images in the manifest\n # image flags override global flags\n hauler.dev/key: \n hauler.dev/platform: \n hauler.dev/registry: \nspec:\n images:\n # fetch image\n - name: neuvector/scanner\n # fetch image with full image reference\n - name: docker.io/neuvector/updater:latest\n # fetch image with full image reference with digest\n - name: docker.io/neuvector/updater@sha256:0076b356368c9988eec5f3cead771d29a377074b982f22800f4d9c8c3b215a56\n # fetch image with full image reference, specific version, specific platform\n - name: docker.io/longhornio/longhorn-ui:v1.6.0\n platform: linux/amd64\n # fetch image with full image reference, specific version, specific platform, and signature verification\n - name: docker.io/longhornio/longhorn-manager:v1.6.0\n key: cosign-public-key.pub\n platform: linux/amd64\n"})}),"\n",(0,t.jsx)(n.h2,{id:"example-manifest-for-charts",children:"Example Manifest for Charts"}),"\n",(0,t.jsxs)(n.p,{children:["Please review the Hauler Content Pages for ",(0,t.jsx)(n.a,{href:"/hauler-docs/docs/next/guides-references/hauler-content/charts",children:"Charts"})," for more detailed information."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-chart-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n # fetch helm chart\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n # fetch helm chart with specific version\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.8.2\n"})}),"\n",(0,t.jsx)(n.h2,{id:"example-manifest-for-files",children:"Example Manifest for Files"}),"\n",(0,t.jsxs)(n.p,{children:["Please review the Hauler Content Pages for ",(0,t.jsx)(n.a,{href:"/hauler-docs/docs/next/guides-references/hauler-content/files",children:"Files"})," for more detailed information."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-file-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n # fetch remote file\n - path: https://get.rke2.io\n # fetch remote file and assign new name\n - path: https://get.rke2.io\n name: install.sh\n # fetch local file\n - path: path/to/local/file.txt\n # fetch local file and assign new name\n - path: path/to/local/file.txt\n name: local-file.txt\n"})})]})}function m(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}},8453:(e,n,a)=>{a.d(n,{R:()=>i,x:()=>l});var t=a(6540);const r={},s=t.createContext(r);function i(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5814b660.0693e4c3.js b/assets/js/5814b660.0693e4c3.js new file mode 100644 index 000000000..0641180da --- /dev/null +++ b/assets/js/5814b660.0693e4c3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9421],{4621:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var n=r(4848),i=r(8453);const s={title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},l=void 0,c={id:"guides-references/overview",title:"Overview",description:"Reference Guides Overview Documentation for Hauler",source:"@site/versioned_docs/version-0.4.1/guides-references/overview.md",sourceDirName:"guides-references",slug:"/guides-references/overview",permalink:"/docs/0.4.1/guides-references/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.1/guides-references/overview.md",tags:[],version:"0.4.1",frontMatter:{title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Uninstall",permalink:"/docs/0.4.1/introduction/uninstall"},next:{title:"Fetch Cluster Images",permalink:"/docs/0.4.1/guides-references/cluster-images"}},o={},d=[{value:"Hauler Guides & Reference Documentation",id:"hauler-guides--reference-documentation",level:2}];function a(e){const t={a:"a",h2:"h2",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Additional Overview Documentation pending a future release!"}),"\n",(0,n.jsx)(t.h2,{id:"hauler-guides--reference-documentation",children:"Hauler Guides & Reference Documentation"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Guide or Reference Documentation"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"cluster-images",children:"Cluster Images"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Create a Hauler Store from Images on a Cluster"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-collections/overview",children:"Hauler Collections"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of Hauler Collections"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-content/overview",children:"Hauler Content"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of Hauler Content"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"command-line/hauler",children:"Hauler Command Line"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of the Hauler Command Line Interface"})]})]})]})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>l,x:()=>c});var n=r(6540);const i={},s=n.createContext(i);function l(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5814b660.2deaf751.js b/assets/js/5814b660.2deaf751.js deleted file mode 100644 index 5ad321f92..000000000 --- a/assets/js/5814b660.2deaf751.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9421],{4621:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var n=r(4848),i=r(8453);const s={title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},l=void 0,c={id:"guides-references/overview",title:"Overview",description:"Reference Guides Overview Documentation for Hauler",source:"@site/versioned_docs/version-0.4.1/guides-references/overview.md",sourceDirName:"guides-references",slug:"/guides-references/overview",permalink:"/hauler-docs/docs/0.4.1/guides-references/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.1/guides-references/overview.md",tags:[],version:"0.4.1",frontMatter:{title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Uninstall",permalink:"/hauler-docs/docs/0.4.1/introduction/uninstall"},next:{title:"Fetch Cluster Images",permalink:"/hauler-docs/docs/0.4.1/guides-references/cluster-images"}},o={},d=[{value:"Hauler Guides & Reference Documentation",id:"hauler-guides--reference-documentation",level:2}];function a(e){const t={a:"a",h2:"h2",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Additional Overview Documentation pending a future release!"}),"\n",(0,n.jsx)(t.h2,{id:"hauler-guides--reference-documentation",children:"Hauler Guides & Reference Documentation"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Guide or Reference Documentation"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"cluster-images",children:"Cluster Images"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Create a Hauler Store from Images on a Cluster"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-collections/overview",children:"Hauler Collections"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of Hauler Collections"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-content/overview",children:"Hauler Content"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of Hauler Content"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"command-line/hauler",children:"Hauler Command Line"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of the Hauler Command Line Interface"})]})]})]})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>l,x:()=>c});var n=r(6540);const i={},s=n.createContext(i);function l(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5916736d.2e82d5ef.js b/assets/js/5916736d.2e82d5ef.js deleted file mode 100644 index 66140f0b1..000000000 --- a/assets/js/5916736d.2e82d5ef.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1664],{9859:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>s,metadata:()=>i,toc:()=>d});var r=n(4848),l=n(8453);const s={title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},a=void 0,i={id:"introduction/install",title:"Installation",description:"Installation Documentation for Hauler",source:"@site/versioned_docs/version-0.4.3/introduction/install.md",sourceDirName:"introduction",slug:"/introduction/install",permalink:"/hauler-docs/docs/0.4.3/introduction/install",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.3/introduction/install.md",tags:[],version:"0.4.3",frontMatter:{title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},sidebar:"haulerSidebar",previous:{title:"Quickstart",permalink:"/hauler-docs/docs/0.4.3/introduction/quickstart"},next:{title:"Uninstall",permalink:"/hauler-docs/docs/0.4.3/introduction/uninstall"}},c={},d=[{value:"Overview",id:"overview",level:2},{value:"Supported Architectures",id:"supported-architectures",level:2},{value:"Installation Steps",id:"installation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin",level:3},{value:"Homebrew",id:"homebrew",level:3},{value:"Windows",id:"windows",level:3},{value:"Manual Installation Steps",id:"manual-installation-steps",level:2}];function o(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h2,{id:"overview",children:"Overview"}),"\n",(0,r.jsxs)(t.p,{children:["Hauler is a purpose built to be a single binary with no specific prerequistes or depedencies. It's installation is very simple and easy to follow. To view the latest release, please view our ",(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"GitHub Release"})," page."]}),"\n",(0,r.jsx)(t.h2,{id:"supported-architectures",children:"Supported Architectures"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Base Platform"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Architecture"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Latest Release"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Linux"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Darwin"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Windows"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]})]})]}),"\n",(0,r.jsx)(t.h2,{id:"installation-steps",children:"Installation Steps"}),"\n",(0,r.jsx)(t.h3,{id:"linuxdarwin",children:"Linux/Darwin"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n\n# install specific release\ncurl -sfL https://get.hauler.dev | HAULER_VERSION=0.4.3 bash\n"})}),"\n",(0,r.jsx)(t.h3,{id:"homebrew",children:"Homebrew"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# installs latest release\nbrew tap rancherfederal/homebrew-tap\nbrew install hauler\n"})}),"\n",(0,r.jsx)(t.h3,{id:"windows",children:"Windows"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,r.jsx)(t.h2,{id:"manual-installation-steps",children:"Manual Installation Steps"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:'# set the hauler version (i.e. "0.4.3")\nexport vHauler=HAULER_VERSION\n\n# set the specific platform (i.e. "linux")\nexport platform=PLATFORM\n\n# set the specific arch (i.e. "amd64")\nexport arch=ARCH\n\ncurl -sOL https://github.com/rancherfederal/hauler/releases/download/v${vHauler}/hauler_${vHauler}_${platform}_${arch}.tar.gz\ntar -xf hauler_${vHauler}_${platform}_${arch}.tar.gz\nsudo mv hauler /usr/bin/hauler\n'})})]})}function h(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>i});var r=n(6540);const l={},s=r.createContext(l);function a(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:a(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5916736d.6d14baa7.js b/assets/js/5916736d.6d14baa7.js new file mode 100644 index 000000000..b4ac6fcdb --- /dev/null +++ b/assets/js/5916736d.6d14baa7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1664],{9859:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>s,metadata:()=>i,toc:()=>d});var r=n(4848),l=n(8453);const s={title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},a=void 0,i={id:"introduction/install",title:"Installation",description:"Installation Documentation for Hauler",source:"@site/versioned_docs/version-0.4.3/introduction/install.md",sourceDirName:"introduction",slug:"/introduction/install",permalink:"/docs/0.4.3/introduction/install",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.3/introduction/install.md",tags:[],version:"0.4.3",frontMatter:{title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},sidebar:"haulerSidebar",previous:{title:"Quickstart",permalink:"/docs/0.4.3/introduction/quickstart"},next:{title:"Uninstall",permalink:"/docs/0.4.3/introduction/uninstall"}},c={},d=[{value:"Overview",id:"overview",level:2},{value:"Supported Architectures",id:"supported-architectures",level:2},{value:"Installation Steps",id:"installation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin",level:3},{value:"Homebrew",id:"homebrew",level:3},{value:"Windows",id:"windows",level:3},{value:"Manual Installation Steps",id:"manual-installation-steps",level:2}];function o(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h2,{id:"overview",children:"Overview"}),"\n",(0,r.jsxs)(t.p,{children:["Hauler is a purpose built to be a single binary with no specific prerequistes or depedencies. It's installation is very simple and easy to follow. To view the latest release, please view our ",(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"GitHub Release"})," page."]}),"\n",(0,r.jsx)(t.h2,{id:"supported-architectures",children:"Supported Architectures"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Base Platform"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Architecture"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Latest Release"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Linux"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Darwin"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Windows"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]})]})]}),"\n",(0,r.jsx)(t.h2,{id:"installation-steps",children:"Installation Steps"}),"\n",(0,r.jsx)(t.h3,{id:"linuxdarwin",children:"Linux/Darwin"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n\n# install specific release\ncurl -sfL https://get.hauler.dev | HAULER_VERSION=0.4.3 bash\n"})}),"\n",(0,r.jsx)(t.h3,{id:"homebrew",children:"Homebrew"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# installs latest release\nbrew tap rancherfederal/homebrew-tap\nbrew install hauler\n"})}),"\n",(0,r.jsx)(t.h3,{id:"windows",children:"Windows"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,r.jsx)(t.h2,{id:"manual-installation-steps",children:"Manual Installation Steps"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:'# set the hauler version (i.e. "0.4.3")\nexport vHauler=HAULER_VERSION\n\n# set the specific platform (i.e. "linux")\nexport platform=PLATFORM\n\n# set the specific arch (i.e. "amd64")\nexport arch=ARCH\n\ncurl -sOL https://github.com/rancherfederal/hauler/releases/download/v${vHauler}/hauler_${vHauler}_${platform}_${arch}.tar.gz\ntar -xf hauler_${vHauler}_${platform}_${arch}.tar.gz\nsudo mv hauler /usr/bin/hauler\n'})})]})}function h(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>i});var r=n(6540);const l={},s=r.createContext(l);function a(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:a(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5b458d10.3bf1ea0d.js b/assets/js/5b458d10.3bf1ea0d.js deleted file mode 100644 index abfa21a47..000000000 --- a/assets/js/5b458d10.3bf1ea0d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9068],{9506:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>u});var r=n(4848),o=n(8453);const i={title:"Overview of Hauler Content",description:"Hauler Content Documentation",sidebar_label:"Overview"},s=void 0,c={id:"guides-references/hauler-content/overview",title:"Overview of Hauler Content",description:"Hauler Content Documentation",source:"@site/versioned_docs/version-0.4.4/guides-references/hauler-content/overview.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/overview",permalink:"/hauler-docs/docs/0.4.4/guides-references/hauler-content/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.4/guides-references/hauler-content/overview.md",tags:[],version:"0.4.4",frontMatter:{title:"Overview of Hauler Content",description:"Hauler Content Documentation",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/hauler-docs/docs/0.4.4/guides-references/hauler-collections/overview"},next:{title:"Images",permalink:"/hauler-docs/docs/0.4.4/guides-references/hauler-content/images"}},a={},u=[];function l(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,r.jsx)(t.p,{children:"Hauler Content Overview Documentation pending a future release!"})}function d(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>c});var r=n(6540);const o={},i=r.createContext(o);function s(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5b458d10.ba4a4028.js b/assets/js/5b458d10.ba4a4028.js new file mode 100644 index 000000000..724f6ddd8 --- /dev/null +++ b/assets/js/5b458d10.ba4a4028.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9068],{9506:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>a});var r=n(4848),o=n(8453);const i={title:"Overview of Hauler Content",description:"Hauler Content Documentation",sidebar_label:"Overview"},s=void 0,c={id:"guides-references/hauler-content/overview",title:"Overview of Hauler Content",description:"Hauler Content Documentation",source:"@site/versioned_docs/version-0.4.4/guides-references/hauler-content/overview.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/overview",permalink:"/docs/0.4.4/guides-references/hauler-content/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.4/guides-references/hauler-content/overview.md",tags:[],version:"0.4.4",frontMatter:{title:"Overview of Hauler Content",description:"Hauler Content Documentation",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/docs/0.4.4/guides-references/hauler-collections/overview"},next:{title:"Images",permalink:"/docs/0.4.4/guides-references/hauler-content/images"}},u={},a=[];function l(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,r.jsx)(t.p,{children:"Hauler Content Overview Documentation pending a future release!"})}function d(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>c});var r=n(6540);const o={},i=r.createContext(o);function s(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5c6ec25c.33ba4e89.js b/assets/js/5c6ec25c.33ba4e89.js deleted file mode 100644 index 4bc8348cf..000000000 --- a/assets/js/5c6ec25c.33ba4e89.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9167],{7991:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>t,metadata:()=>l,toc:()=>d});var a=r(4848),s=r(8453);const t={title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},i=void 0,l={id:"guides-references/cluster-images",title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",source:"@site/versioned_docs/version-0.4.3/guides-references/cluster-images.md",sourceDirName:"guides-references",slug:"/guides-references/cluster-images",permalink:"/hauler-docs/docs/0.4.3/guides-references/cluster-images",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.3/guides-references/cluster-images.md",tags:[],version:"0.4.3",frontMatter:{title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/hauler-docs/docs/0.4.3/guides-references/overview"},next:{title:"RGS Carbide Customers",permalink:"/hauler-docs/docs/0.4.3/guides-references/carbide-customers"}},c={},d=[{value:"Example Output",id:"example-output",level:3},{value:"Hauler Manifest using the Images",id:"hauler-manifest-using-the-images",level:3},{value:"Resulting Hauler Manifest",id:"resulting-hauler-manifest",level:3}];function o(e){const n={code:"code",h3:"h3",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsxs)(n.p,{children:["It may be difficult to understand exactly what ",(0,a.jsx)(n.code,{children:"content"})," is actively within your environment. Below is a simple way to generate a list of all images running in your environment, store it as an environment variable, and show the list by echoing the environment variable."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"export IMAGE_LIST=$(kubectl get pods --all-namespaces -o jsonpath=\"{.items[*].spec.containers[*].image}\" |tr -s '[[:space:]]' '\\n' |sort |uniq -c | cut -c 9-)\necho \"$IMAGE_LIST\"\n"})}),"\n",(0,a.jsx)(n.h3,{id:"example-output",children:"Example Output"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:"index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\nindex.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\nindex.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\nrancher/hardened-calico:v3.21.4-build20220228\nrancher/hardened-cluster-autoscaler:v1.8.5-build20211119\nrancher/hardened-coredns:v1.9.1-build20220318\nrancher/hardened-flannel:v0.17.0-build20220317\nrancher/hardened-k8s-metrics-server:v0.5.0-build20211119\nrancher/klipper-helm:v0.7.0-build20220315\nrancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})}),"\n",(0,a.jsx)(n.h3,{id:"hauler-manifest-using-the-images",children:"Hauler Manifest using the Images"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:"IMAGE_LIST_MODIFIED=$(cat \"$IMAGE_LIST\" | sed 's/^/ - name: /')\n# sed, stream editor, appends 2 spaces of indentation denotes\n# an entry in a list, then adds name: to match expected syntax\n"})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images-example\nspec:\n images:\n$IMAGE_LIST_MODIFIED\n"})}),"\n",(0,a.jsx)(n.h3,{id:"resulting-hauler-manifest",children:"Resulting Hauler Manifest"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images-example\nspec:\n images:\n - name: index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\n - name: index.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\n - name: index.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\n - name: rancher/hardened-calico:v3.21.4-build20220228\n - name: rancher/hardened-cluster-autoscaler:v1.8.5-build20211119\n - name: rancher/hardened-coredns:v1.9.1-build20220318\n - name: rancher/hardened-flannel:v0.17.0-build20220317\n - name: rancher/hardened-k8s-metrics-server:v0.5.0-build20211119\n - name: rancher/klipper-helm:v0.7.0-build20220315\n - name: rancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(o,{...e})}):o(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>l});var a=r(6540);const s={},t=a.createContext(s);function i(e){const n=a.useContext(t);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),a.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5c6ec25c.f5f577a2.js b/assets/js/5c6ec25c.f5f577a2.js new file mode 100644 index 000000000..f07b57b8e --- /dev/null +++ b/assets/js/5c6ec25c.f5f577a2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9167],{7991:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>t,metadata:()=>l,toc:()=>d});var a=r(4848),s=r(8453);const t={title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},i=void 0,l={id:"guides-references/cluster-images",title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",source:"@site/versioned_docs/version-0.4.3/guides-references/cluster-images.md",sourceDirName:"guides-references",slug:"/guides-references/cluster-images",permalink:"/docs/0.4.3/guides-references/cluster-images",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.3/guides-references/cluster-images.md",tags:[],version:"0.4.3",frontMatter:{title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/docs/0.4.3/guides-references/overview"},next:{title:"RGS Carbide Customers",permalink:"/docs/0.4.3/guides-references/carbide-customers"}},c={},d=[{value:"Example Output",id:"example-output",level:3},{value:"Hauler Manifest using the Images",id:"hauler-manifest-using-the-images",level:3},{value:"Resulting Hauler Manifest",id:"resulting-hauler-manifest",level:3}];function o(e){const n={code:"code",h3:"h3",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsxs)(n.p,{children:["It may be difficult to understand exactly what ",(0,a.jsx)(n.code,{children:"content"})," is actively within your environment. Below is a simple way to generate a list of all images running in your environment, store it as an environment variable, and show the list by echoing the environment variable."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"export IMAGE_LIST=$(kubectl get pods --all-namespaces -o jsonpath=\"{.items[*].spec.containers[*].image}\" |tr -s '[[:space:]]' '\\n' |sort |uniq -c | cut -c 9-)\necho \"$IMAGE_LIST\"\n"})}),"\n",(0,a.jsx)(n.h3,{id:"example-output",children:"Example Output"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:"index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\nindex.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\nindex.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\nrancher/hardened-calico:v3.21.4-build20220228\nrancher/hardened-cluster-autoscaler:v1.8.5-build20211119\nrancher/hardened-coredns:v1.9.1-build20220318\nrancher/hardened-flannel:v0.17.0-build20220317\nrancher/hardened-k8s-metrics-server:v0.5.0-build20211119\nrancher/klipper-helm:v0.7.0-build20220315\nrancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})}),"\n",(0,a.jsx)(n.h3,{id:"hauler-manifest-using-the-images",children:"Hauler Manifest using the Images"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:"IMAGE_LIST_MODIFIED=$(cat \"$IMAGE_LIST\" | sed 's/^/ - name: /')\n# sed, stream editor, appends 2 spaces of indentation denotes\n# an entry in a list, then adds name: to match expected syntax\n"})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images-example\nspec:\n images:\n$IMAGE_LIST_MODIFIED\n"})}),"\n",(0,a.jsx)(n.h3,{id:"resulting-hauler-manifest",children:"Resulting Hauler Manifest"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images-example\nspec:\n images:\n - name: index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\n - name: index.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\n - name: index.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\n - name: rancher/hardened-calico:v3.21.4-build20220228\n - name: rancher/hardened-cluster-autoscaler:v1.8.5-build20211119\n - name: rancher/hardened-coredns:v1.9.1-build20220318\n - name: rancher/hardened-flannel:v0.17.0-build20220317\n - name: rancher/hardened-k8s-metrics-server:v0.5.0-build20211119\n - name: rancher/klipper-helm:v0.7.0-build20220315\n - name: rancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(o,{...e})}):o(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>l});var a=r(6540);const s={},t=a.createContext(s);function i(e){const n=a.useContext(t);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),a.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5ce9c3d1.ca06ac7e.js b/assets/js/5ce9c3d1.ca06ac7e.js deleted file mode 100644 index 0d23baaee..000000000 --- a/assets/js/5ce9c3d1.ca06ac7e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5722],{6806:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var r=n(4848),s=n(8453);const a={title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',sidebar_label:"Charts"},o=void 0,c={id:"guides-references/hauler-content/charts",title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',source:"@site/versioned_docs/version-0.4.2/guides-references/hauler-content/charts.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/charts",permalink:"/hauler-docs/docs/0.4.2/guides-references/hauler-content/charts",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.2/guides-references/hauler-content/charts.md",tags:[],version:"0.4.2",frontMatter:{title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',sidebar_label:"Charts"},sidebar:"haulerSidebar",previous:{title:"Images",permalink:"/hauler-docs/docs/0.4.2/guides-references/hauler-content/images"},next:{title:"Files",permalink:"/hauler-docs/docs/0.4.2/guides-references/hauler-content/files"}},i={},l=[];function d(e){const t={admonition:"admonition",code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.admonition,{type:"tip",children:(0,r.jsx)(t.p,{children:"Hauler supports the experimental format of Helm Chart OCI Artifacts, but can also be represented as the usual Tarball Artifact!"})}),"\n",(0,r.jsx)(t.p,{children:"Helm charts represented as OCI content:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:'# add a helm chart (defaults to latest version)\nhauler store add chart loki --repo "https://grafana.github.io/helm-charts"\n\n# add a specific version of a helm chart\nhauler store add chart loki --repo "https://grafana.github.io/helm-charts" --version 2.8.1\n\n# install directly from the oci content\nHELM_EXPERIMENTAL_OCI=1 helm install loki oci://localhost:3000/library/loki --version 2.8.1\n'})})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>c});var r=n(6540);const s={},a=r.createContext(s);function o(e){const t=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5ce9c3d1.cfc89731.js b/assets/js/5ce9c3d1.cfc89731.js new file mode 100644 index 000000000..660e33016 --- /dev/null +++ b/assets/js/5ce9c3d1.cfc89731.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5722],{6806:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>u,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var r=n(4848),s=n(8453);const a={title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',sidebar_label:"Charts"},o=void 0,i={id:"guides-references/hauler-content/charts",title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',source:"@site/versioned_docs/version-0.4.2/guides-references/hauler-content/charts.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/charts",permalink:"/docs/0.4.2/guides-references/hauler-content/charts",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.2/guides-references/hauler-content/charts.md",tags:[],version:"0.4.2",frontMatter:{title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',sidebar_label:"Charts"},sidebar:"haulerSidebar",previous:{title:"Images",permalink:"/docs/0.4.2/guides-references/hauler-content/images"},next:{title:"Files",permalink:"/docs/0.4.2/guides-references/hauler-content/files"}},c={},l=[];function d(e){const t={admonition:"admonition",code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.admonition,{type:"tip",children:(0,r.jsx)(t.p,{children:"Hauler supports the experimental format of Helm Chart OCI Artifacts, but can also be represented as the usual Tarball Artifact!"})}),"\n",(0,r.jsx)(t.p,{children:"Helm charts represented as OCI content:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:'# add a helm chart (defaults to latest version)\nhauler store add chart loki --repo "https://grafana.github.io/helm-charts"\n\n# add a specific version of a helm chart\nhauler store add chart loki --repo "https://grafana.github.io/helm-charts" --version 2.8.1\n\n# install directly from the oci content\nHELM_EXPERIMENTAL_OCI=1 helm install loki oci://localhost:3000/library/loki --version 2.8.1\n'})})]})}function u(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>i});var r=n(6540);const s={},a=r.createContext(s);function o(e){const t=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5d1761f8.201f8110.js b/assets/js/5d1761f8.201f8110.js new file mode 100644 index 000000000..4941bf917 --- /dev/null +++ b/assets/js/5d1761f8.201f8110.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5917],{260:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>o});var n=r(4848),i=r(8453);const s={title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},l=void 0,c={id:"guides-references/overview",title:"Overview",description:"Reference Guides Overview Documentation for Hauler",source:"@site/docs/guides-references/overview.md",sourceDirName:"guides-references",slug:"/guides-references/overview",permalink:"/docs/next/guides-references/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/docs/guides-references/overview.md",tags:[],version:"current",frontMatter:{title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Uninstall",permalink:"/docs/next/introduction/uninstall"},next:{title:"Fetch Cluster Images",permalink:"/docs/next/guides-references/cluster-images"}},d={},o=[{value:"Hauler Guides & Reference Documentation",id:"hauler-guides--reference-documentation",level:2}];function a(e){const t={a:"a",h2:"h2",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Additional Overview Documentation pending a future release!"}),"\n",(0,n.jsx)(t.h2,{id:"hauler-guides--reference-documentation",children:"Hauler Guides & Reference Documentation"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Guide or Reference Documentation"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"cluster-images",children:"Fetch Cluster Images"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Fetch All Images on a Cluster"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"carbide-customers",children:"RGS Carbide Customers"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of Addons for Carbide Customers"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"utilities/registry",children:"Bootstrapping Utilities"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of Hauler Bootstrapping Utilities"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"manifests",children:"Hauler Manifests"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of Hauler Manifests"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-collections/community-collections",children:"Hauler Collections"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of Hauler Collections"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-content/images",children:"Hauler Content"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of Hauler Content Types"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"command-line/hauler",children:"Hauler Command Line"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of the Hauler Command Line Interface"})]})]})]})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>l,x:()=>c});var n=r(6540);const i={},s=n.createContext(i);function l(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5d1761f8.b860c750.js b/assets/js/5d1761f8.b860c750.js deleted file mode 100644 index 49dff1c97..000000000 --- a/assets/js/5d1761f8.b860c750.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5917],{260:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>o});var n=r(4848),i=r(8453);const s={title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},l=void 0,c={id:"guides-references/overview",title:"Overview",description:"Reference Guides Overview Documentation for Hauler",source:"@site/docs/guides-references/overview.md",sourceDirName:"guides-references",slug:"/guides-references/overview",permalink:"/hauler-docs/docs/next/guides-references/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/docs/guides-references/overview.md",tags:[],version:"current",frontMatter:{title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Uninstall",permalink:"/hauler-docs/docs/next/introduction/uninstall"},next:{title:"Fetch Cluster Images",permalink:"/hauler-docs/docs/next/guides-references/cluster-images"}},d={},o=[{value:"Hauler Guides & Reference Documentation",id:"hauler-guides--reference-documentation",level:2}];function a(e){const t={a:"a",h2:"h2",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Additional Overview Documentation pending a future release!"}),"\n",(0,n.jsx)(t.h2,{id:"hauler-guides--reference-documentation",children:"Hauler Guides & Reference Documentation"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Guide or Reference Documentation"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"cluster-images",children:"Fetch Cluster Images"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Fetch All Images on a Cluster"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"carbide-customers",children:"RGS Carbide Customers"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of Addons for Carbide Customers"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"utilities/registry",children:"Bootstrapping Utilities"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of Hauler Bootstrapping Utilities"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"manifests",children:"Hauler Manifests"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of Hauler Manifests"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-collections/community-collections",children:"Hauler Collections"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of Hauler Collections"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-content/images",children:"Hauler Content"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of Hauler Content Types"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"command-line/hauler",children:"Hauler Command Line"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Overview of the Hauler Command Line Interface"})]})]})]})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>l,x:()=>c});var n=r(6540);const i={},s=n.createContext(i);function l(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5d33113d.39757f09.js b/assets/js/5d33113d.39757f09.js deleted file mode 100644 index 712315400..000000000 --- a/assets/js/5d33113d.39757f09.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1397],{4166:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>l,toc:()=>a});var r=n(4848),s=n(8453);const o={title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',sidebar_label:"Files"},i=void 0,l={id:"guides-references/hauler-content/files",title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',source:"@site/versioned_docs/version-0.4.4/guides-references/hauler-content/files.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/files",permalink:"/hauler-docs/docs/0.4.4/guides-references/hauler-content/files",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.4/guides-references/hauler-content/files.md",tags:[],version:"0.4.4",frontMatter:{title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',sidebar_label:"Files"},sidebar:"haulerSidebar",previous:{title:"Charts",permalink:"/hauler-docs/docs/0.4.4/guides-references/hauler-content/charts"},next:{title:"Hauler",permalink:"/hauler-docs/docs/0.4.4/guides-references/command-line/hauler"}},c={},a=[];function u(e){const t={code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.p,{children:"Generic content that can be represented as a file, either sourced locally or remotely:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-yaml",children:"# local file\nhauler store add file path/to/local/file.txt\n\n# remote file with name\nhauler store add file https://get.rke2.io --name install.sh\n"})})]})}function d(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>l});var r=n(6540);const s={},o=r.createContext(s);function i(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5d33113d.72ab72ad.js b/assets/js/5d33113d.72ab72ad.js new file mode 100644 index 000000000..3572ec27d --- /dev/null +++ b/assets/js/5d33113d.72ab72ad.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1397],{4166:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>l,toc:()=>a});var r=n(4848),s=n(8453);const o={title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',sidebar_label:"Files"},i=void 0,l={id:"guides-references/hauler-content/files",title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',source:"@site/versioned_docs/version-0.4.4/guides-references/hauler-content/files.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/files",permalink:"/docs/0.4.4/guides-references/hauler-content/files",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.4/guides-references/hauler-content/files.md",tags:[],version:"0.4.4",frontMatter:{title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',sidebar_label:"Files"},sidebar:"haulerSidebar",previous:{title:"Charts",permalink:"/docs/0.4.4/guides-references/hauler-content/charts"},next:{title:"Hauler",permalink:"/docs/0.4.4/guides-references/command-line/hauler"}},c={},a=[];function u(e){const t={code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.p,{children:"Generic content that can be represented as a file, either sourced locally or remotely:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-yaml",children:"# local file\nhauler store add file path/to/local/file.txt\n\n# remote file with name\nhauler store add file https://get.rke2.io --name install.sh\n"})})]})}function d(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>l});var r=n(6540);const s={},o=r.createContext(s);function i(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5d8bfdfe.1ceb3f07.js b/assets/js/5d8bfdfe.1ceb3f07.js deleted file mode 100644 index 392da9417..000000000 --- a/assets/js/5d8bfdfe.1ceb3f07.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[31],{6832:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>c,default:()=>l,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var r=t(4848),s=t(8453);const a={title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',sidebar_label:"Images"},c=void 0,o={id:"guides-references/hauler-content/images",title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',source:"@site/versioned_docs/version-0.4.1/guides-references/hauler-content/images.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/images",permalink:"/hauler-docs/docs/0.4.1/guides-references/hauler-content/images",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.1/guides-references/hauler-content/images.md",tags:[],version:"0.4.1",frontMatter:{title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',sidebar_label:"Images"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/hauler-docs/docs/0.4.1/guides-references/hauler-content/overview"},next:{title:"Charts",permalink:"/hauler-docs/docs/0.4.1/guides-references/hauler-content/charts"}},i={},d=[];function u(e){const n={code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.p,{children:"Any OCI compatible image can be fetched remotely:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'# "shorthand" image references\nhauler store add image rancher/rancher:v2.7.9\n\n# fully qualified image references\nhauler store add image ghcr.io/fluxcd/flux-cli@sha256:02aa820c3a9c57d67208afcfc4bce9661658c17d15940aea369da259d2b976dd\n'})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>o});var r=t(6540);const s={},a=r.createContext(s);function c(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5d8bfdfe.dee27d0b.js b/assets/js/5d8bfdfe.dee27d0b.js new file mode 100644 index 000000000..174439700 --- /dev/null +++ b/assets/js/5d8bfdfe.dee27d0b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[31],{6832:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>o,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var r=t(4848),s=t(8453);const a={title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',sidebar_label:"Images"},o=void 0,c={id:"guides-references/hauler-content/images",title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',source:"@site/versioned_docs/version-0.4.1/guides-references/hauler-content/images.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/images",permalink:"/docs/0.4.1/guides-references/hauler-content/images",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.1/guides-references/hauler-content/images.md",tags:[],version:"0.4.1",frontMatter:{title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',sidebar_label:"Images"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/docs/0.4.1/guides-references/hauler-content/overview"},next:{title:"Charts",permalink:"/docs/0.4.1/guides-references/hauler-content/charts"}},i={},d=[];function u(e){const n={code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.p,{children:"Any OCI compatible image can be fetched remotely:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'# "shorthand" image references\nhauler store add image rancher/rancher:v2.7.9\n\n# fully qualified image references\nhauler store add image ghcr.io/fluxcd/flux-cli@sha256:02aa820c3a9c57d67208afcfc4bce9661658c17d15940aea369da259d2b976dd\n'})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>c});var r=t(6540);const s={},a=r.createContext(s);function o(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5d94dea0.2a3acad4.js b/assets/js/5d94dea0.2a3acad4.js new file mode 100644 index 000000000..d7727476a --- /dev/null +++ b/assets/js/5d94dea0.2a3acad4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9845],{427:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var r=t(4848),s=t(8453);const o={title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},i="Rancher Government Hauler",a={id:"intro",title:"Introduction",description:"Introduction to Rancher Government Hauler",source:"@site/versioned_docs/version-1.0.0/intro.md",sourceDirName:".",slug:"/intro",permalink:"/docs/1.0.0/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.0/intro.md",tags:[],version:"1.0.0",frontMatter:{title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},sidebar:"haulerSidebar",next:{title:"Core Concepts",permalink:"/docs/1.0.0/core-concepts"}},c={},l=[{value:"What's Hauler?",id:"whats-hauler",level:2},{value:"Acknowledgements",id:"acknowledgements",level:2}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"rancher-government-hauler",children:"Rancher Government Hauler"}),"\n",(0,r.jsx)(n.h1,{id:"airgap-swiss-army-knife",children:"Airgap Swiss Army Knife"}),"\n",(0,r.jsxs)(n.admonition,{type:"caution",children:[(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Please Note:"})," Hauler and the Hauler Documentation are recently Generally Available (GA)."]}),(0,r.jsxs)(n.p,{children:["Please help us by submitting any issues via ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler-docs/issues",children:"GitHub Issues"})})," and make sure to review the ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"/docs/known-limits",children:"Known Issues and Limitations"})}),"!"]})]}),"\n",(0,r.jsx)(n.h2,{id:"whats-hauler",children:"What's Hauler?"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Rancher Government Hauler"})," simplifies the airgap experience without requiring operators to adopt a specific workflow. ",(0,r.jsx)(n.code,{children:"Hauler"})," simplifies the airgapping process, by representing assets (images, charts, files, etc...) as content and collections to allow operators to easily fetch, store, package, and distribute these assets with declarative manifests or through the command line."]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Hauler"})," does this by storing contents and collections as OCI Artifacts and allows operators to serve contents and collections with an embedded registry and fileserver. Additionally, ",(0,r.jsx)(n.code,{children:"Hauler"})," has the ability to store and inspect various non-image OCI Artifacts."]}),"\n",(0,r.jsx)(n.h2,{id:"acknowledgements",children:"Acknowledgements"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Hauler"})," wouldn't be possible without the open-source community, but there are a few projects that stand out:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/oras-project/oras",children:"oras cli"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/sigstore/cosign",children:"cosign"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/google/go-containerregistry",children:"go-containerregistry"})}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>a});var r=t(6540);const s={},o=r.createContext(s);function i(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5d94dea0.99aa5313.js b/assets/js/5d94dea0.99aa5313.js deleted file mode 100644 index 33d3b72c6..000000000 --- a/assets/js/5d94dea0.99aa5313.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9845],{427:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>o,metadata:()=>a,toc:()=>l});var r=t(4848),s=t(8453);const o={title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},i="Rancher Government Hauler",a={id:"intro",title:"Introduction",description:"Introduction to Rancher Government Hauler",source:"@site/versioned_docs/version-1.0.0/intro.md",sourceDirName:".",slug:"/intro",permalink:"/hauler-docs/docs/1.0.0/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.0/intro.md",tags:[],version:"1.0.0",frontMatter:{title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},sidebar:"haulerSidebar",next:{title:"Core Concepts",permalink:"/hauler-docs/docs/1.0.0/core-concepts"}},c={},l=[{value:"What's Hauler?",id:"whats-hauler",level:2},{value:"Acknowledgements",id:"acknowledgements",level:2}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"rancher-government-hauler",children:"Rancher Government Hauler"}),"\n",(0,r.jsx)(n.h1,{id:"airgap-swiss-army-knife",children:"Airgap Swiss Army Knife"}),"\n",(0,r.jsxs)(n.admonition,{type:"caution",children:[(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Please Note:"})," Hauler and the Hauler Documentation are recently Generally Available (GA)."]}),(0,r.jsxs)(n.p,{children:["Please help us by submitting any issues via ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler-docs/issues",children:"GitHub Issues"})})," and make sure to review the ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"/docs/known-limits",children:"Known Issues and Limitations"})}),"!"]})]}),"\n",(0,r.jsx)(n.h2,{id:"whats-hauler",children:"What's Hauler?"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Rancher Government Hauler"})," simplifies the airgap experience without requiring operators to adopt a specific workflow. ",(0,r.jsx)(n.code,{children:"Hauler"})," simplifies the airgapping process, by representing assets (images, charts, files, etc...) as content and collections to allow operators to easily fetch, store, package, and distribute these assets with declarative manifests or through the command line."]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Hauler"})," does this by storing contents and collections as OCI Artifacts and allows operators to serve contents and collections with an embedded registry and fileserver. Additionally, ",(0,r.jsx)(n.code,{children:"Hauler"})," has the ability to store and inspect various non-image OCI Artifacts."]}),"\n",(0,r.jsx)(n.h2,{id:"acknowledgements",children:"Acknowledgements"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Hauler"})," wouldn't be possible without the open-source community, but there are a few projects that stand out:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/oras-project/oras",children:"oras cli"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/sigstore/cosign",children:"cosign"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/google/go-containerregistry",children:"go-containerregistry"})}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>a});var r=t(6540);const s={},o=r.createContext(s);function i(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5fae9c9a.849f5d13.js b/assets/js/5fae9c9a.849f5d13.js new file mode 100644 index 000000000..7dc1f2d7d --- /dev/null +++ b/assets/js/5fae9c9a.849f5d13.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9662],{321:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>o,frontMatter:()=>s,metadata:()=>l,toc:()=>d});var a=r(4848),t=r(8453);const s={title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},i=void 0,l={id:"guides-references/cluster-images",title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",source:"@site/versioned_docs/version-1.0.0/guides-references/cluster-images.md",sourceDirName:"guides-references",slug:"/guides-references/cluster-images",permalink:"/docs/1.0.0/guides-references/cluster-images",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.0/guides-references/cluster-images.md",tags:[],version:"1.0.0",frontMatter:{title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},sidebar:"haulerSidebar",previous:{title:"Hauler Manifests",permalink:"/docs/1.0.0/guides-references/manifests"},next:{title:"RGS Carbide Customers",permalink:"/docs/1.0.0/guides-references/carbide-customers"}},c={},d=[{value:"Fetch Cluster Images",id:"fetch-cluster-images",level:2},{value:"Example Output",id:"example-output",level:2},{value:"Generate Hauler Manifest",id:"generate-hauler-manifest",level:2},{value:"Resulting Hauler Manifest",id:"resulting-hauler-manifest",level:2}];function u(e){const n={code:"code",h2:"h2",p:"p",pre:"pre",...(0,t.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsxs)(n.p,{children:["It may be difficult to understand exactly what ",(0,a.jsx)(n.code,{children:"content"})," is actively within your environment. Below is a simple way to generate a list of all images running in your environment, store it as an environment variable, and show the list by echoing the environment variable."]}),"\n",(0,a.jsx)(n.h2,{id:"fetch-cluster-images",children:"Fetch Cluster Images"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"# fetch all images in the cluster, remove duplicates, alphabetize, and put on a newline\nexport IMAGE_LIST=$(kubectl get pods --all-namespaces -o jsonpath=\"{.items[*].spec.containers[*].image}\" | sed 's/ /\\n/g' | sort | uniq)\n"})}),"\n",(0,a.jsx)(n.h2,{id:"example-output",children:"Example Output"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"# view the list of images from the cluster\necho $IMAGE_LIST\nindex.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\nindex.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\nindex.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\nrancher/hardened-calico:v3.21.4-build20220228\nrancher/hardened-cluster-autoscaler:v1.8.5-build20211119\nrancher/hardened-coredns:v1.9.1-build20220318\nrancher/hardened-flannel:v0.17.0-build20220317\nrancher/hardened-k8s-metrics-server:v0.5.0-build20211119\nrancher/klipper-helm:v0.7.0-build20220315\nrancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})}),"\n",(0,a.jsx)(n.h2,{id:"generate-hauler-manifest",children:"Generate Hauler Manifest"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"# add the required formatting for the image list\nexport IMAGE_LIST_MODIFIED=$(echo \"${IMAGE_LIST} | sed 's/^/ - name: /'\")\n\n# create the hauler manifest with the updated image list\ncat << EOF >> hauler-manifest.yaml\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images\nspec:\n images:\n$IMAGE_LIST_MODIFIED\nEOF\n"})}),"\n",(0,a.jsx)(n.h2,{id:"resulting-hauler-manifest",children:"Resulting Hauler Manifest"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images\nspec:\n images:\n - name: index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\n - name: index.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\n - name: index.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\n - name: rancher/hardened-calico:v3.21.4-build20220228\n - name: rancher/hardened-cluster-autoscaler:v1.8.5-build20211119\n - name: rancher/hardened-coredns:v1.9.1-build20220318\n - name: rancher/hardened-flannel:v0.17.0-build20220317\n - name: rancher/hardened-k8s-metrics-server:v0.5.0-build20211119\n - name: rancher/klipper-helm:v0.7.0-build20220315\n - name: rancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})})]})}function o(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>l});var a=r(6540);const t={},s=a.createContext(t);function i(e){const n=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),a.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5fae9c9a.c3f20d64.js b/assets/js/5fae9c9a.c3f20d64.js deleted file mode 100644 index 2d6174261..000000000 --- a/assets/js/5fae9c9a.c3f20d64.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9662],{321:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>s,metadata:()=>l,toc:()=>d});var a=r(4848),t=r(8453);const s={title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},i=void 0,l={id:"guides-references/cluster-images",title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",source:"@site/versioned_docs/version-1.0.0/guides-references/cluster-images.md",sourceDirName:"guides-references",slug:"/guides-references/cluster-images",permalink:"/hauler-docs/docs/1.0.0/guides-references/cluster-images",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.0/guides-references/cluster-images.md",tags:[],version:"1.0.0",frontMatter:{title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},sidebar:"haulerSidebar",previous:{title:"Hauler Manifests",permalink:"/hauler-docs/docs/1.0.0/guides-references/manifests"},next:{title:"RGS Carbide Customers",permalink:"/hauler-docs/docs/1.0.0/guides-references/carbide-customers"}},c={},d=[{value:"Fetch Cluster Images",id:"fetch-cluster-images",level:2},{value:"Example Output",id:"example-output",level:2},{value:"Generate Hauler Manifest",id:"generate-hauler-manifest",level:2},{value:"Resulting Hauler Manifest",id:"resulting-hauler-manifest",level:2}];function o(e){const n={code:"code",h2:"h2",p:"p",pre:"pre",...(0,t.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsxs)(n.p,{children:["It may be difficult to understand exactly what ",(0,a.jsx)(n.code,{children:"content"})," is actively within your environment. Below is a simple way to generate a list of all images running in your environment, store it as an environment variable, and show the list by echoing the environment variable."]}),"\n",(0,a.jsx)(n.h2,{id:"fetch-cluster-images",children:"Fetch Cluster Images"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"# fetch all images in the cluster, remove duplicates, alphabetize, and put on a newline\nexport IMAGE_LIST=$(kubectl get pods --all-namespaces -o jsonpath=\"{.items[*].spec.containers[*].image}\" | sed 's/ /\\n/g' | sort | uniq)\n"})}),"\n",(0,a.jsx)(n.h2,{id:"example-output",children:"Example Output"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"# view the list of images from the cluster\necho $IMAGE_LIST\nindex.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\nindex.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\nindex.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\nrancher/hardened-calico:v3.21.4-build20220228\nrancher/hardened-cluster-autoscaler:v1.8.5-build20211119\nrancher/hardened-coredns:v1.9.1-build20220318\nrancher/hardened-flannel:v0.17.0-build20220317\nrancher/hardened-k8s-metrics-server:v0.5.0-build20211119\nrancher/klipper-helm:v0.7.0-build20220315\nrancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})}),"\n",(0,a.jsx)(n.h2,{id:"generate-hauler-manifest",children:"Generate Hauler Manifest"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"# add the required formatting for the image list\nexport IMAGE_LIST_MODIFIED=$(echo \"${IMAGE_LIST} | sed 's/^/ - name: /'\")\n\n# create the hauler manifest with the updated image list\ncat << EOF >> hauler-manifest.yaml\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images\nspec:\n images:\n$IMAGE_LIST_MODIFIED\nEOF\n"})}),"\n",(0,a.jsx)(n.h2,{id:"resulting-hauler-manifest",children:"Resulting Hauler Manifest"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images\nspec:\n images:\n - name: index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\n - name: index.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\n - name: index.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\n - name: rancher/hardened-calico:v3.21.4-build20220228\n - name: rancher/hardened-cluster-autoscaler:v1.8.5-build20211119\n - name: rancher/hardened-coredns:v1.9.1-build20220318\n - name: rancher/hardened-flannel:v0.17.0-build20220317\n - name: rancher/hardened-k8s-metrics-server:v0.5.0-build20211119\n - name: rancher/klipper-helm:v0.7.0-build20220315\n - name: rancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(o,{...e})}):o(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>l});var a=r(6540);const t={},s=a.createContext(t);function i(e){const n=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),a.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/673a5700.03d4b7d2.js b/assets/js/673a5700.03d4b7d2.js new file mode 100644 index 000000000..1a1e2adb7 --- /dev/null +++ b/assets/js/673a5700.03d4b7d2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1753],{1803:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>u,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var r=n(4848),s=n(8453);const a={title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',sidebar_label:"Charts"},o=void 0,i={id:"guides-references/hauler-content/charts",title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',source:"@site/versioned_docs/version-0.4.1/guides-references/hauler-content/charts.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/charts",permalink:"/docs/0.4.1/guides-references/hauler-content/charts",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.1/guides-references/hauler-content/charts.md",tags:[],version:"0.4.1",frontMatter:{title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',sidebar_label:"Charts"},sidebar:"haulerSidebar",previous:{title:"Images",permalink:"/docs/0.4.1/guides-references/hauler-content/images"},next:{title:"Files",permalink:"/docs/0.4.1/guides-references/hauler-content/files"}},c={},l=[];function d(e){const t={admonition:"admonition",code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.admonition,{type:"tip",children:(0,r.jsx)(t.p,{children:"Hauler supports the experimental format of Helm Chart OCI Artifacts, but can also be represented as the usual Tarball Artifact!"})}),"\n",(0,r.jsx)(t.p,{children:"Helm charts represented as OCI content:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:'# add a helm chart (defaults to latest version)\nhauler store add chart loki --repo "https://grafana.github.io/helm-charts"\n\n# add a specific version of a helm chart\nhauler store add chart loki --repo "https://grafana.github.io/helm-charts" --version 2.8.1\n\n# install directly from the oci content\nHELM_EXPERIMENTAL_OCI=1 helm install loki oci://localhost:3000/library/loki --version 2.8.1\n'})})]})}function u(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>i});var r=n(6540);const s={},a=r.createContext(s);function o(e){const t=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/673a5700.f2784c76.js b/assets/js/673a5700.f2784c76.js deleted file mode 100644 index f76c8b43a..000000000 --- a/assets/js/673a5700.f2784c76.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1753],{1803:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var r=n(4848),s=n(8453);const a={title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',sidebar_label:"Charts"},o=void 0,c={id:"guides-references/hauler-content/charts",title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',source:"@site/versioned_docs/version-0.4.1/guides-references/hauler-content/charts.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/charts",permalink:"/hauler-docs/docs/0.4.1/guides-references/hauler-content/charts",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.1/guides-references/hauler-content/charts.md",tags:[],version:"0.4.1",frontMatter:{title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',sidebar_label:"Charts"},sidebar:"haulerSidebar",previous:{title:"Images",permalink:"/hauler-docs/docs/0.4.1/guides-references/hauler-content/images"},next:{title:"Files",permalink:"/hauler-docs/docs/0.4.1/guides-references/hauler-content/files"}},i={},l=[];function d(e){const t={admonition:"admonition",code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.admonition,{type:"tip",children:(0,r.jsx)(t.p,{children:"Hauler supports the experimental format of Helm Chart OCI Artifacts, but can also be represented as the usual Tarball Artifact!"})}),"\n",(0,r.jsx)(t.p,{children:"Helm charts represented as OCI content:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:'# add a helm chart (defaults to latest version)\nhauler store add chart loki --repo "https://grafana.github.io/helm-charts"\n\n# add a specific version of a helm chart\nhauler store add chart loki --repo "https://grafana.github.io/helm-charts" --version 2.8.1\n\n# install directly from the oci content\nHELM_EXPERIMENTAL_OCI=1 helm install loki oci://localhost:3000/library/loki --version 2.8.1\n'})})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>c});var r=n(6540);const s={},a=r.createContext(s);function o(e){const t=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/678a4048.4841f25b.js b/assets/js/678a4048.4841f25b.js deleted file mode 100644 index a2bec9c70..000000000 --- a/assets/js/678a4048.4841f25b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7879],{6045:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>l});var r=t(4848),s=t(8453);const i={title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},o="Rancher Government Hauler",a={id:"intro",title:"Introduction",description:"Introduction to Rancher Government Hauler",source:"@site/versioned_docs/version-0.4.2/intro.md",sourceDirName:".",slug:"/intro",permalink:"/hauler-docs/docs/0.4.2/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.2/intro.md",tags:[],version:"0.4.2",frontMatter:{title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},sidebar:"haulerSidebar",next:{title:"Core Concepts",permalink:"/hauler-docs/docs/0.4.2/core-concepts"}},c={},l=[{value:"What's Hauler?",id:"whats-hauler",level:2},{value:"Acknowledgements",id:"acknowledgements",level:2}];function d(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"rancher-government-hauler",children:"Rancher Government Hauler"}),"\n",(0,r.jsx)(n.h1,{id:"airgap-swiss-army-knife",children:"Airgap Swiss Army Knife"}),"\n",(0,r.jsxs)(n.admonition,{type:"caution",children:[(0,r.jsx)(n.p,{children:(0,r.jsxs)(n.strong,{children:["Note: Hauler and it's documentation are in active development and ",(0,r.jsx)(n.em,{children:"not Generally Available (GA)"}),"."]})}),(0,r.jsxs)(n.p,{children:["Most of the core functionality and features are ready for use, but may have breaking changes in future releases. Please help us by submitting any issues via ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler-docs/issues",children:"GitHub Issues"})})," and make sure to review the ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"/docs/known-limits",children:"Known Issues and Limitations"})}),"!"]})]}),"\n",(0,r.jsx)(n.h2,{id:"whats-hauler",children:"What's Hauler?"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Rancher Government Hauler"})," simplifies the airgap experience without requiring users to adopt a specific workflow. ",(0,r.jsx)(n.code,{children:"Hauler"})," simplifies the airgapping process, by representing assets (images, charts, files, etc...) as content and collections to allow users to easily fetch, store, package, and distribute these assets with declarative manifests or through the command line."]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Hauler"})," does this by storing contents and collections as OCI Artifacts and allows users to serve contents and collections with an embedded registry and fileserver. Additionally, ",(0,r.jsx)(n.code,{children:"Hauler"})," has the ability to store and inspect various non-image OCI Artifacts."]}),"\n",(0,r.jsx)(n.h2,{id:"acknowledgements",children:"Acknowledgements"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Hauler"})," wouldn't be possible without the open-source community, but there are a few projects that stand out:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/google/go-containerregistry",children:"go-containerregistry"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/oras-project/oras",children:"oras cli"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/sigstore/cosign",children:"cosign"})}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var r=t(6540);const s={},i=r.createContext(s);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/678a4048.b1b86667.js b/assets/js/678a4048.b1b86667.js new file mode 100644 index 000000000..a9f00e65a --- /dev/null +++ b/assets/js/678a4048.b1b86667.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7879],{6045:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>l});var r=t(4848),s=t(8453);const i={title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},o="Rancher Government Hauler",a={id:"intro",title:"Introduction",description:"Introduction to Rancher Government Hauler",source:"@site/versioned_docs/version-0.4.2/intro.md",sourceDirName:".",slug:"/intro",permalink:"/docs/0.4.2/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.2/intro.md",tags:[],version:"0.4.2",frontMatter:{title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},sidebar:"haulerSidebar",next:{title:"Core Concepts",permalink:"/docs/0.4.2/core-concepts"}},c={},l=[{value:"What's Hauler?",id:"whats-hauler",level:2},{value:"Acknowledgements",id:"acknowledgements",level:2}];function d(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"rancher-government-hauler",children:"Rancher Government Hauler"}),"\n",(0,r.jsx)(n.h1,{id:"airgap-swiss-army-knife",children:"Airgap Swiss Army Knife"}),"\n",(0,r.jsxs)(n.admonition,{type:"caution",children:[(0,r.jsx)(n.p,{children:(0,r.jsxs)(n.strong,{children:["Note: Hauler and it's documentation are in active development and ",(0,r.jsx)(n.em,{children:"not Generally Available (GA)"}),"."]})}),(0,r.jsxs)(n.p,{children:["Most of the core functionality and features are ready for use, but may have breaking changes in future releases. Please help us by submitting any issues via ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler-docs/issues",children:"GitHub Issues"})})," and make sure to review the ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"/docs/known-limits",children:"Known Issues and Limitations"})}),"!"]})]}),"\n",(0,r.jsx)(n.h2,{id:"whats-hauler",children:"What's Hauler?"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Rancher Government Hauler"})," simplifies the airgap experience without requiring users to adopt a specific workflow. ",(0,r.jsx)(n.code,{children:"Hauler"})," simplifies the airgapping process, by representing assets (images, charts, files, etc...) as content and collections to allow users to easily fetch, store, package, and distribute these assets with declarative manifests or through the command line."]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Hauler"})," does this by storing contents and collections as OCI Artifacts and allows users to serve contents and collections with an embedded registry and fileserver. Additionally, ",(0,r.jsx)(n.code,{children:"Hauler"})," has the ability to store and inspect various non-image OCI Artifacts."]}),"\n",(0,r.jsx)(n.h2,{id:"acknowledgements",children:"Acknowledgements"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Hauler"})," wouldn't be possible without the open-source community, but there are a few projects that stand out:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/google/go-containerregistry",children:"go-containerregistry"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/oras-project/oras",children:"oras cli"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/sigstore/cosign",children:"cosign"})}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var r=t(6540);const s={},i=r.createContext(s);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/68084510.244260c9.js b/assets/js/68084510.244260c9.js new file mode 100644 index 000000000..b4a97d35c --- /dev/null +++ b/assets/js/68084510.244260c9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4891],{9208:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>u,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var r=n(4848),s=n(8453);const a={title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',sidebar_label:"Charts"},o=void 0,i={id:"guides-references/hauler-content/charts",title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',source:"@site/versioned_docs/version-0.4.0/guides-references/hauler-content/charts.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/charts",permalink:"/docs/0.4.0/guides-references/hauler-content/charts",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.0/guides-references/hauler-content/charts.md",tags:[],version:"0.4.0",frontMatter:{title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',sidebar_label:"Charts"},sidebar:"haulerSidebar",previous:{title:"Images",permalink:"/docs/0.4.0/guides-references/hauler-content/images"},next:{title:"Files",permalink:"/docs/0.4.0/guides-references/hauler-content/files"}},c={},l=[];function d(e){const t={admonition:"admonition",code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.admonition,{type:"tip",children:(0,r.jsx)(t.p,{children:"Hauler supports the experimental format of Helm Chart OCI Artifacts, but can also be represented as the usual Tarball Artifact!"})}),"\n",(0,r.jsx)(t.p,{children:"Helm charts represented as OCI content:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:'# add a helm chart (defaults to latest version)\nhauler store add chart loki --repo "https://grafana.github.io/helm-charts"\n\n# add a specific version of a helm chart\nhauler store add chart loki --repo "https://grafana.github.io/helm-charts" --version 2.8.1\n\n# install directly from the oci content\nHELM_EXPERIMENTAL_OCI=1 helm install loki oci://localhost:3000/library/loki --version 2.8.1\n'})})]})}function u(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>i});var r=n(6540);const s={},a=r.createContext(s);function o(e){const t=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/68084510.47681db7.js b/assets/js/68084510.47681db7.js deleted file mode 100644 index 37ceb41de..000000000 --- a/assets/js/68084510.47681db7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4891],{9208:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var r=n(4848),s=n(8453);const a={title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',sidebar_label:"Charts"},o=void 0,c={id:"guides-references/hauler-content/charts",title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',source:"@site/versioned_docs/version-0.4.0/guides-references/hauler-content/charts.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/charts",permalink:"/hauler-docs/docs/0.4.0/guides-references/hauler-content/charts",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.0/guides-references/hauler-content/charts.md",tags:[],version:"0.4.0",frontMatter:{title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',sidebar_label:"Charts"},sidebar:"haulerSidebar",previous:{title:"Images",permalink:"/hauler-docs/docs/0.4.0/guides-references/hauler-content/images"},next:{title:"Files",permalink:"/hauler-docs/docs/0.4.0/guides-references/hauler-content/files"}},i={},l=[];function d(e){const t={admonition:"admonition",code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.admonition,{type:"tip",children:(0,r.jsx)(t.p,{children:"Hauler supports the experimental format of Helm Chart OCI Artifacts, but can also be represented as the usual Tarball Artifact!"})}),"\n",(0,r.jsx)(t.p,{children:"Helm charts represented as OCI content:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:'# add a helm chart (defaults to latest version)\nhauler store add chart loki --repo "https://grafana.github.io/helm-charts"\n\n# add a specific version of a helm chart\nhauler store add chart loki --repo "https://grafana.github.io/helm-charts" --version 2.8.1\n\n# install directly from the oci content\nHELM_EXPERIMENTAL_OCI=1 helm install loki oci://localhost:3000/library/loki --version 2.8.1\n'})})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>c});var r=n(6540);const s={},a=r.createContext(s);function o(e){const t=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/692c69f5.07207f31.js b/assets/js/692c69f5.07207f31.js new file mode 100644 index 000000000..ba2a30595 --- /dev/null +++ b/assets/js/692c69f5.07207f31.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[6125],{9961:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>u,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var r=n(4848),s=n(8453);const a={title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',sidebar_label:"Charts"},o=void 0,i={id:"guides-references/hauler-content/charts",title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',source:"@site/versioned_docs/version-0.4.3/guides-references/hauler-content/charts.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/charts",permalink:"/docs/0.4.3/guides-references/hauler-content/charts",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.3/guides-references/hauler-content/charts.md",tags:[],version:"0.4.3",frontMatter:{title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',sidebar_label:"Charts"},sidebar:"haulerSidebar",previous:{title:"Images",permalink:"/docs/0.4.3/guides-references/hauler-content/images"},next:{title:"Files",permalink:"/docs/0.4.3/guides-references/hauler-content/files"}},c={},l=[];function d(e){const t={admonition:"admonition",code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.admonition,{type:"tip",children:(0,r.jsx)(t.p,{children:"Hauler supports the experimental format of Helm Chart OCI Artifacts, but can also be represented as the usual Tarball Artifact!"})}),"\n",(0,r.jsx)(t.p,{children:"Helm charts represented as OCI content:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:'# add a helm chart (defaults to latest version)\nhauler store add chart loki --repo "https://grafana.github.io/helm-charts"\n\n# add a specific version of a helm chart\nhauler store add chart loki --repo "https://grafana.github.io/helm-charts" --version 2.8.1\n\n# install directly from the oci content\nHELM_EXPERIMENTAL_OCI=1 helm install loki oci://localhost:3000/library/loki --version 2.8.1\n'})})]})}function u(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>i});var r=n(6540);const s={},a=r.createContext(s);function o(e){const t=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/692c69f5.ff2d1a56.js b/assets/js/692c69f5.ff2d1a56.js deleted file mode 100644 index e322ef730..000000000 --- a/assets/js/692c69f5.ff2d1a56.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[6125],{9961:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>h,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var r=n(4848),s=n(8453);const a={title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',sidebar_label:"Charts"},o=void 0,c={id:"guides-references/hauler-content/charts",title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',source:"@site/versioned_docs/version-0.4.3/guides-references/hauler-content/charts.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/charts",permalink:"/hauler-docs/docs/0.4.3/guides-references/hauler-content/charts",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.3/guides-references/hauler-content/charts.md",tags:[],version:"0.4.3",frontMatter:{title:"Charts (Content Type)",description:'Hauler "Charts" Content Documentation',sidebar_label:"Charts"},sidebar:"haulerSidebar",previous:{title:"Images",permalink:"/hauler-docs/docs/0.4.3/guides-references/hauler-content/images"},next:{title:"Files",permalink:"/hauler-docs/docs/0.4.3/guides-references/hauler-content/files"}},i={},l=[];function d(e){const t={admonition:"admonition",code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.admonition,{type:"tip",children:(0,r.jsx)(t.p,{children:"Hauler supports the experimental format of Helm Chart OCI Artifacts, but can also be represented as the usual Tarball Artifact!"})}),"\n",(0,r.jsx)(t.p,{children:"Helm charts represented as OCI content:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:'# add a helm chart (defaults to latest version)\nhauler store add chart loki --repo "https://grafana.github.io/helm-charts"\n\n# add a specific version of a helm chart\nhauler store add chart loki --repo "https://grafana.github.io/helm-charts" --version 2.8.1\n\n# install directly from the oci content\nHELM_EXPERIMENTAL_OCI=1 helm install loki oci://localhost:3000/library/loki --version 2.8.1\n'})})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>c});var r=n(6540);const s={},a=r.createContext(s);function o(e){const t=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6a9afd52.19d33e10.js b/assets/js/6a9afd52.19d33e10.js new file mode 100644 index 000000000..f07c11c50 --- /dev/null +++ b/assets/js/6a9afd52.19d33e10.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9969],{2451:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>o,default:()=>l,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var r=t(4848),s=t(8453);const a={title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',sidebar_label:"Images"},o=void 0,c={id:"guides-references/hauler-content/images",title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',source:"@site/versioned_docs/version-0.4.0/guides-references/hauler-content/images.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/images",permalink:"/docs/0.4.0/guides-references/hauler-content/images",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.0/guides-references/hauler-content/images.md",tags:[],version:"0.4.0",frontMatter:{title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',sidebar_label:"Images"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/docs/0.4.0/guides-references/hauler-content/overview"},next:{title:"Charts",permalink:"/docs/0.4.0/guides-references/hauler-content/charts"}},i={},d=[];function u(e){const n={code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.p,{children:"Any OCI compatible image can be fetched remotely:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'# "shorthand" image references\nhauler store add image rancher/rancher:v2.7.9\n\n# fully qualified image references\nhauler store add image ghcr.io/fluxcd/flux-cli@sha256:02aa820c3a9c57d67208afcfc4bce9661658c17d15940aea369da259d2b976dd\n'})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>c});var r=t(6540);const s={},a=r.createContext(s);function o(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6a9afd52.8a91f198.js b/assets/js/6a9afd52.8a91f198.js deleted file mode 100644 index 9886d6dce..000000000 --- a/assets/js/6a9afd52.8a91f198.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9969],{2451:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>c,default:()=>l,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var r=t(4848),s=t(8453);const a={title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',sidebar_label:"Images"},c=void 0,o={id:"guides-references/hauler-content/images",title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',source:"@site/versioned_docs/version-0.4.0/guides-references/hauler-content/images.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/images",permalink:"/hauler-docs/docs/0.4.0/guides-references/hauler-content/images",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.0/guides-references/hauler-content/images.md",tags:[],version:"0.4.0",frontMatter:{title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',sidebar_label:"Images"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/hauler-docs/docs/0.4.0/guides-references/hauler-content/overview"},next:{title:"Charts",permalink:"/hauler-docs/docs/0.4.0/guides-references/hauler-content/charts"}},i={},d=[];function u(e){const n={code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.p,{children:"Any OCI compatible image can be fetched remotely:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'# "shorthand" image references\nhauler store add image rancher/rancher:v2.7.9\n\n# fully qualified image references\nhauler store add image ghcr.io/fluxcd/flux-cli@sha256:02aa820c3a9c57d67208afcfc4bce9661658c17d15940aea369da259d2b976dd\n'})})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>o});var r=t(6540);const s={},a=r.createContext(s);function c(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6adf121f.b38c28b2.js b/assets/js/6adf121f.b38c28b2.js new file mode 100644 index 000000000..5cf10eb72 --- /dev/null +++ b/assets/js/6adf121f.b38c28b2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7610],{6626:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>i,contentTitle:()=>l,default:()=>d,frontMatter:()=>s,metadata:()=>o,toc:()=>h});var r=a(4848),n=a(8453);const s={title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},l=void 0,o={id:"introduction/quickstart",title:"Quickstart",description:"Quickstart Documentation for Hauler",source:"@site/versioned_docs/version-0.4.0/introduction/quickstart.md",sourceDirName:"introduction",slug:"/introduction/quickstart",permalink:"/docs/0.4.0/introduction/quickstart",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.0/introduction/quickstart.md",tags:[],version:"0.4.0",frontMatter:{title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},sidebar:"haulerSidebar",previous:{title:"Airgap Workflow",permalink:"/docs/0.4.0/airgap-workflow"},next:{title:"Installation",permalink:"/docs/0.4.0/introduction/install"}},i={},h=[{value:"Quick Installation",id:"quick-installation",level:2},{value:"Example Use of Hauler",id:"example-use-of-hauler",level:2},{value:"Add Content to the Hauler Store",id:"add-content-to-the-hauler-store",level:3},{value:"Using the Command Line:",id:"using-the-command-line",level:4},{value:"Using a Hauler Manifest:",id:"using-a-hauler-manifest",level:4},{value:"View the Hauler Store",id:"view-the-hauler-store",level:3},{value:"Save the Hauler Store",id:"save-the-hauler-store",level:3},{value:"Load the Airgapped Hauler Store",id:"load-the-airgapped-hauler-store",level:3},{value:"Serve the Hauler Store",id:"serve-the-hauler-store",level:3},{value:"Copy the Hauler Store to a Registry",id:"copy-the-hauler-store-to-a-registry",level:3},{value:"Copy the Hauler Store to a Directory",id:"copy-the-hauler-store-to-a-directory",level:3}];function c(e){const t={code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.p,{children:"Skipping past most of the documentation? Here's an easy to follow Quick Start Guide:"}),"\n",(0,r.jsx)(t.h2,{id:"quick-installation",children:"Quick Installation"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n"})}),"\n",(0,r.jsx)(t.h2,{id:"example-use-of-hauler",children:"Example Use of Hauler"}),"\n",(0,r.jsx)(t.h3,{id:"add-content-to-the-hauler-store",children:"Add Content to the Hauler Store"}),"\n",(0,r.jsx)(t.h4,{id:"using-the-command-line",children:"Using the Command Line:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# add a image: neuvector/scanner:latest\nhauler store add image neuvector/scanner:latest\n\n# add a image with supply chain artifacts\nhauler store add image rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.2 --key carbide-key.pub\n\n# add a chart: rancher-stable/rancher (v2.7.9)\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.7.9\n\n# add a file: rke2-install.sh\nhauler store add file https://get.rke2.io --name install.sh\n"})}),"\n",(0,r.jsx)(t.h4,{id:"using-a-hauler-manifest",children:"Using a Hauler Manifest:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"hauler store sync --files hauler-manfiest.yaml\n"})}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\nspec:\n images:\n - name: neuvector/scanner:latest\n - name: rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.1\n key: carbide-key.pub\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.7.9\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n - path: https://get.rke2.io\n name: install.sh\n"})}),"\n",(0,r.jsx)(t.h3,{id:"view-the-hauler-store",children:"View the Hauler Store"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# view and verify the content in the local hauler store\nhauler store info\n"})}),"\n",(0,r.jsx)(t.h3,{id:"save-the-hauler-store",children:"Save the Hauler Store"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# save and export the content in the local hauler store\nhauler store save --filename haul.tar.zst\n"})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsxs)(t.strong,{children:["airgap the ",(0,r.jsx)(t.code,{children:"haul.tar.zst"})," to the disconnected environment"]})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"load-the-airgapped-hauler-store",children:"Load the Airgapped Hauler Store"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# load and import the airgapped content to the new local hauler store\nhauler store load haul.tar.zst\n"})}),"\n",(0,r.jsx)(t.h3,{id:"serve-the-hauler-store",children:"Serve the Hauler Store"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# serve the content as a registry from the hauler store\nhauler store serve\n"})}),"\n",(0,r.jsx)(t.h3,{id:"copy-the-hauler-store-to-a-registry",children:"Copy the Hauler Store to a Registry"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# copy the content to a registry from the hauler store\nhauler store copy registry://harbor.example.com\n"})}),"\n",(0,r.jsx)(t.h3,{id:"copy-the-hauler-store-to-a-directory",children:"Copy the Hauler Store to a Directory"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# copy the content to a directory from the hauler store\nhauler store copy dir://hauler-files\n"})})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},8453:(e,t,a)=>{a.d(t,{R:()=>l,x:()=>o});var r=a(6540);const n={},s=r.createContext(n);function l(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:l(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6adf121f.f51f663d.js b/assets/js/6adf121f.f51f663d.js deleted file mode 100644 index 8889a65f8..000000000 --- a/assets/js/6adf121f.f51f663d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7610],{6626:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>i,contentTitle:()=>l,default:()=>d,frontMatter:()=>s,metadata:()=>o,toc:()=>h});var r=a(4848),n=a(8453);const s={title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},l=void 0,o={id:"introduction/quickstart",title:"Quickstart",description:"Quickstart Documentation for Hauler",source:"@site/versioned_docs/version-0.4.0/introduction/quickstart.md",sourceDirName:"introduction",slug:"/introduction/quickstart",permalink:"/hauler-docs/docs/0.4.0/introduction/quickstart",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.0/introduction/quickstart.md",tags:[],version:"0.4.0",frontMatter:{title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},sidebar:"haulerSidebar",previous:{title:"Airgap Workflow",permalink:"/hauler-docs/docs/0.4.0/airgap-workflow"},next:{title:"Installation",permalink:"/hauler-docs/docs/0.4.0/introduction/install"}},i={},h=[{value:"Quick Installation",id:"quick-installation",level:2},{value:"Example Use of Hauler",id:"example-use-of-hauler",level:2},{value:"Add Content to the Hauler Store",id:"add-content-to-the-hauler-store",level:3},{value:"Using the Command Line:",id:"using-the-command-line",level:4},{value:"Using a Hauler Manifest:",id:"using-a-hauler-manifest",level:4},{value:"View the Hauler Store",id:"view-the-hauler-store",level:3},{value:"Save the Hauler Store",id:"save-the-hauler-store",level:3},{value:"Load the Airgapped Hauler Store",id:"load-the-airgapped-hauler-store",level:3},{value:"Serve the Hauler Store",id:"serve-the-hauler-store",level:3},{value:"Copy the Hauler Store to a Registry",id:"copy-the-hauler-store-to-a-registry",level:3},{value:"Copy the Hauler Store to a Directory",id:"copy-the-hauler-store-to-a-directory",level:3}];function c(e){const t={code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.p,{children:"Skipping past most of the documentation? Here's an easy to follow Quick Start Guide:"}),"\n",(0,r.jsx)(t.h2,{id:"quick-installation",children:"Quick Installation"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n"})}),"\n",(0,r.jsx)(t.h2,{id:"example-use-of-hauler",children:"Example Use of Hauler"}),"\n",(0,r.jsx)(t.h3,{id:"add-content-to-the-hauler-store",children:"Add Content to the Hauler Store"}),"\n",(0,r.jsx)(t.h4,{id:"using-the-command-line",children:"Using the Command Line:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# add a image: neuvector/scanner:latest\nhauler store add image neuvector/scanner:latest\n\n# add a image with supply chain artifacts\nhauler store add image rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.2 --key carbide-key.pub\n\n# add a chart: rancher-stable/rancher (v2.7.9)\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.7.9\n\n# add a file: rke2-install.sh\nhauler store add file https://get.rke2.io --name install.sh\n"})}),"\n",(0,r.jsx)(t.h4,{id:"using-a-hauler-manifest",children:"Using a Hauler Manifest:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"hauler store sync --files hauler-manfiest.yaml\n"})}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\nspec:\n images:\n - name: neuvector/scanner:latest\n - name: rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.1\n key: carbide-key.pub\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.7.9\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n - path: https://get.rke2.io\n name: install.sh\n"})}),"\n",(0,r.jsx)(t.h3,{id:"view-the-hauler-store",children:"View the Hauler Store"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# view and verify the content in the local hauler store\nhauler store info\n"})}),"\n",(0,r.jsx)(t.h3,{id:"save-the-hauler-store",children:"Save the Hauler Store"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# save and export the content in the local hauler store\nhauler store save --filename haul.tar.zst\n"})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsxs)(t.strong,{children:["airgap the ",(0,r.jsx)(t.code,{children:"haul.tar.zst"})," to the disconnected environment"]})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"load-the-airgapped-hauler-store",children:"Load the Airgapped Hauler Store"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# load and import the airgapped content to the new local hauler store\nhauler store load haul.tar.zst\n"})}),"\n",(0,r.jsx)(t.h3,{id:"serve-the-hauler-store",children:"Serve the Hauler Store"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# serve the content as a registry from the hauler store\nhauler store serve\n"})}),"\n",(0,r.jsx)(t.h3,{id:"copy-the-hauler-store-to-a-registry",children:"Copy the Hauler Store to a Registry"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# copy the content to a registry from the hauler store\nhauler store copy registry://harbor.example.com\n"})}),"\n",(0,r.jsx)(t.h3,{id:"copy-the-hauler-store-to-a-directory",children:"Copy the Hauler Store to a Directory"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# copy the content to a directory from the hauler store\nhauler store copy dir://hauler-files\n"})})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},8453:(e,t,a)=>{a.d(t,{R:()=>l,x:()=>o});var r=a(6540);const n={},s=r.createContext(n);function l(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:l(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6be30e7c.86b5f647.js b/assets/js/6be30e7c.86b5f647.js new file mode 100644 index 000000000..9646d078b --- /dev/null +++ b/assets/js/6be30e7c.86b5f647.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5664],{7660:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>o,frontMatter:()=>s,metadata:()=>l,toc:()=>d});var a=r(4848),t=r(8453);const s={title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},i=void 0,l={id:"guides-references/cluster-images",title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",source:"@site/docs/guides-references/cluster-images.md",sourceDirName:"guides-references",slug:"/guides-references/cluster-images",permalink:"/docs/next/guides-references/cluster-images",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/docs/guides-references/cluster-images.md",tags:[],version:"current",frontMatter:{title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/docs/next/guides-references/overview"},next:{title:"RGS Carbide Customers",permalink:"/docs/next/guides-references/carbide-customers"}},c={},d=[{value:"Fetch Cluster Images",id:"fetch-cluster-images",level:2},{value:"Example Output",id:"example-output",level:2},{value:"Generate Hauler Manifest",id:"generate-hauler-manifest",level:2},{value:"Resulting Hauler Manifest",id:"resulting-hauler-manifest",level:2}];function u(e){const n={code:"code",h2:"h2",p:"p",pre:"pre",...(0,t.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsxs)(n.p,{children:["It may be difficult to understand exactly what ",(0,a.jsx)(n.code,{children:"content"})," is actively within your environment. Below is a simple way to generate a list of all images running in your environment, store it as an environment variable, and show the list by echoing the environment variable."]}),"\n",(0,a.jsx)(n.h2,{id:"fetch-cluster-images",children:"Fetch Cluster Images"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"# fetch all images in the cluster, remove duplicates, alphabetize, and put on a newline\nexport IMAGE_LIST=$(kubectl get pods --all-namespaces -o jsonpath=\"{.items[*].spec.containers[*].image}\" | sed 's/ /\\n/g' | sort | uniq)\n"})}),"\n",(0,a.jsx)(n.h2,{id:"example-output",children:"Example Output"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"# view the list of images from the cluster\necho $IMAGE_LIST\nindex.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\nindex.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\nindex.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\nrancher/hardened-calico:v3.21.4-build20220228\nrancher/hardened-cluster-autoscaler:v1.8.5-build20211119\nrancher/hardened-coredns:v1.9.1-build20220318\nrancher/hardened-flannel:v0.17.0-build20220317\nrancher/hardened-k8s-metrics-server:v0.5.0-build20211119\nrancher/klipper-helm:v0.7.0-build20220315\nrancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})}),"\n",(0,a.jsx)(n.h2,{id:"generate-hauler-manifest",children:"Generate Hauler Manifest"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"# add the required formatting for the image list\nexport IMAGE_LIST_MODIFIED=$(echo \"${IMAGE_LIST}\" | sed 's/^/ - name: /')\n\n# create the hauler manifest with the updated image list\ncat << EOF >> hauler-manifest.yaml\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images\nspec:\n images:\n$IMAGE_LIST_MODIFIED\nEOF\n"})}),"\n",(0,a.jsx)(n.h2,{id:"resulting-hauler-manifest",children:"Resulting Hauler Manifest"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images\nspec:\n images:\n - name: index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\n - name: index.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\n - name: index.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\n - name: rancher/hardened-calico:v3.21.4-build20220228\n - name: rancher/hardened-cluster-autoscaler:v1.8.5-build20211119\n - name: rancher/hardened-coredns:v1.9.1-build20220318\n - name: rancher/hardened-flannel:v0.17.0-build20220317\n - name: rancher/hardened-k8s-metrics-server:v0.5.0-build20211119\n - name: rancher/klipper-helm:v0.7.0-build20220315\n - name: rancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})})]})}function o(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>l});var a=r(6540);const t={},s=a.createContext(t);function i(e){const n=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),a.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6be30e7c.df3e38e5.js b/assets/js/6be30e7c.df3e38e5.js deleted file mode 100644 index 254adde7e..000000000 --- a/assets/js/6be30e7c.df3e38e5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5664],{7660:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>o,frontMatter:()=>s,metadata:()=>l,toc:()=>d});var a=r(4848),t=r(8453);const s={title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},i=void 0,l={id:"guides-references/cluster-images",title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",source:"@site/docs/guides-references/cluster-images.md",sourceDirName:"guides-references",slug:"/guides-references/cluster-images",permalink:"/hauler-docs/docs/next/guides-references/cluster-images",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/docs/guides-references/cluster-images.md",tags:[],version:"current",frontMatter:{title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/hauler-docs/docs/next/guides-references/overview"},next:{title:"RGS Carbide Customers",permalink:"/hauler-docs/docs/next/guides-references/carbide-customers"}},c={},d=[{value:"Fetch Cluster Images",id:"fetch-cluster-images",level:2},{value:"Example Output",id:"example-output",level:2},{value:"Generate Hauler Manifest",id:"generate-hauler-manifest",level:2},{value:"Resulting Hauler Manifest",id:"resulting-hauler-manifest",level:2}];function u(e){const n={code:"code",h2:"h2",p:"p",pre:"pre",...(0,t.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsxs)(n.p,{children:["It may be difficult to understand exactly what ",(0,a.jsx)(n.code,{children:"content"})," is actively within your environment. Below is a simple way to generate a list of all images running in your environment, store it as an environment variable, and show the list by echoing the environment variable."]}),"\n",(0,a.jsx)(n.h2,{id:"fetch-cluster-images",children:"Fetch Cluster Images"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"# fetch all images in the cluster, remove duplicates, alphabetize, and put on a newline\nexport IMAGE_LIST=$(kubectl get pods --all-namespaces -o jsonpath=\"{.items[*].spec.containers[*].image}\" | sed 's/ /\\n/g' | sort | uniq)\n"})}),"\n",(0,a.jsx)(n.h2,{id:"example-output",children:"Example Output"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"# view the list of images from the cluster\necho $IMAGE_LIST\nindex.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\nindex.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\nindex.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\nrancher/hardened-calico:v3.21.4-build20220228\nrancher/hardened-cluster-autoscaler:v1.8.5-build20211119\nrancher/hardened-coredns:v1.9.1-build20220318\nrancher/hardened-flannel:v0.17.0-build20220317\nrancher/hardened-k8s-metrics-server:v0.5.0-build20211119\nrancher/klipper-helm:v0.7.0-build20220315\nrancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})}),"\n",(0,a.jsx)(n.h2,{id:"generate-hauler-manifest",children:"Generate Hauler Manifest"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"# add the required formatting for the image list\nexport IMAGE_LIST_MODIFIED=$(echo \"${IMAGE_LIST}\" | sed 's/^/ - name: /')\n\n# create the hauler manifest with the updated image list\ncat << EOF >> hauler-manifest.yaml\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images\nspec:\n images:\n$IMAGE_LIST_MODIFIED\nEOF\n"})}),"\n",(0,a.jsx)(n.h2,{id:"resulting-hauler-manifest",children:"Resulting Hauler Manifest"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images\nspec:\n images:\n - name: index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\n - name: index.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\n - name: index.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\n - name: rancher/hardened-calico:v3.21.4-build20220228\n - name: rancher/hardened-cluster-autoscaler:v1.8.5-build20211119\n - name: rancher/hardened-coredns:v1.9.1-build20220318\n - name: rancher/hardened-flannel:v0.17.0-build20220317\n - name: rancher/hardened-k8s-metrics-server:v0.5.0-build20211119\n - name: rancher/klipper-helm:v0.7.0-build20220315\n - name: rancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})})]})}function o(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(u,{...e})}):u(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>l});var a=r(6540);const t={},s=a.createContext(t);function i(e){const n=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),a.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6eba25ce.bed362f2.js b/assets/js/6eba25ce.bed362f2.js deleted file mode 100644 index 315721519..000000000 --- a/assets/js/6eba25ce.bed362f2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5784],{2146:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var i=n(4848),t=n(8453);const r={title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},o=void 0,a={id:"known-limits",title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",source:"@site/versioned_docs/version-0.4.0/known-limits.md",sourceDirName:".",slug:"/known-limits",permalink:"/hauler-docs/docs/0.4.0/known-limits",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.0/known-limits.md",tags:[],version:"0.4.0",frontMatter:{title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},sidebar:"haulerSidebar",previous:{title:"Hauler Version",permalink:"/hauler-docs/docs/0.4.0/guides-references/command-line/hauler-version"}},l={},c=[{value:"Issues",id:"issues",level:2},{value:"Limitations",id:"limitations",level:2},{value:"Notices",id:"notices",level:2},{value:"Upcoming Deprecated Command(s):",id:"upcoming-deprecated-commands",level:4}];function d(e){const s={a:"a",code:"code",h2:"h2",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h2,{id:"issues",children:"Issues"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Copying SBOMS to AWS Elastic Container Registry (AWS ECR):","\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["When using ",(0,i.jsx)(s.code,{children:"hauler store copy"})," to AWS ECR, the Software Bill of Materials (SBOM) attachement will fail to copy due to changes in the way ",(0,i.jsx)(s.code,{children:"cosign"})," handles attachments. ",(0,i.jsx)(s.strong,{children:"We are investigating a way forward to address this issue."})]}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"https://github.com/sigstore/cosign/blob/main/specs/SBOM_SPEC.md",children:"https://github.com/sigstore/cosign/blob/main/specs/SBOM_SPEC.md"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"https://github.com/sigstore/cosign/issues/2755",children:"https://github.com/sigstore/cosign/issues/2755"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"limitations",children:"Limitations"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Display of Information in the Hauler Store:","\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["When using ",(0,i.jsx)(s.code,{children:"hauler store info"})," with signature verification, you may encounter errors in the presentation of the number layers and size of layers in the store. Hauler is correctly fetching, storing, packaging, and distributing each image, but the presentation and display can error. ",(0,i.jsx)(s.strong,{children:"We are actively working to address and fix this issue."})]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"notices",children:"Notices"}),"\n",(0,i.jsx)(s.h4,{id:"upcoming-deprecated-commands",children:"Upcoming Deprecated Command(s):"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.code,{children:"hauler download"})," (alternatively ",(0,i.jsx)(s.code,{children:"hauler dl"}),") is deprecated and will be removed in a future release."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.code,{children:"hauler serve"})," is deprecated and will be removed in a future release."]}),"\n"]})]})}function u(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>o,x:()=>a});var i=n(6540);const t={},r=i.createContext(t);function o(e){const s=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6eba25ce.da1ab705.js b/assets/js/6eba25ce.da1ab705.js new file mode 100644 index 000000000..044fb1e2c --- /dev/null +++ b/assets/js/6eba25ce.da1ab705.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5784],{2146:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=n(4848),t=n(8453);const r={title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},o=void 0,a={id:"known-limits",title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",source:"@site/versioned_docs/version-0.4.0/known-limits.md",sourceDirName:".",slug:"/known-limits",permalink:"/docs/0.4.0/known-limits",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.0/known-limits.md",tags:[],version:"0.4.0",frontMatter:{title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},sidebar:"haulerSidebar",previous:{title:"Hauler Version",permalink:"/docs/0.4.0/guides-references/command-line/hauler-version"}},l={},d=[{value:"Issues",id:"issues",level:2},{value:"Limitations",id:"limitations",level:2},{value:"Notices",id:"notices",level:2},{value:"Upcoming Deprecated Command(s):",id:"upcoming-deprecated-commands",level:4}];function c(e){const s={a:"a",code:"code",h2:"h2",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h2,{id:"issues",children:"Issues"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Copying SBOMS to AWS Elastic Container Registry (AWS ECR):","\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["When using ",(0,i.jsx)(s.code,{children:"hauler store copy"})," to AWS ECR, the Software Bill of Materials (SBOM) attachement will fail to copy due to changes in the way ",(0,i.jsx)(s.code,{children:"cosign"})," handles attachments. ",(0,i.jsx)(s.strong,{children:"We are investigating a way forward to address this issue."})]}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"https://github.com/sigstore/cosign/blob/main/specs/SBOM_SPEC.md",children:"https://github.com/sigstore/cosign/blob/main/specs/SBOM_SPEC.md"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"https://github.com/sigstore/cosign/issues/2755",children:"https://github.com/sigstore/cosign/issues/2755"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"limitations",children:"Limitations"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Display of Information in the Hauler Store:","\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["When using ",(0,i.jsx)(s.code,{children:"hauler store info"})," with signature verification, you may encounter errors in the presentation of the number layers and size of layers in the store. Hauler is correctly fetching, storing, packaging, and distributing each image, but the presentation and display can error. ",(0,i.jsx)(s.strong,{children:"We are actively working to address and fix this issue."})]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"notices",children:"Notices"}),"\n",(0,i.jsx)(s.h4,{id:"upcoming-deprecated-commands",children:"Upcoming Deprecated Command(s):"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.code,{children:"hauler download"})," (alternatively ",(0,i.jsx)(s.code,{children:"hauler dl"}),") is deprecated and will be removed in a future release."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.code,{children:"hauler serve"})," is deprecated and will be removed in a future release."]}),"\n"]})]})}function u(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>o,x:()=>a});var i=n(6540);const t={},r=i.createContext(t);function o(e){const s=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/72c253a6.6125ac25.js b/assets/js/72c253a6.6125ac25.js deleted file mode 100644 index 1eeffe3e0..000000000 --- a/assets/js/72c253a6.6125ac25.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5110],{733:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var o=t(4848),r=t(8453);const i={title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},c=void 0,s={id:"core-concepts",title:"Core Concepts",description:"Core Concepts Documentation for Hauler",source:"@site/versioned_docs/version-0.4.4/core-concepts.md",sourceDirName:".",slug:"/core-concepts",permalink:"/hauler-docs/docs/0.4.4/core-concepts",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.4/core-concepts.md",tags:[],version:"0.4.4",frontMatter:{title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},sidebar:"haulerSidebar",previous:{title:"Introduction",permalink:"/hauler-docs/docs/0.4.4/intro"},next:{title:"Airgap Workflow",permalink:"/hauler-docs/docs/0.4.4/airgap-workflow"}},a={},l=[{value:"Haul",id:"haul",level:2},{value:"Collections",id:"collections",level:2},{value:"Community Collections",id:"community-collections",level:3},{value:"RGS Carbide Collections",id:"rgs-carbide-collections",level:3},{value:"Content",id:"content",level:2},{value:"Declarative Content",id:"declarative-content",level:3}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",ul:"ul",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"hauler-diagram",src:t(6178).A+"",width:"1949",height:"988"})}),"\n",(0,o.jsx)(n.h2,{id:"haul",children:"Haul"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauls"})," are Compressed Archive (Tarball) of Hauler Collections and Content."]})}),"\n",(0,o.jsxs)(n.p,{children:["At the heart of Hauler lies the concept of a ",(0,o.jsx)(n.code,{children:"Haul"}),". A ",(0,o.jsx)(n.code,{children:"Haul"})," is a compressed archive, often in the form of a tarball, containing Hauler collections and content. It serves as a container for grouping and transporting various data types, making it a fundamental element in the Hauler ecosystem."]}),"\n",(0,o.jsx)(n.h2,{id:"collections",children:"Collections"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are Grouping of one or more Hauler Contents."]})}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are the building blocks of Hauler. These are groupings of one or more Hauler ",(0,o.jsx)(n.code,{children:"contents"}),". Think of ",(0,o.jsx)(n.code,{children:"collections"})," as organized sets of data that collectively represent something desirable."]}),"\n",(0,o.jsx)(n.h3,{id:"community-collections",children:"Community Collections"}),"\n",(0,o.jsxs)(n.p,{children:["While ",(0,o.jsx)(n.code,{children:"collections"})," (and ",(0,o.jsx)(n.code,{children:"contents"}),") are built into Hauler, our goal is to empower users to define their own ",(0,o.jsx)(n.code,{children:"collections"}),". This way, you can tailor Hauler to your unique requirements and take full control of your artifacts."]}),"\n",(0,o.jsx)(n.h3,{id:"rgs-carbide-collections",children:"RGS Carbide Collections"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauler"})," provides the ability to import ",(0,o.jsx)(n.code,{children:"collections"})," for the Rancher products, making it seamless for RGS Supported Customers to airgap any of the Rancher products or projects. If you haven't heard of Rancher Government Carbide, check it out ",(0,o.jsx)(n.a,{href:"https://ranchergovernment.com/carbide",children:"here"}),"!"]}),"\n",(0,o.jsx)(n.h2,{id:"content",children:"Content"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Contents"})," are Artifacts such as Images, Charts, or Files."]})}),"\n",(0,o.jsxs)(n.p,{children:["In Hauler's terminology, ",(0,o.jsx)(n.code,{children:"content"})," refers to artifacts such as images, charts, or files. These are the fundamental types of resources that Hauler understands and manages. To understand the term better, let's break it down:"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Content"}),": The fundamental type of artifacts that Hauler recognizes (images, charts, and files)."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Artifact"}),": Anything that can be represented as an OCI (Open Container Initiative) artifact.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"OCI Artifacts provide a standardized way to store arbitrary files, making it easier to manage content efficiently."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"declarative-content",children:"Declarative Content"}),"\n",(0,o.jsxs)(n.p,{children:["While manually adding content to ",(0,o.jsx)(n.code,{children:"Hauler"})," is a straightforward way to get started, we recommend a much more sustainable approach. ",(0,o.jsx)(n.code,{children:"Hauler"})," provides a declarative approach for each ",(0,o.jsx)(n.code,{children:"content"})," type, allowing you to define all the ",(0,o.jsx)(n.code,{children:"content"})," within a manifest. This approach ensures a more reproducable workflow for managing the lifecycle of your ",(0,o.jsx)(n.code,{children:"hauls"}),"."]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},6178:(e,n,t)=>{t.d(n,{A:()=>o});const o=t.p+"assets/images/hauler-diagram-53f9182c0d98fe871fb3cf7fe8cd475a.png"},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>s});var o=t(6540);const r={},i=o.createContext(r);function c(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/72c253a6.7c5a9eea.js b/assets/js/72c253a6.7c5a9eea.js new file mode 100644 index 000000000..45607acb7 --- /dev/null +++ b/assets/js/72c253a6.7c5a9eea.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5110],{733:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var o=t(4848),r=t(8453);const i={title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},s=void 0,c={id:"core-concepts",title:"Core Concepts",description:"Core Concepts Documentation for Hauler",source:"@site/versioned_docs/version-0.4.4/core-concepts.md",sourceDirName:".",slug:"/core-concepts",permalink:"/docs/0.4.4/core-concepts",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.4/core-concepts.md",tags:[],version:"0.4.4",frontMatter:{title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},sidebar:"haulerSidebar",previous:{title:"Introduction",permalink:"/docs/0.4.4/intro"},next:{title:"Airgap Workflow",permalink:"/docs/0.4.4/airgap-workflow"}},a={},l=[{value:"Haul",id:"haul",level:2},{value:"Collections",id:"collections",level:2},{value:"Community Collections",id:"community-collections",level:3},{value:"RGS Carbide Collections",id:"rgs-carbide-collections",level:3},{value:"Content",id:"content",level:2},{value:"Declarative Content",id:"declarative-content",level:3}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",ul:"ul",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"hauler-diagram",src:t(6178).A+"",width:"1949",height:"988"})}),"\n",(0,o.jsx)(n.h2,{id:"haul",children:"Haul"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauls"})," are Compressed Archive (Tarball) of Hauler Collections and Content."]})}),"\n",(0,o.jsxs)(n.p,{children:["At the heart of Hauler lies the concept of a ",(0,o.jsx)(n.code,{children:"Haul"}),". A ",(0,o.jsx)(n.code,{children:"Haul"})," is a compressed archive, often in the form of a tarball, containing Hauler collections and content. It serves as a container for grouping and transporting various data types, making it a fundamental element in the Hauler ecosystem."]}),"\n",(0,o.jsx)(n.h2,{id:"collections",children:"Collections"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are Grouping of one or more Hauler Contents."]})}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are the building blocks of Hauler. These are groupings of one or more Hauler ",(0,o.jsx)(n.code,{children:"contents"}),". Think of ",(0,o.jsx)(n.code,{children:"collections"})," as organized sets of data that collectively represent something desirable."]}),"\n",(0,o.jsx)(n.h3,{id:"community-collections",children:"Community Collections"}),"\n",(0,o.jsxs)(n.p,{children:["While ",(0,o.jsx)(n.code,{children:"collections"})," (and ",(0,o.jsx)(n.code,{children:"contents"}),") are built into Hauler, our goal is to empower users to define their own ",(0,o.jsx)(n.code,{children:"collections"}),". This way, you can tailor Hauler to your unique requirements and take full control of your artifacts."]}),"\n",(0,o.jsx)(n.h3,{id:"rgs-carbide-collections",children:"RGS Carbide Collections"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauler"})," provides the ability to import ",(0,o.jsx)(n.code,{children:"collections"})," for the Rancher products, making it seamless for RGS Supported Customers to airgap any of the Rancher products or projects. If you haven't heard of Rancher Government Carbide, check it out ",(0,o.jsx)(n.a,{href:"https://ranchergovernment.com/carbide",children:"here"}),"!"]}),"\n",(0,o.jsx)(n.h2,{id:"content",children:"Content"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Contents"})," are Artifacts such as Images, Charts, or Files."]})}),"\n",(0,o.jsxs)(n.p,{children:["In Hauler's terminology, ",(0,o.jsx)(n.code,{children:"content"})," refers to artifacts such as images, charts, or files. These are the fundamental types of resources that Hauler understands and manages. To understand the term better, let's break it down:"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Content"}),": The fundamental type of artifacts that Hauler recognizes (images, charts, and files)."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Artifact"}),": Anything that can be represented as an OCI (Open Container Initiative) artifact.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"OCI Artifacts provide a standardized way to store arbitrary files, making it easier to manage content efficiently."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"declarative-content",children:"Declarative Content"}),"\n",(0,o.jsxs)(n.p,{children:["While manually adding content to ",(0,o.jsx)(n.code,{children:"Hauler"})," is a straightforward way to get started, we recommend a much more sustainable approach. ",(0,o.jsx)(n.code,{children:"Hauler"})," provides a declarative approach for each ",(0,o.jsx)(n.code,{children:"content"})," type, allowing you to define all the ",(0,o.jsx)(n.code,{children:"content"})," within a manifest. This approach ensures a more reproducable workflow for managing the lifecycle of your ",(0,o.jsx)(n.code,{children:"hauls"}),"."]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},6178:(e,n,t)=>{t.d(n,{A:()=>o});const o=t.p+"assets/images/hauler-diagram-53f9182c0d98fe871fb3cf7fe8cd475a.png"},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var o=t(6540);const r={},i=o.createContext(r);function s(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/74020a4e.14ee6ec4.js b/assets/js/74020a4e.14ee6ec4.js new file mode 100644 index 000000000..ec18bdf6b --- /dev/null +++ b/assets/js/74020a4e.14ee6ec4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[176],{2312:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"0.4.4","label":"0.4.4","banner":"unmaintained","badge":true,"noIndex":false,"className":"docs-version-0.4.4","isLast":false,"docsSidebars":{"haulerSidebar":[{"type":"link","label":"Introduction","href":"/docs/0.4.4/intro","docId":"intro","unlisted":false},{"type":"link","label":"Core Concepts","href":"/docs/0.4.4/core-concepts","docId":"core-concepts","unlisted":false},{"type":"link","label":"Airgap Workflow","href":"/docs/0.4.4/airgap-workflow","docId":"airgap-workflow","unlisted":false},{"type":"category","label":"Introduction","description":"Introduction Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Quickstart","href":"/docs/0.4.4/introduction/quickstart","docId":"introduction/quickstart","unlisted":false},{"type":"link","label":"Installation","href":"/docs/0.4.4/introduction/install","docId":"introduction/install","unlisted":false},{"type":"link","label":"Uninstall","href":"/docs/0.4.4/introduction/uninstall","docId":"introduction/uninstall","unlisted":false}],"collapsible":true},{"type":"category","label":"Guides & References","description":"Guides and References Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Overview","href":"/docs/0.4.4/guides-references/overview","docId":"guides-references/overview","unlisted":false},{"type":"link","label":"Fetch Cluster Images","href":"/docs/0.4.4/guides-references/cluster-images","docId":"guides-references/cluster-images","unlisted":false},{"type":"link","label":"RGS Carbide Customers","href":"/docs/0.4.4/guides-references/carbide-customers","docId":"guides-references/carbide-customers","unlisted":false},{"type":"category","label":"Hauler Collections","description":"Guides and References for Hauler Collections","items":[{"type":"link","label":"Overview","href":"/docs/0.4.4/guides-references/hauler-collections/overview","docId":"guides-references/hauler-collections/overview","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Hauler Content","description":"Guides and References for Hauler Content Types","items":[{"type":"link","label":"Overview","href":"/docs/0.4.4/guides-references/hauler-content/overview","docId":"guides-references/hauler-content/overview","unlisted":false},{"type":"link","label":"Images","href":"/docs/0.4.4/guides-references/hauler-content/images","docId":"guides-references/hauler-content/images","unlisted":false},{"type":"link","label":"Charts","href":"/docs/0.4.4/guides-references/hauler-content/charts","docId":"guides-references/hauler-content/charts","unlisted":false},{"type":"link","label":"Files","href":"/docs/0.4.4/guides-references/hauler-content/files","docId":"guides-references/hauler-content/files","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Command Line Interface","description":"Guides and References for the Hauler Command Line","items":[{"type":"link","label":"Hauler","href":"/docs/0.4.4/guides-references/command-line/hauler","docId":"guides-references/command-line/hauler","unlisted":false},{"type":"link","label":"Hauler Store","href":"/docs/0.4.4/guides-references/command-line/hauler-store","docId":"guides-references/command-line/hauler-store","unlisted":false},{"type":"link","label":"Hauler Completion","href":"/docs/0.4.4/guides-references/command-line/hauler-completion","docId":"guides-references/command-line/hauler-completion","unlisted":false},{"type":"link","label":"Hauler Version","href":"/docs/0.4.4/guides-references/command-line/hauler-version","docId":"guides-references/command-line/hauler-version","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true},{"type":"link","label":"Known Issues/Limits","href":"/docs/0.4.4/known-limits","docId":"known-limits","unlisted":false}]},"docs":{"airgap-workflow":{"id":"airgap-workflow","title":"Airgap Workflow","description":"Airgap Workflow Documentation for Hauler","sidebar":"haulerSidebar"},"core-concepts":{"id":"core-concepts","title":"Core Concepts","description":"Core Concepts Documentation for Hauler","sidebar":"haulerSidebar"},"guides-references/carbide-customers":{"id":"guides-references/carbide-customers","title":"RGS Carbide Customers","description":"RGS Carbide Customers Documentation","sidebar":"haulerSidebar"},"guides-references/cluster-images":{"id":"guides-references/cluster-images","title":"Fetching Cluster Images","description":"Fetching Images on a Cluster Documentation","sidebar":"haulerSidebar"},"guides-references/command-line/hauler":{"id":"guides-references/command-line/hauler","title":"Hauler (Command)","description":"Hauler CLI Reference for hauler","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-completion":{"id":"guides-references/command-line/hauler-completion","title":"Hauler Completion (Command)","description":"Hauler CLI Reference for hauler completion","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-store":{"id":"guides-references/command-line/hauler-store","title":"Hauler Store (Command)","description":"Hauler CLI Reference for hauler store","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-version":{"id":"guides-references/command-line/hauler-version","title":"Hauler Version (Command)","description":"Hauler CLI Reference for hauler version","sidebar":"haulerSidebar"},"guides-references/hauler-collections/overview":{"id":"guides-references/hauler-collections/overview","title":"Overview of Hauler Collections","description":"Hauler Collections Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/charts":{"id":"guides-references/hauler-content/charts","title":"Charts (Content Type)","description":"Hauler \\"Charts\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/files":{"id":"guides-references/hauler-content/files","title":"Files (Content Type)","description":"Hauler \\"Files\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/images":{"id":"guides-references/hauler-content/images","title":"Images (Content Type)","description":"Hauler \\"Images\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/overview":{"id":"guides-references/hauler-content/overview","title":"Overview of Hauler Content","description":"Hauler Content Documentation","sidebar":"haulerSidebar"},"guides-references/overview":{"id":"guides-references/overview","title":"Overview","description":"Reference Guides Overview Documentation for Hauler","sidebar":"haulerSidebar"},"intro":{"id":"intro","title":"Introduction","description":"Introduction to Rancher Government Hauler","sidebar":"haulerSidebar"},"introduction/install":{"id":"introduction/install","title":"Installation","description":"Installation Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/quickstart":{"id":"introduction/quickstart","title":"Quickstart","description":"Quickstart Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/uninstall":{"id":"introduction/uninstall","title":"Uninstall","description":"Uninstall Documentation for Hauler","sidebar":"haulerSidebar"},"known-limits":{"id":"known-limits","title":"Known Issues and Limits","description":"Known Issues and Limitations for Hauler","sidebar":"haulerSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/741fe335.261edc0b.js b/assets/js/741fe335.261edc0b.js deleted file mode 100644 index 00912f7d4..000000000 --- a/assets/js/741fe335.261edc0b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7263],{3914:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>l,toc:()=>a});var r=n(4848),s=n(8453);const o={title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',sidebar_label:"Files"},i=void 0,l={id:"guides-references/hauler-content/files",title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',source:"@site/versioned_docs/version-0.4.0/guides-references/hauler-content/files.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/files",permalink:"/hauler-docs/docs/0.4.0/guides-references/hauler-content/files",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.0/guides-references/hauler-content/files.md",tags:[],version:"0.4.0",frontMatter:{title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',sidebar_label:"Files"},sidebar:"haulerSidebar",previous:{title:"Charts",permalink:"/hauler-docs/docs/0.4.0/guides-references/hauler-content/charts"},next:{title:"Hauler",permalink:"/hauler-docs/docs/0.4.0/guides-references/command-line/hauler"}},c={},a=[];function u(e){const t={code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.p,{children:"Generic content that can be represented as a file, either sourced locally or remotely:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-yaml",children:"# local file\nhauler store add file path/to/local/file.txt\n\n# remote file with name\nhauler store add file https://get.rke2.io --name install.sh\n"})})]})}function d(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>l});var r=n(6540);const s={},o=r.createContext(s);function i(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/741fe335.d0be0e8a.js b/assets/js/741fe335.d0be0e8a.js new file mode 100644 index 000000000..5094772d0 --- /dev/null +++ b/assets/js/741fe335.d0be0e8a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7263],{3914:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>l,toc:()=>a});var r=n(4848),s=n(8453);const o={title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',sidebar_label:"Files"},i=void 0,l={id:"guides-references/hauler-content/files",title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',source:"@site/versioned_docs/version-0.4.0/guides-references/hauler-content/files.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/files",permalink:"/docs/0.4.0/guides-references/hauler-content/files",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.0/guides-references/hauler-content/files.md",tags:[],version:"0.4.0",frontMatter:{title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',sidebar_label:"Files"},sidebar:"haulerSidebar",previous:{title:"Charts",permalink:"/docs/0.4.0/guides-references/hauler-content/charts"},next:{title:"Hauler",permalink:"/docs/0.4.0/guides-references/command-line/hauler"}},c={},a=[];function u(e){const t={code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.p,{children:"Generic content that can be represented as a file, either sourced locally or remotely:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-yaml",children:"# local file\nhauler store add file path/to/local/file.txt\n\n# remote file with name\nhauler store add file https://get.rke2.io --name install.sh\n"})})]})}function d(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>l});var r=n(6540);const s={},o=r.createContext(s);function i(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7706f24b.21994425.js b/assets/js/7706f24b.21994425.js new file mode 100644 index 000000000..3f9b8c84c --- /dev/null +++ b/assets/js/7706f24b.21994425.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[893],{2083:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>d,frontMatter:()=>s,metadata:()=>_,toc:()=>l});var i=r(4848),o=r(8453);const s={title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},t=void 0,_={id:"guides-references/command-line/hauler-version",title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",source:"@site/versioned_docs/version-1.0.x/guides-references/command-line/hauler-version.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-version",permalink:"/docs/guides-references/command-line/hauler-version",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/command-line/hauler-version.md",tags:[],version:"1.0.x",frontMatter:{title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},sidebar:"haulerSidebar",previous:{title:"Hauler Completion",permalink:"/docs/guides-references/command-line/hauler-completion"},next:{title:"Known Issues/Limits",permalink:"/docs/known-limits"}},a={},l=[{value:"Command Overview",id:"command-overview",level:3}];function c(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Print Hauler's current version."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-yaml",children:" __ __ ___ __ __ __ _______ .______\n| | | | / \\ | | | | | | | ____|| _ \\\n| |__| | / ^ \\ | | | | | | | |__ | |_) |\n| __ | / /_\\ \\ | | | | | | | __| | /\n| | | | / _____ \\ | `--' | | `----.| |____ | |\\ \\----.\n|__| |__| /__/ \\__\\ \\______/ |_______||_______|| _| `._____|\n\nhauler: Airgap Swiss Army Knife\n\nGitVersion: 1.0.3\nGitCommit: f7c24f6\nGitTreeState: clean\nBuildDate: 2024-04-24T16:50:33Z\nGoVersion: go1.21.9\nCompiler: gc\nPlatform: darwin/arm64\n"})})]})}function d(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>t,x:()=>_});var i=r(6540);const o={},s=i.createContext(o);function t(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function _(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:t(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7706f24b.4fb6070f.js b/assets/js/7706f24b.4fb6070f.js deleted file mode 100644 index c7ca14d1d..000000000 --- a/assets/js/7706f24b.4fb6070f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[893],{2083:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>d,frontMatter:()=>s,metadata:()=>_,toc:()=>l});var i=r(4848),o=r(8453);const s={title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},t=void 0,_={id:"guides-references/command-line/hauler-version",title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",source:"@site/versioned_docs/version-1.0.x/guides-references/command-line/hauler-version.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-version",permalink:"/hauler-docs/docs/guides-references/command-line/hauler-version",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/command-line/hauler-version.md",tags:[],version:"1.0.x",frontMatter:{title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},sidebar:"haulerSidebar",previous:{title:"Hauler Completion",permalink:"/hauler-docs/docs/guides-references/command-line/hauler-completion"},next:{title:"Known Issues/Limits",permalink:"/hauler-docs/docs/known-limits"}},a={},l=[{value:"Command Overview",id:"command-overview",level:3}];function c(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Print Hauler's current version."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-yaml",children:" __ __ ___ __ __ __ _______ .______\n| | | | / \\ | | | | | | | ____|| _ \\\n| |__| | / ^ \\ | | | | | | | |__ | |_) |\n| __ | / /_\\ \\ | | | | | | | __| | /\n| | | | / _____ \\ | `--' | | `----.| |____ | |\\ \\----.\n|__| |__| /__/ \\__\\ \\______/ |_______||_______|| _| `._____|\n\nhauler: Airgap Swiss Army Knife\n\nGitVersion: 1.0.3\nGitCommit: f7c24f6\nGitTreeState: clean\nBuildDate: 2024-04-24T16:50:33Z\nGoVersion: go1.21.9\nCompiler: gc\nPlatform: darwin/arm64\n"})})]})}function d(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>t,x:()=>_});var i=r(6540);const o={},s=i.createContext(o);function t(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function _(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:t(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/776a8828.55ae4eca.js b/assets/js/776a8828.55ae4eca.js new file mode 100644 index 000000000..9411b061a --- /dev/null +++ b/assets/js/776a8828.55ae4eca.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9184],{4001:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>l,toc:()=>d});var i=n(4848),t=n(8453);const o={title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},r=void 0,l={id:"known-limits",title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",source:"@site/versioned_docs/version-0.4.3/known-limits.md",sourceDirName:".",slug:"/known-limits",permalink:"/docs/0.4.3/known-limits",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.3/known-limits.md",tags:[],version:"0.4.3",frontMatter:{title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},sidebar:"haulerSidebar",previous:{title:"Hauler Version",permalink:"/docs/0.4.3/guides-references/command-line/hauler-version"}},a={},d=[{value:"Issues",id:"issues",level:2},{value:"Limitations",id:"limitations",level:2},{value:"Notices",id:"notices",level:2},{value:"Upcoming Deprecated Command(s):",id:"upcoming-deprecated-commands",level:4}];function c(e){const s={a:"a",code:"code",h2:"h2",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h2,{id:"issues",children:"Issues"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Copying SBOMS to AWS Elastic Container Registry (AWS ECR):","\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["When using ",(0,i.jsx)(s.code,{children:"hauler store copy"})," to AWS ECR, the Software Bill of Materials (SBOM) attachement will fail to copy due to changes in the way ",(0,i.jsx)(s.code,{children:"cosign"})," handles attachments. ",(0,i.jsx)(s.strong,{children:"We are investigating a way forward to address this issue."})]}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"https://github.com/sigstore/cosign/blob/main/specs/SBOM_SPEC.md",children:"https://github.com/sigstore/cosign/blob/main/specs/SBOM_SPEC.md"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"https://github.com/sigstore/cosign/issues/2755",children:"https://github.com/sigstore/cosign/issues/2755"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"limitations",children:"Limitations"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:'No "known" limitations at this time but as a reminder, Hauler and it\'s documentation are in active development and not Generally Available (GA).'}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"notices",children:"Notices"}),"\n",(0,i.jsx)(s.h4,{id:"upcoming-deprecated-commands",children:"Upcoming Deprecated Command(s):"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.code,{children:"hauler download"})," (alternatively ",(0,i.jsx)(s.code,{children:"hauler dl"}),") is deprecated and will be removed in a future release."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.code,{children:"hauler serve"})," is deprecated and will be removed in a future release."]}),"\n"]})]})}function u(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>r,x:()=>l});var i=n(6540);const t={},o=i.createContext(t);function r(e){const s=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/776a8828.938f7c01.js b/assets/js/776a8828.938f7c01.js deleted file mode 100644 index 209d1cdd2..000000000 --- a/assets/js/776a8828.938f7c01.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9184],{4001:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>r,default:()=>u,frontMatter:()=>o,metadata:()=>l,toc:()=>d});var i=n(4848),t=n(8453);const o={title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},r=void 0,l={id:"known-limits",title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",source:"@site/versioned_docs/version-0.4.3/known-limits.md",sourceDirName:".",slug:"/known-limits",permalink:"/hauler-docs/docs/0.4.3/known-limits",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.3/known-limits.md",tags:[],version:"0.4.3",frontMatter:{title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},sidebar:"haulerSidebar",previous:{title:"Hauler Version",permalink:"/hauler-docs/docs/0.4.3/guides-references/command-line/hauler-version"}},a={},d=[{value:"Issues",id:"issues",level:2},{value:"Limitations",id:"limitations",level:2},{value:"Notices",id:"notices",level:2},{value:"Upcoming Deprecated Command(s):",id:"upcoming-deprecated-commands",level:4}];function c(e){const s={a:"a",code:"code",h2:"h2",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h2,{id:"issues",children:"Issues"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Copying SBOMS to AWS Elastic Container Registry (AWS ECR):","\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["When using ",(0,i.jsx)(s.code,{children:"hauler store copy"})," to AWS ECR, the Software Bill of Materials (SBOM) attachement will fail to copy due to changes in the way ",(0,i.jsx)(s.code,{children:"cosign"})," handles attachments. ",(0,i.jsx)(s.strong,{children:"We are investigating a way forward to address this issue."})]}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"https://github.com/sigstore/cosign/blob/main/specs/SBOM_SPEC.md",children:"https://github.com/sigstore/cosign/blob/main/specs/SBOM_SPEC.md"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"https://github.com/sigstore/cosign/issues/2755",children:"https://github.com/sigstore/cosign/issues/2755"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"limitations",children:"Limitations"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:'No "known" limitations at this time but as a reminder, Hauler and it\'s documentation are in active development and not Generally Available (GA).'}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"notices",children:"Notices"}),"\n",(0,i.jsx)(s.h4,{id:"upcoming-deprecated-commands",children:"Upcoming Deprecated Command(s):"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.code,{children:"hauler download"})," (alternatively ",(0,i.jsx)(s.code,{children:"hauler dl"}),") is deprecated and will be removed in a future release."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.code,{children:"hauler serve"})," is deprecated and will be removed in a future release."]}),"\n"]})]})}function u(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>r,x:()=>l});var i=n(6540);const t={},o=i.createContext(t);function r(e){const s=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/798007c7.c6872512.js b/assets/js/798007c7.c6872512.js new file mode 100644 index 000000000..8007cc54a --- /dev/null +++ b/assets/js/798007c7.c6872512.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4622],{77:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>u});var o=r(4848),n=r(8453);const i={title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",sidebar_label:"Overview"},s=void 0,c={id:"guides-references/hauler-collections/overview",title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",source:"@site/versioned_docs/version-0.4.1/guides-references/hauler-collections/overview.md",sourceDirName:"guides-references/hauler-collections",slug:"/guides-references/hauler-collections/overview",permalink:"/docs/0.4.1/guides-references/hauler-collections/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.1/guides-references/hauler-collections/overview.md",tags:[],version:"0.4.1",frontMatter:{title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Fetch Cluster Images",permalink:"/docs/0.4.1/guides-references/cluster-images"},next:{title:"Overview",permalink:"/docs/0.4.1/guides-references/hauler-content/overview"}},l={},u=[];function a(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,o.jsx)(t.p,{children:"Hauler Collections Overview Documentation pending a future release!"})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(a,{...e})}):a(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>s,x:()=>c});var o=r(6540);const n={},i=o.createContext(n);function s(e){const t=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:s(e.components),o.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/798007c7.d39ccc5f.js b/assets/js/798007c7.d39ccc5f.js deleted file mode 100644 index ee833af0b..000000000 --- a/assets/js/798007c7.d39ccc5f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4622],{77:(e,r,o)=>{o.r(r),o.d(r,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>s,metadata:()=>c,toc:()=>u});var t=o(4848),n=o(8453);const s={title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",sidebar_label:"Overview"},i=void 0,c={id:"guides-references/hauler-collections/overview",title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",source:"@site/versioned_docs/version-0.4.1/guides-references/hauler-collections/overview.md",sourceDirName:"guides-references/hauler-collections",slug:"/guides-references/hauler-collections/overview",permalink:"/hauler-docs/docs/0.4.1/guides-references/hauler-collections/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.1/guides-references/hauler-collections/overview.md",tags:[],version:"0.4.1",frontMatter:{title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Fetch Cluster Images",permalink:"/hauler-docs/docs/0.4.1/guides-references/cluster-images"},next:{title:"Overview",permalink:"/hauler-docs/docs/0.4.1/guides-references/hauler-content/overview"}},l={},u=[];function a(e){const r={p:"p",...(0,n.R)(),...e.components};return(0,t.jsx)(r.p,{children:"Hauler Collections Overview Documentation pending a future release!"})}function d(e={}){const{wrapper:r}={...(0,n.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},8453:(e,r,o)=>{o.d(r,{R:()=>i,x:()=>c});var t=o(6540);const n={},s=t.createContext(n);function i(e){const r=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),t.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7c110bd0.c3392a71.js b/assets/js/7c110bd0.c3392a71.js new file mode 100644 index 000000000..c13e68497 --- /dev/null +++ b/assets/js/7c110bd0.c3392a71.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[6877],{2614:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"1.0.x","label":"1.0.x","banner":null,"badge":true,"noIndex":false,"className":"docs-version-1.0.x","isLast":true,"docsSidebars":{"haulerSidebar":[{"type":"link","label":"Introduction","href":"/docs/intro","docId":"intro","unlisted":false},{"type":"link","label":"Core Concepts","href":"/docs/core-concepts","docId":"core-concepts","unlisted":false},{"type":"link","label":"Airgap Workflow","href":"/docs/airgap-workflow","docId":"airgap-workflow","unlisted":false},{"type":"category","label":"Introduction","description":"Introduction Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Quickstart","href":"/docs/introduction/quickstart","docId":"introduction/quickstart","unlisted":false},{"type":"link","label":"Installation","href":"/docs/introduction/install","docId":"introduction/install","unlisted":false},{"type":"link","label":"Uninstall","href":"/docs/introduction/uninstall","docId":"introduction/uninstall","unlisted":false}],"collapsible":true},{"type":"category","label":"Guides & References","description":"Guides and References Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Overview","href":"/docs/guides-references/overview","docId":"guides-references/overview","unlisted":false},{"type":"link","label":"Fetch Cluster Images","href":"/docs/guides-references/cluster-images","docId":"guides-references/cluster-images","unlisted":false},{"type":"link","label":"RGS Carbide Customers","href":"/docs/guides-references/carbide-customers","docId":"guides-references/carbide-customers","unlisted":false},{"type":"category","label":"Bootstrapping Utilities","description":"Guides and References for Hauler Bootstrapping Utilities","collapsed":false,"items":[{"type":"link","label":"Hauler Registry","href":"/docs/guides-references/utilities/registry","docId":"guides-references/utilities/registry","unlisted":false},{"type":"link","label":"Hauler Fileserver","href":"/docs/guides-references/utilities/fileserver","docId":"guides-references/utilities/fileserver","unlisted":false}],"collapsible":true},{"type":"link","label":"Hauler Manifests","href":"/docs/guides-references/manifests","docId":"guides-references/manifests","unlisted":false},{"type":"category","label":"Hauler Collections","description":"Guides and References for Hauler Collections","items":[{"type":"link","label":"Community Collections","href":"/docs/guides-references/hauler-collections/community-collections","docId":"guides-references/hauler-collections/community-collections","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Hauler Content","description":"Guides and References for Hauler Content Types","items":[{"type":"link","label":"Images","href":"/docs/guides-references/hauler-content/images","docId":"guides-references/hauler-content/images","unlisted":false},{"type":"link","label":"Charts","href":"/docs/guides-references/hauler-content/charts","docId":"guides-references/hauler-content/charts","unlisted":false},{"type":"link","label":"Files","href":"/docs/guides-references/hauler-content/files","docId":"guides-references/hauler-content/files","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Hauler Command Line","description":"Guides and References for the Hauler Command Line","items":[{"type":"link","label":"Hauler","href":"/docs/guides-references/command-line/hauler","docId":"guides-references/command-line/hauler","unlisted":false},{"type":"link","label":"Hauler Store","href":"/docs/guides-references/command-line/hauler-store","docId":"guides-references/command-line/hauler-store","unlisted":false},{"type":"link","label":"Hauler Completion","href":"/docs/guides-references/command-line/hauler-completion","docId":"guides-references/command-line/hauler-completion","unlisted":false},{"type":"link","label":"Hauler Version","href":"/docs/guides-references/command-line/hauler-version","docId":"guides-references/command-line/hauler-version","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true},{"type":"link","label":"Known Issues/Limits","href":"/docs/known-limits","docId":"known-limits","unlisted":false},{"type":"link","label":"Feedback","href":"/docs/feedback","docId":"feedback","unlisted":false}]},"docs":{"airgap-workflow":{"id":"airgap-workflow","title":"Airgap Workflow","description":"Airgap Workflow Documentation for Hauler","sidebar":"haulerSidebar"},"core-concepts":{"id":"core-concepts","title":"Core Concepts","description":"Core Concepts Documentation for Hauler","sidebar":"haulerSidebar"},"feedback":{"id":"feedback","title":"Feedback","description":"Feedback for Hauler","sidebar":"haulerSidebar"},"guides-references/carbide-customers":{"id":"guides-references/carbide-customers","title":"RGS Carbide Customers","description":"RGS Carbide Customers Documentation","sidebar":"haulerSidebar"},"guides-references/cluster-images":{"id":"guides-references/cluster-images","title":"Fetching Cluster Images","description":"Fetching Images on a Cluster Documentation","sidebar":"haulerSidebar"},"guides-references/command-line/hauler":{"id":"guides-references/command-line/hauler","title":"Hauler (Command)","description":"Hauler CLI Reference for hauler","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-completion":{"id":"guides-references/command-line/hauler-completion","title":"Hauler Completion (Command)","description":"Hauler CLI Reference for hauler completion","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-login":{"id":"guides-references/command-line/hauler-login","title":"Hauler Login (Command)","description":"Hauler CLI Reference for hauler login"},"guides-references/command-line/hauler-store":{"id":"guides-references/command-line/hauler-store","title":"Hauler Store (Command)","description":"Hauler CLI Reference for hauler store","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-version":{"id":"guides-references/command-line/hauler-version","title":"Hauler Version (Command)","description":"Hauler CLI Reference for hauler version","sidebar":"haulerSidebar"},"guides-references/hauler-collections/community-collections":{"id":"guides-references/hauler-collections/community-collections","title":"Hauler Community Collections","description":"Hauler Community Collections Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/charts":{"id":"guides-references/hauler-content/charts","title":"Hauler Content - Charts","description":"Hauler Content - Charts Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/files":{"id":"guides-references/hauler-content/files","title":"Hauler Content - Files","description":"Hauler Content - Files Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/images":{"id":"guides-references/hauler-content/images","title":"Hauler Content - Images","description":"Hauler Content - Images Documentation","sidebar":"haulerSidebar"},"guides-references/manifests":{"id":"guides-references/manifests","title":"Hauler Manifests","description":"Hauler Manifests Documentation","sidebar":"haulerSidebar"},"guides-references/overview":{"id":"guides-references/overview","title":"Overview","description":"Reference Guides Overview Documentation for Hauler","sidebar":"haulerSidebar"},"guides-references/utilities/fileserver":{"id":"guides-references/utilities/fileserver","title":"Hauler Fileserver","description":"Hauler Fileserver Documentation","sidebar":"haulerSidebar"},"guides-references/utilities/registry":{"id":"guides-references/utilities/registry","title":"Hauler Registry","description":"Hauler Registry Documentation","sidebar":"haulerSidebar"},"intro":{"id":"intro","title":"Introduction","description":"Introduction to Rancher Government Hauler","sidebar":"haulerSidebar"},"introduction/install":{"id":"introduction/install","title":"Installation","description":"Installation Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/quickstart":{"id":"introduction/quickstart","title":"Quickstart","description":"Quickstart Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/uninstall":{"id":"introduction/uninstall","title":"Uninstall","description":"Uninstall Documentation for Hauler","sidebar":"haulerSidebar"},"known-limits":{"id":"known-limits","title":"Known Issues and Limits","description":"Known Issues and Limitations for Hauler","sidebar":"haulerSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/7d221af7.270613d1.js b/assets/js/7d221af7.270613d1.js deleted file mode 100644 index 823478983..000000000 --- a/assets/js/7d221af7.270613d1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8045],{3426:(e,r,o)=>{o.r(r),o.d(r,{assets:()=>l,contentTitle:()=>s,default:()=>u,frontMatter:()=>t,metadata:()=>i,toc:()=>c});var n=o(4848),a=o(8453);const t={title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",sidebar_label:"RGS Carbide Customers"},s=void 0,i={id:"guides-references/carbide-customers",title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",source:"@site/versioned_docs/version-0.4.3/guides-references/carbide-customers.md",sourceDirName:"guides-references",slug:"/guides-references/carbide-customers",permalink:"/hauler-docs/docs/0.4.3/guides-references/carbide-customers",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.3/guides-references/carbide-customers.md",tags:[],version:"0.4.3",frontMatter:{title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",sidebar_label:"RGS Carbide Customers"},sidebar:"haulerSidebar",previous:{title:"Fetch Cluster Images",permalink:"/hauler-docs/docs/0.4.3/guides-references/cluster-images"},next:{title:"Overview",permalink:"/hauler-docs/docs/0.4.3/guides-references/hauler-collections/overview"}},l={},c=[{value:"Example Workflow for Carbide",id:"example-workflow-for-carbide",level:3},{value:"Example Workflow for RKE2",id:"example-workflow-for-rke2",level:3},{value:"Example Workflow for K3S",id:"example-workflow-for-k3s",level:3},{value:"Example Workflow for Rancher",id:"example-workflow-for-rancher",level:3},{value:"Example Workflow for Cert-Manager",id:"example-workflow-for-cert-manager",level:3},{value:"Example Workflow for Longhorn",id:"example-workflow-for-longhorn",level:3},{value:"Example Workflow for NeuVector",id:"example-workflow-for-neuvector",level:3}];function d(e){const r={a:"a",code:"code",h3:"h3",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(r.p,{children:["For all supported customers of Rancher Government Solutions, under the umbrella of Rancher Government Carbide, there is addon functionality within ",(0,n.jsx)(r.code,{children:"Hauler"}),"."]}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"Hauler"})," has the the ability to reference pre-defined ",(0,n.jsx)(r.code,{children:"Hauler"})," manifests from the Carbide Secured Registry (CSR). ",(0,n.jsx)(r.code,{children:"Hauler"})," is built to allow users to fetch, store, package, and distribute content and collections, but most users may be unsure of what to fetch, store, package, and distribue and that is where our supported customers are able to leverage these pre-defined manifests for all of the Rancher products. Below are some of the available ",(0,n.jsx)(r.code,{children:"product"})," flags."]}),"\n",(0,n.jsxs)(r.p,{children:["RGS Carbide Setup Documentation: ",(0,n.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/intro",children:"https://rancherfederal.github.io/carbide-docs/docs/intro"})]}),"\n",(0,n.jsxs)(r.p,{children:["RGS Carbide Public Key: ",(0,n.jsx)(r.a,{href:"https://raw.githubusercontent.com/rancherfederal/carbide-releases/main/carbide-key.pub",children:"https://raw.githubusercontent.com/rancherfederal/carbide-releases/main/carbide-key.pub"})]}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-carbide",children:"Example Workflow for Carbide"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products carbide=v0.1.1 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products carbide=v0.1.1 --platform linux/amd64\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-rke2",children:"Example Workflow for RKE2"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products rke2=v1.26.11+rke2r1 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products rke2=v1.26.11+rke2r1 --platform linux/amd64\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-k3s",children:"Example Workflow for K3S"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products k3s=v1.26.11-k3s2 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products k3s=v1.26.11-k3s2 --platform linux/amd64\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-rancher",children:"Example Workflow for Rancher"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products rancher=v2.8.1 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products rancher=v2.8.1 --platform linux/amd64\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-cert-manager",children:"Example Workflow for Cert-Manager"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products cert-manager=v1.13.3 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products cert-manager=v1.13.3 --platform linux/amd64\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-longhorn",children:"Example Workflow for Longhorn"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products longhorn=v1.5.3 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products longhorn=v1.5.3 --platform linux/amd64\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-neuvector",children:"Example Workflow for NeuVector"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products neuvector=v2.6.6 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products neuvector=v2.6.6 --platform linux/amd64\n"})})]})}function u(e={}){const{wrapper:r}={...(0,a.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,r,o)=>{o.d(r,{R:()=>s,x:()=>i});var n=o(6540);const a={},t=n.createContext(a);function s(e){const r=n.useContext(t);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),n.createElement(t.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7d221af7.6b7de652.js b/assets/js/7d221af7.6b7de652.js new file mode 100644 index 000000000..44f7b45ed --- /dev/null +++ b/assets/js/7d221af7.6b7de652.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8045],{3426:(e,r,o)=>{o.r(r),o.d(r,{assets:()=>l,contentTitle:()=>s,default:()=>u,frontMatter:()=>t,metadata:()=>i,toc:()=>c});var n=o(4848),a=o(8453);const t={title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",sidebar_label:"RGS Carbide Customers"},s=void 0,i={id:"guides-references/carbide-customers",title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",source:"@site/versioned_docs/version-0.4.3/guides-references/carbide-customers.md",sourceDirName:"guides-references",slug:"/guides-references/carbide-customers",permalink:"/docs/0.4.3/guides-references/carbide-customers",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.3/guides-references/carbide-customers.md",tags:[],version:"0.4.3",frontMatter:{title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",sidebar_label:"RGS Carbide Customers"},sidebar:"haulerSidebar",previous:{title:"Fetch Cluster Images",permalink:"/docs/0.4.3/guides-references/cluster-images"},next:{title:"Overview",permalink:"/docs/0.4.3/guides-references/hauler-collections/overview"}},l={},c=[{value:"Example Workflow for Carbide",id:"example-workflow-for-carbide",level:3},{value:"Example Workflow for RKE2",id:"example-workflow-for-rke2",level:3},{value:"Example Workflow for K3S",id:"example-workflow-for-k3s",level:3},{value:"Example Workflow for Rancher",id:"example-workflow-for-rancher",level:3},{value:"Example Workflow for Cert-Manager",id:"example-workflow-for-cert-manager",level:3},{value:"Example Workflow for Longhorn",id:"example-workflow-for-longhorn",level:3},{value:"Example Workflow for NeuVector",id:"example-workflow-for-neuvector",level:3}];function d(e){const r={a:"a",code:"code",h3:"h3",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(r.p,{children:["For all supported customers of Rancher Government Solutions, under the umbrella of Rancher Government Carbide, there is addon functionality within ",(0,n.jsx)(r.code,{children:"Hauler"}),"."]}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"Hauler"})," has the the ability to reference pre-defined ",(0,n.jsx)(r.code,{children:"Hauler"})," manifests from the Carbide Secured Registry (CSR). ",(0,n.jsx)(r.code,{children:"Hauler"})," is built to allow users to fetch, store, package, and distribute content and collections, but most users may be unsure of what to fetch, store, package, and distribue and that is where our supported customers are able to leverage these pre-defined manifests for all of the Rancher products. Below are some of the available ",(0,n.jsx)(r.code,{children:"product"})," flags."]}),"\n",(0,n.jsxs)(r.p,{children:["RGS Carbide Setup Documentation: ",(0,n.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/intro",children:"https://rancherfederal.github.io/carbide-docs/docs/intro"})]}),"\n",(0,n.jsxs)(r.p,{children:["RGS Carbide Public Key: ",(0,n.jsx)(r.a,{href:"https://raw.githubusercontent.com/rancherfederal/carbide-releases/main/carbide-key.pub",children:"https://raw.githubusercontent.com/rancherfederal/carbide-releases/main/carbide-key.pub"})]}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-carbide",children:"Example Workflow for Carbide"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products carbide=v0.1.1 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products carbide=v0.1.1 --platform linux/amd64\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-rke2",children:"Example Workflow for RKE2"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products rke2=v1.26.11+rke2r1 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products rke2=v1.26.11+rke2r1 --platform linux/amd64\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-k3s",children:"Example Workflow for K3S"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products k3s=v1.26.11-k3s2 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products k3s=v1.26.11-k3s2 --platform linux/amd64\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-rancher",children:"Example Workflow for Rancher"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products rancher=v2.8.1 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products rancher=v2.8.1 --platform linux/amd64\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-cert-manager",children:"Example Workflow for Cert-Manager"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products cert-manager=v1.13.3 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products cert-manager=v1.13.3 --platform linux/amd64\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-longhorn",children:"Example Workflow for Longhorn"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products longhorn=v1.5.3 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products longhorn=v1.5.3 --platform linux/amd64\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-neuvector",children:"Example Workflow for NeuVector"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products neuvector=v2.6.6 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products neuvector=v2.6.6 --platform linux/amd64\n"})})]})}function u(e={}){const{wrapper:r}={...(0,a.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,r,o)=>{o.d(r,{R:()=>s,x:()=>i});var n=o(6540);const a={},t=n.createContext(a);function s(e){const r=n.useContext(t);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),n.createElement(t.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/80d0621e.82289bda.js b/assets/js/80d0621e.82289bda.js new file mode 100644 index 000000000..8e2165800 --- /dev/null +++ b/assets/js/80d0621e.82289bda.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1897],{1142:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var o=t(4848),r=t(8453);const i={title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},s=void 0,c={id:"core-concepts",title:"Core Concepts",description:"Core Concepts Documentation for Hauler",source:"@site/versioned_docs/version-0.4.1/core-concepts.md",sourceDirName:".",slug:"/core-concepts",permalink:"/docs/0.4.1/core-concepts",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.1/core-concepts.md",tags:[],version:"0.4.1",frontMatter:{title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},sidebar:"haulerSidebar",previous:{title:"Introduction",permalink:"/docs/0.4.1/intro"},next:{title:"Airgap Workflow",permalink:"/docs/0.4.1/airgap-workflow"}},a={},l=[{value:"Haul",id:"haul",level:2},{value:"Collections",id:"collections",level:2},{value:"Community Collections",id:"community-collections",level:3},{value:"RGS Carbide Collections",id:"rgs-carbide-collections",level:3},{value:"Content",id:"content",level:2},{value:"Declarative Content",id:"declarative-content",level:3}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",ul:"ul",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"hauler-diagram",src:t(6178).A+"",width:"1949",height:"988"})}),"\n",(0,o.jsx)(n.h2,{id:"haul",children:"Haul"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauls"})," are Compressed Archive (Tarball) of Hauler Collections and Content."]})}),"\n",(0,o.jsxs)(n.p,{children:["At the heart of Hauler lies the concept of a ",(0,o.jsx)(n.code,{children:"Haul"}),". A ",(0,o.jsx)(n.code,{children:"Haul"})," is a compressed archive, often in the form of a tarball, containing Hauler collections and content. It serves as a container for grouping and transporting various data types, making it a fundamental element in the Hauler ecosystem."]}),"\n",(0,o.jsx)(n.h2,{id:"collections",children:"Collections"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are Grouping of one or more Hauler Contents."]})}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are the building blocks of Hauler. These are groupings of one or more Hauler ",(0,o.jsx)(n.code,{children:"contents"}),". Think of ",(0,o.jsx)(n.code,{children:"collections"})," as organized sets of data that collectively represent something desirable."]}),"\n",(0,o.jsx)(n.h3,{id:"community-collections",children:"Community Collections"}),"\n",(0,o.jsxs)(n.p,{children:["While ",(0,o.jsx)(n.code,{children:"collections"})," (and ",(0,o.jsx)(n.code,{children:"contents"}),") are built into Hauler, our goal is to empower users to define their own ",(0,o.jsx)(n.code,{children:"collections"}),". This way, you can tailor Hauler to your unique requirements and take full control of your artifacts."]}),"\n",(0,o.jsx)(n.h3,{id:"rgs-carbide-collections",children:"RGS Carbide Collections"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauler"})," provides the ability to import ",(0,o.jsx)(n.code,{children:"collections"})," for the Rancher products, making it seamless for RGS Supported Customers to airgap any of the Rancher products or projects. If you haven't heard of Rancher Government Carbide, check it out ",(0,o.jsx)(n.a,{href:"https://ranchergovernment.com/carbide",children:"here"}),"!"]}),"\n",(0,o.jsx)(n.h2,{id:"content",children:"Content"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Contents"})," are Artifacts such as Images, Charts, or Files."]})}),"\n",(0,o.jsxs)(n.p,{children:["In Hauler's terminology, ",(0,o.jsx)(n.code,{children:"content"})," refers to artifacts such as images, charts, or files. These are the fundamental types of resources that Hauler understands and manages. To understand the term better, let's break it down:"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Content"}),": The fundamental type of artifacts that Hauler recognizes (images, charts, and files)."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Artifact"}),": Anything that can be represented as an OCI (Open Container Initiative) artifact.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"OCI Artifacts provide a standardized way to store arbitrary files, making it easier to manage content efficiently."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"declarative-content",children:"Declarative Content"}),"\n",(0,o.jsxs)(n.p,{children:["While manually adding content to ",(0,o.jsx)(n.code,{children:"Hauler"})," is a straightforward way to get started, we recommend a much more sustainable approach. ",(0,o.jsx)(n.code,{children:"Hauler"})," provides a declarative approach for each ",(0,o.jsx)(n.code,{children:"content"})," type, allowing you to define all the ",(0,o.jsx)(n.code,{children:"content"})," within a manifest. This approach ensures a more reproducable workflow for managing the lifecycle of your ",(0,o.jsx)(n.code,{children:"hauls"}),"."]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},6178:(e,n,t)=>{t.d(n,{A:()=>o});const o=t.p+"assets/images/hauler-diagram-53f9182c0d98fe871fb3cf7fe8cd475a.png"},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var o=t(6540);const r={},i=o.createContext(r);function s(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/80d0621e.95f0c514.js b/assets/js/80d0621e.95f0c514.js deleted file mode 100644 index 4964d55a5..000000000 --- a/assets/js/80d0621e.95f0c514.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1897],{1142:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var o=t(4848),r=t(8453);const i={title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},c=void 0,s={id:"core-concepts",title:"Core Concepts",description:"Core Concepts Documentation for Hauler",source:"@site/versioned_docs/version-0.4.1/core-concepts.md",sourceDirName:".",slug:"/core-concepts",permalink:"/hauler-docs/docs/0.4.1/core-concepts",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.1/core-concepts.md",tags:[],version:"0.4.1",frontMatter:{title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},sidebar:"haulerSidebar",previous:{title:"Introduction",permalink:"/hauler-docs/docs/0.4.1/intro"},next:{title:"Airgap Workflow",permalink:"/hauler-docs/docs/0.4.1/airgap-workflow"}},a={},l=[{value:"Haul",id:"haul",level:2},{value:"Collections",id:"collections",level:2},{value:"Community Collections",id:"community-collections",level:3},{value:"RGS Carbide Collections",id:"rgs-carbide-collections",level:3},{value:"Content",id:"content",level:2},{value:"Declarative Content",id:"declarative-content",level:3}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",ul:"ul",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"hauler-diagram",src:t(6178).A+"",width:"1949",height:"988"})}),"\n",(0,o.jsx)(n.h2,{id:"haul",children:"Haul"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauls"})," are Compressed Archive (Tarball) of Hauler Collections and Content."]})}),"\n",(0,o.jsxs)(n.p,{children:["At the heart of Hauler lies the concept of a ",(0,o.jsx)(n.code,{children:"Haul"}),". A ",(0,o.jsx)(n.code,{children:"Haul"})," is a compressed archive, often in the form of a tarball, containing Hauler collections and content. It serves as a container for grouping and transporting various data types, making it a fundamental element in the Hauler ecosystem."]}),"\n",(0,o.jsx)(n.h2,{id:"collections",children:"Collections"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are Grouping of one or more Hauler Contents."]})}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are the building blocks of Hauler. These are groupings of one or more Hauler ",(0,o.jsx)(n.code,{children:"contents"}),". Think of ",(0,o.jsx)(n.code,{children:"collections"})," as organized sets of data that collectively represent something desirable."]}),"\n",(0,o.jsx)(n.h3,{id:"community-collections",children:"Community Collections"}),"\n",(0,o.jsxs)(n.p,{children:["While ",(0,o.jsx)(n.code,{children:"collections"})," (and ",(0,o.jsx)(n.code,{children:"contents"}),") are built into Hauler, our goal is to empower users to define their own ",(0,o.jsx)(n.code,{children:"collections"}),". This way, you can tailor Hauler to your unique requirements and take full control of your artifacts."]}),"\n",(0,o.jsx)(n.h3,{id:"rgs-carbide-collections",children:"RGS Carbide Collections"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauler"})," provides the ability to import ",(0,o.jsx)(n.code,{children:"collections"})," for the Rancher products, making it seamless for RGS Supported Customers to airgap any of the Rancher products or projects. If you haven't heard of Rancher Government Carbide, check it out ",(0,o.jsx)(n.a,{href:"https://ranchergovernment.com/carbide",children:"here"}),"!"]}),"\n",(0,o.jsx)(n.h2,{id:"content",children:"Content"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Contents"})," are Artifacts such as Images, Charts, or Files."]})}),"\n",(0,o.jsxs)(n.p,{children:["In Hauler's terminology, ",(0,o.jsx)(n.code,{children:"content"})," refers to artifacts such as images, charts, or files. These are the fundamental types of resources that Hauler understands and manages. To understand the term better, let's break it down:"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Content"}),": The fundamental type of artifacts that Hauler recognizes (images, charts, and files)."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Artifact"}),": Anything that can be represented as an OCI (Open Container Initiative) artifact.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"OCI Artifacts provide a standardized way to store arbitrary files, making it easier to manage content efficiently."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"declarative-content",children:"Declarative Content"}),"\n",(0,o.jsxs)(n.p,{children:["While manually adding content to ",(0,o.jsx)(n.code,{children:"Hauler"})," is a straightforward way to get started, we recommend a much more sustainable approach. ",(0,o.jsx)(n.code,{children:"Hauler"})," provides a declarative approach for each ",(0,o.jsx)(n.code,{children:"content"})," type, allowing you to define all the ",(0,o.jsx)(n.code,{children:"content"})," within a manifest. This approach ensures a more reproducable workflow for managing the lifecycle of your ",(0,o.jsx)(n.code,{children:"hauls"}),"."]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},6178:(e,n,t)=>{t.d(n,{A:()=>o});const o=t.p+"assets/images/hauler-diagram-53f9182c0d98fe871fb3cf7fe8cd475a.png"},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>s});var o=t(6540);const r={},i=o.createContext(r);function c(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/82b7e4a8.8252f3b8.js b/assets/js/82b7e4a8.8252f3b8.js deleted file mode 100644 index 5139ef4b5..000000000 --- a/assets/js/82b7e4a8.8252f3b8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2152],{3497:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>d,frontMatter:()=>s,metadata:()=>l,toc:()=>c});var a=r(4848),n=r(8453);const s={title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},o=void 0,l={id:"introduction/quickstart",title:"Quickstart",description:"Quickstart Documentation for Hauler",source:"@site/versioned_docs/version-1.0.0/introduction/quickstart.md",sourceDirName:"introduction",slug:"/introduction/quickstart",permalink:"/hauler-docs/docs/1.0.0/introduction/quickstart",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.0/introduction/quickstart.md",tags:[],version:"1.0.0",frontMatter:{title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},sidebar:"haulerSidebar",previous:{title:"Airgap Workflow",permalink:"/hauler-docs/docs/1.0.0/airgap-workflow"},next:{title:"Installation",permalink:"/hauler-docs/docs/1.0.0/introduction/install"}},i={},c=[{value:"Quick Installation",id:"quick-installation",level:2},{value:"Example Use of Hauler",id:"example-use-of-hauler",level:2},{value:"Add Content to the Hauler Store",id:"add-content-to-the-hauler-store",level:3},{value:"View the Hauler Store",id:"view-the-hauler-store",level:3},{value:"Save the Hauler Store",id:"save-the-hauler-store",level:3},{value:"Load the Airgapped Hauler Store",id:"load-the-airgapped-hauler-store",level:3},{value:"Serve the Hauler Store",id:"serve-the-hauler-store",level:3},{value:"Copy the Hauler Store",id:"copy-the-hauler-store",level:3}];function h(e){const t={code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,n.R)(),...e.components},{Details:r}=t;return r||function(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.p,{children:"Skipping past most of the documentation? Here's an easy to follow Quick Start Guide:"}),"\n",(0,a.jsx)(t.h2,{id:"quick-installation",children:"Quick Installation"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n"})}),"\n",(0,a.jsx)(t.h2,{id:"example-use-of-hauler",children:"Example Use of Hauler"}),"\n",(0,a.jsx)(t.h3,{id:"add-content-to-the-hauler-store",children:"Add Content to the Hauler Store"}),"\n",(0,a.jsxs)(r,{open:!0,children:[(0,a.jsx)("summary",{children:(0,a.jsx)("b",{children:"Using the Command Line:"})}),(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# add a image... defaults to docker.io\nhauler store add image neuvector/scanner:latest\n\n# add a image with a specific platform and with supply chain artifacts\n# may not work for all users due to the specified registry\nhauler store add image rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.2 --platform linux/amd64 --key carbide-key.pub\n\n# add a helm chart with a specific version\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.8.2\n\n# add a file and assign it a new name\nhauler store add file https://get.rke2.io --name install.sh\n"})})]}),"\n",(0,a.jsxs)(r,{children:[(0,a.jsx)("summary",{children:(0,a.jsx)("b",{children:"Using a Hauler Manifest:"})}),(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-yaml",metastring:'title="hauler-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\nspec:\n images:\n - name: neuvector/scanner:latest\n - name: rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.6.0\n key: carbide-key.pub\n platform: linux/amd64\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.8.2\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n - path: https://get.rke2.io\n name: install.sh\n"})}),(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# fetch the content from hauler manifest\nhauler store sync --files hauler-manifest.yaml\n"})})]}),"\n",(0,a.jsx)(t.h3,{id:"view-the-hauler-store",children:"View the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# view and verify the content in the local hauler store\nhauler store info\n"})}),"\n",(0,a.jsx)(t.h3,{id:"save-the-hauler-store",children:"Save the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# save and export the content in the local hauler store\nhauler store save --filename haul.tar.zst\n"})}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsxs)(t.strong,{children:["airgap the ",(0,a.jsx)(t.code,{children:"haul.tar.zst"})," to the disconnected environment"]})}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.h3,{id:"load-the-airgapped-hauler-store",children:"Load the Airgapped Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# load and import the airgapped content to the new local hauler store\nhauler store load haul.tar.zst\n"})}),"\n",(0,a.jsx)(t.h3,{id:"serve-the-hauler-store",children:"Serve the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# serve the content as a registry from the hauler store\n# defaults to :5000\nhauler store serve registry\n\n# serve the file content as a fileserver from the hauler store\n# defaults to :8080\nhauler store serve fileserver\n"})}),"\n",(0,a.jsx)(t.h3,{id:"copy-the-hauler-store",children:"Copy the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# copy the content to a registry from the hauler store\n# copies oci compliant artifacts\nhauler store copy registry://harbor.example.com\n\n# copy the content to a directory from the hauler store\n# copies non oci compliant artifacts\nhauler store copy dir://hauler-files\n"})})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(h,{...e})}):h(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>o,x:()=>l});var a=r(6540);const n={},s=a.createContext(n);function o(e){const t=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:o(e.components),a.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/82b7e4a8.e0a2360e.js b/assets/js/82b7e4a8.e0a2360e.js new file mode 100644 index 000000000..11bf22cf0 --- /dev/null +++ b/assets/js/82b7e4a8.e0a2360e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2152],{3497:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>d,frontMatter:()=>s,metadata:()=>l,toc:()=>c});var a=r(4848),n=r(8453);const s={title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},o=void 0,l={id:"introduction/quickstart",title:"Quickstart",description:"Quickstart Documentation for Hauler",source:"@site/versioned_docs/version-1.0.0/introduction/quickstart.md",sourceDirName:"introduction",slug:"/introduction/quickstart",permalink:"/docs/1.0.0/introduction/quickstart",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.0/introduction/quickstart.md",tags:[],version:"1.0.0",frontMatter:{title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},sidebar:"haulerSidebar",previous:{title:"Airgap Workflow",permalink:"/docs/1.0.0/airgap-workflow"},next:{title:"Installation",permalink:"/docs/1.0.0/introduction/install"}},i={},c=[{value:"Quick Installation",id:"quick-installation",level:2},{value:"Example Use of Hauler",id:"example-use-of-hauler",level:2},{value:"Add Content to the Hauler Store",id:"add-content-to-the-hauler-store",level:3},{value:"View the Hauler Store",id:"view-the-hauler-store",level:3},{value:"Save the Hauler Store",id:"save-the-hauler-store",level:3},{value:"Load the Airgapped Hauler Store",id:"load-the-airgapped-hauler-store",level:3},{value:"Serve the Hauler Store",id:"serve-the-hauler-store",level:3},{value:"Copy the Hauler Store",id:"copy-the-hauler-store",level:3}];function h(e){const t={code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,n.R)(),...e.components},{Details:r}=t;return r||function(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.p,{children:"Skipping past most of the documentation? Here's an easy to follow Quick Start Guide:"}),"\n",(0,a.jsx)(t.h2,{id:"quick-installation",children:"Quick Installation"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n"})}),"\n",(0,a.jsx)(t.h2,{id:"example-use-of-hauler",children:"Example Use of Hauler"}),"\n",(0,a.jsx)(t.h3,{id:"add-content-to-the-hauler-store",children:"Add Content to the Hauler Store"}),"\n",(0,a.jsxs)(r,{open:!0,children:[(0,a.jsx)("summary",{children:(0,a.jsx)("b",{children:"Using the Command Line:"})}),(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# add a image... defaults to docker.io\nhauler store add image neuvector/scanner:latest\n\n# add a image with a specific platform and with supply chain artifacts\n# may not work for all users due to the specified registry\nhauler store add image rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.2 --platform linux/amd64 --key carbide-key.pub\n\n# add a helm chart with a specific version\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.8.2\n\n# add a file and assign it a new name\nhauler store add file https://get.rke2.io --name install.sh\n"})})]}),"\n",(0,a.jsxs)(r,{children:[(0,a.jsx)("summary",{children:(0,a.jsx)("b",{children:"Using a Hauler Manifest:"})}),(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-yaml",metastring:'title="hauler-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\nspec:\n images:\n - name: neuvector/scanner:latest\n - name: rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.6.0\n key: carbide-key.pub\n platform: linux/amd64\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.8.2\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n - path: https://get.rke2.io\n name: install.sh\n"})}),(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# fetch the content from hauler manifest\nhauler store sync --files hauler-manifest.yaml\n"})})]}),"\n",(0,a.jsx)(t.h3,{id:"view-the-hauler-store",children:"View the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# view and verify the content in the local hauler store\nhauler store info\n"})}),"\n",(0,a.jsx)(t.h3,{id:"save-the-hauler-store",children:"Save the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# save and export the content in the local hauler store\nhauler store save --filename haul.tar.zst\n"})}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsxs)(t.strong,{children:["airgap the ",(0,a.jsx)(t.code,{children:"haul.tar.zst"})," to the disconnected environment"]})}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.h3,{id:"load-the-airgapped-hauler-store",children:"Load the Airgapped Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# load and import the airgapped content to the new local hauler store\nhauler store load haul.tar.zst\n"})}),"\n",(0,a.jsx)(t.h3,{id:"serve-the-hauler-store",children:"Serve the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# serve the content as a registry from the hauler store\n# defaults to :5000\nhauler store serve registry\n\n# serve the file content as a fileserver from the hauler store\n# defaults to :8080\nhauler store serve fileserver\n"})}),"\n",(0,a.jsx)(t.h3,{id:"copy-the-hauler-store",children:"Copy the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# copy the content to a registry from the hauler store\n# copies oci compliant artifacts\nhauler store copy registry://harbor.example.com\n\n# copy the content to a directory from the hauler store\n# copies non oci compliant artifacts\nhauler store copy dir://hauler-files\n"})})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(h,{...e})}):h(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>o,x:()=>l});var a=r(6540);const n={},s=a.createContext(n);function o(e){const t=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:o(e.components),a.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/84401c52.a631c6fc.js b/assets/js/84401c52.a631c6fc.js new file mode 100644 index 000000000..4d3e0b19b --- /dev/null +++ b/assets/js/84401c52.a631c6fc.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4026],{2101:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next \ud83d\udea7","banner":"unreleased","badge":true,"noIndex":false,"className":"docs-version-current","isLast":false,"docsSidebars":{"haulerSidebar":[{"type":"link","label":"Introduction","href":"/docs/next/intro","docId":"intro","unlisted":false},{"type":"link","label":"Core Concepts","href":"/docs/next/core-concepts","docId":"core-concepts","unlisted":false},{"type":"link","label":"Airgap Workflow","href":"/docs/next/airgap-workflow","docId":"airgap-workflow","unlisted":false},{"type":"category","label":"Introduction","description":"Introduction Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Quickstart","href":"/docs/next/introduction/quickstart","docId":"introduction/quickstart","unlisted":false},{"type":"link","label":"Installation","href":"/docs/next/introduction/install","docId":"introduction/install","unlisted":false},{"type":"link","label":"Uninstall","href":"/docs/next/introduction/uninstall","docId":"introduction/uninstall","unlisted":false}],"collapsible":true},{"type":"category","label":"Guides & References","description":"Guides and References Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Overview","href":"/docs/next/guides-references/overview","docId":"guides-references/overview","unlisted":false},{"type":"link","label":"Fetch Cluster Images","href":"/docs/next/guides-references/cluster-images","docId":"guides-references/cluster-images","unlisted":false},{"type":"link","label":"RGS Carbide Customers","href":"/docs/next/guides-references/carbide-customers","docId":"guides-references/carbide-customers","unlisted":false},{"type":"category","label":"Bootstrapping Utilities","description":"Guides and References for Hauler Bootstrapping Utilities","collapsed":false,"items":[{"type":"link","label":"Hauler Registry","href":"/docs/next/guides-references/utilities/registry","docId":"guides-references/utilities/registry","unlisted":false},{"type":"link","label":"Hauler Fileserver","href":"/docs/next/guides-references/utilities/fileserver","docId":"guides-references/utilities/fileserver","unlisted":false}],"collapsible":true},{"type":"link","label":"Hauler Manifests","href":"/docs/next/guides-references/manifests","docId":"guides-references/manifests","unlisted":false},{"type":"category","label":"Hauler Collections","description":"Guides and References for Hauler Collections","items":[{"type":"link","label":"Community Collections","href":"/docs/next/guides-references/hauler-collections/community-collections","docId":"guides-references/hauler-collections/community-collections","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Hauler Content","description":"Guides and References for Hauler Content Types","items":[{"type":"link","label":"Images","href":"/docs/next/guides-references/hauler-content/images","docId":"guides-references/hauler-content/images","unlisted":false},{"type":"link","label":"Charts","href":"/docs/next/guides-references/hauler-content/charts","docId":"guides-references/hauler-content/charts","unlisted":false},{"type":"link","label":"Files","href":"/docs/next/guides-references/hauler-content/files","docId":"guides-references/hauler-content/files","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Hauler Command Line","description":"Guides and References for the Hauler Command Line","items":[{"type":"link","label":"Hauler","href":"/docs/next/guides-references/command-line/hauler","docId":"guides-references/command-line/hauler","unlisted":false},{"type":"link","label":"Hauler Store","href":"/docs/next/guides-references/command-line/hauler-store","docId":"guides-references/command-line/hauler-store","unlisted":false},{"type":"link","label":"Hauler Completion","href":"/docs/next/guides-references/command-line/hauler-completion","docId":"guides-references/command-line/hauler-completion","unlisted":false},{"type":"link","label":"Hauler Version","href":"/docs/next/guides-references/command-line/hauler-version","docId":"guides-references/command-line/hauler-version","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true},{"type":"link","label":"Known Issues/Limits","href":"/docs/next/known-limits","docId":"known-limits","unlisted":false},{"type":"link","label":"Feedback","href":"/docs/next/feedback","docId":"feedback","unlisted":false}]},"docs":{"airgap-workflow":{"id":"airgap-workflow","title":"Airgap Workflow","description":"Airgap Workflow Documentation for Hauler","sidebar":"haulerSidebar"},"core-concepts":{"id":"core-concepts","title":"Core Concepts","description":"Core Concepts Documentation for Hauler","sidebar":"haulerSidebar"},"feedback":{"id":"feedback","title":"Feedback","description":"Feedback for Hauler","sidebar":"haulerSidebar"},"guides-references/carbide-customers":{"id":"guides-references/carbide-customers","title":"RGS Carbide Customers","description":"RGS Carbide Customers Documentation","sidebar":"haulerSidebar"},"guides-references/cluster-images":{"id":"guides-references/cluster-images","title":"Fetching Cluster Images","description":"Fetching Images on a Cluster Documentation","sidebar":"haulerSidebar"},"guides-references/command-line/hauler":{"id":"guides-references/command-line/hauler","title":"Hauler (Command)","description":"Hauler CLI Reference for hauler","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-completion":{"id":"guides-references/command-line/hauler-completion","title":"Hauler Completion (Command)","description":"Hauler CLI Reference for hauler completion","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-login":{"id":"guides-references/command-line/hauler-login","title":"Hauler Login (Command)","description":"Hauler CLI Reference for hauler login"},"guides-references/command-line/hauler-store":{"id":"guides-references/command-line/hauler-store","title":"Hauler Store (Command)","description":"Hauler CLI Reference for hauler store","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-version":{"id":"guides-references/command-line/hauler-version","title":"Hauler Version (Command)","description":"Hauler CLI Reference for hauler version","sidebar":"haulerSidebar"},"guides-references/hauler-collections/community-collections":{"id":"guides-references/hauler-collections/community-collections","title":"Hauler Community Collections","description":"Hauler Community Collections Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/charts":{"id":"guides-references/hauler-content/charts","title":"Hauler Content - Charts","description":"Hauler Content - Charts Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/files":{"id":"guides-references/hauler-content/files","title":"Hauler Content - Files","description":"Hauler Content - Files Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/images":{"id":"guides-references/hauler-content/images","title":"Hauler Content - Images","description":"Hauler Content - Images Documentation","sidebar":"haulerSidebar"},"guides-references/manifests":{"id":"guides-references/manifests","title":"Hauler Manifests","description":"Hauler Manifests Documentation","sidebar":"haulerSidebar"},"guides-references/overview":{"id":"guides-references/overview","title":"Overview","description":"Reference Guides Overview Documentation for Hauler","sidebar":"haulerSidebar"},"guides-references/utilities/fileserver":{"id":"guides-references/utilities/fileserver","title":"Hauler Fileserver","description":"Hauler Fileserver Documentation","sidebar":"haulerSidebar"},"guides-references/utilities/registry":{"id":"guides-references/utilities/registry","title":"Hauler Registry","description":"Hauler Registry Documentation","sidebar":"haulerSidebar"},"intro":{"id":"intro","title":"Introduction","description":"Introduction to Rancher Government Hauler","sidebar":"haulerSidebar"},"introduction/install":{"id":"introduction/install","title":"Installation","description":"Installation Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/quickstart":{"id":"introduction/quickstart","title":"Quickstart","description":"Quickstart Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/uninstall":{"id":"introduction/uninstall","title":"Uninstall","description":"Uninstall Documentation for Hauler","sidebar":"haulerSidebar"},"known-limits":{"id":"known-limits","title":"Known Issues and Limits","description":"Known Issues and Limitations for Hauler","sidebar":"haulerSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/84a33f5c.dd81634c.js b/assets/js/84a33f5c.dd81634c.js deleted file mode 100644 index 3222a28f1..000000000 --- a/assets/js/84a33f5c.dd81634c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2236],{2232:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>i,contentTitle:()=>s,default:()=>u,frontMatter:()=>l,metadata:()=>t,toc:()=>c});var o=r(4848),a=r(8453);const l={title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},s=void 0,t={id:"guides-references/command-line/hauler",title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",source:"@site/versioned_docs/version-0.4.3/guides-references/command-line/hauler.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler",permalink:"/hauler-docs/docs/0.4.3/guides-references/command-line/hauler",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.3/guides-references/command-line/hauler.md",tags:[],version:"0.4.3",frontMatter:{title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},sidebar:"haulerSidebar",previous:{title:"Files",permalink:"/hauler-docs/docs/0.4.3/guides-references/hauler-content/files"},next:{title:"Hauler Store",permalink:"/hauler-docs/docs/0.4.3/guides-references/command-line/hauler-store"}},i={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Interact with Hauler's command line."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler [flags]\n hauler [command]\n\nAvailable Commands:\n completion Generates completion scripts for various shells\n download Download OCI content from a registry and populate it on disk\n help Help about any command\n serve Run one or more of hauler\'s embedded servers types\n store Interact with hauler\'s embedded content store\n version Print the current version\n\nFlags:\n -h, --help help for hauler\n -l, --log-level string (default "info")\n\nUse "hauler [command] --help" for more information about a command.\n'})})]})}function u(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>t});var o=r(6540);const a={},l=o.createContext(a);function s(e){const n=o.useContext(l);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),o.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/84a33f5c.e1327cd5.js b/assets/js/84a33f5c.e1327cd5.js new file mode 100644 index 000000000..688f51ab4 --- /dev/null +++ b/assets/js/84a33f5c.e1327cd5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2236],{2232:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>i,contentTitle:()=>l,default:()=>u,frontMatter:()=>t,metadata:()=>s,toc:()=>c});var o=r(4848),a=r(8453);const t={title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},l=void 0,s={id:"guides-references/command-line/hauler",title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",source:"@site/versioned_docs/version-0.4.3/guides-references/command-line/hauler.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler",permalink:"/docs/0.4.3/guides-references/command-line/hauler",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.3/guides-references/command-line/hauler.md",tags:[],version:"0.4.3",frontMatter:{title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},sidebar:"haulerSidebar",previous:{title:"Files",permalink:"/docs/0.4.3/guides-references/hauler-content/files"},next:{title:"Hauler Store",permalink:"/docs/0.4.3/guides-references/command-line/hauler-store"}},i={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Interact with Hauler's command line."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler [flags]\n hauler [command]\n\nAvailable Commands:\n completion Generates completion scripts for various shells\n download Download OCI content from a registry and populate it on disk\n help Help about any command\n serve Run one or more of hauler\'s embedded servers types\n store Interact with hauler\'s embedded content store\n version Print the current version\n\nFlags:\n -h, --help help for hauler\n -l, --log-level string (default "info")\n\nUse "hauler [command] --help" for more information about a command.\n'})})]})}function u(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>s});var o=r(6540);const a={},t=o.createContext(a);function l(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:l(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/86b8ec4f.353725fa.js b/assets/js/86b8ec4f.353725fa.js new file mode 100644 index 000000000..7420518bd --- /dev/null +++ b/assets/js/86b8ec4f.353725fa.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5861],{9687:(e,r,a)=>{a.r(r),a.d(r,{assets:()=>h,contentTitle:()=>c,default:()=>d,frontMatter:()=>s,metadata:()=>o,toc:()=>l});var t=a(4848),n=a(8453);const s={title:"Hauler Content - Charts",description:"Hauler Content - Charts Documentation",sidebar_label:"Charts"},c=void 0,o={id:"guides-references/hauler-content/charts",title:"Hauler Content - Charts",description:"Hauler Content - Charts Documentation",source:"@site/versioned_docs/version-1.0.0/guides-references/hauler-content/charts.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/charts",permalink:"/docs/1.0.0/guides-references/hauler-content/charts",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.0/guides-references/hauler-content/charts.md",tags:[],version:"1.0.0",frontMatter:{title:"Hauler Content - Charts",description:"Hauler Content - Charts Documentation",sidebar_label:"Charts"},sidebar:"haulerSidebar",previous:{title:"Images",permalink:"/docs/1.0.0/guides-references/hauler-content/images"},next:{title:"Files",permalink:"/docs/1.0.0/guides-references/hauler-content/files"}},h={},l=[{value:"Hauler Command Line for Charts",id:"hauler-command-line-for-charts",level:2},{value:"Example Commands for Charts",id:"example-commands-for-charts",level:2},{value:"Hauler Manifest for Charts",id:"hauler-manifest-for-charts",level:2},{value:"Example Manifest for Charts",id:"example-manifest-for-charts",level:2}];function i(e){const r={code:"code",h2:"h2",pre:"pre",...(0,n.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h2,{id:"hauler-command-line-for-charts",children:"Hauler Command Line for Charts"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-bash",children:"hauler store add chart --repo --version \n"})}),"\n",(0,t.jsx)(r.h2,{id:"example-commands-for-charts",children:"Example Commands for Charts"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-bash",children:"# fetch helm chart\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable\n\n# fetch helm chart with specific version\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.8.2\n"})}),"\n",(0,t.jsx)(r.h2,{id:"hauler-manifest-for-charts",children:"Hauler Manifest for Charts"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",metastring:'title="hauler-chart-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n # fetch helm chart\n - name: \n repoURL: \n version: \n"})}),"\n",(0,t.jsx)(r.h2,{id:"example-manifest-for-charts",children:"Example Manifest for Charts"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",metastring:'title="hauler-chart-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n # fetch helm chart\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n # fetch helm chart with specific version\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.8.2\n"})})]})}function d(e={}){const{wrapper:r}={...(0,n.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(i,{...e})}):i(e)}},8453:(e,r,a)=>{a.d(r,{R:()=>c,x:()=>o});var t=a(6540);const n={},s=t.createContext(n);function c(e){const r=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:c(e.components),t.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/86b8ec4f.fd52f03d.js b/assets/js/86b8ec4f.fd52f03d.js deleted file mode 100644 index 1af761810..000000000 --- a/assets/js/86b8ec4f.fd52f03d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5861],{9687:(e,r,a)=>{a.r(r),a.d(r,{assets:()=>h,contentTitle:()=>c,default:()=>d,frontMatter:()=>s,metadata:()=>o,toc:()=>l});var t=a(4848),n=a(8453);const s={title:"Hauler Content - Charts",description:"Hauler Content - Charts Documentation",sidebar_label:"Charts"},c=void 0,o={id:"guides-references/hauler-content/charts",title:"Hauler Content - Charts",description:"Hauler Content - Charts Documentation",source:"@site/versioned_docs/version-1.0.0/guides-references/hauler-content/charts.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/charts",permalink:"/hauler-docs/docs/1.0.0/guides-references/hauler-content/charts",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.0/guides-references/hauler-content/charts.md",tags:[],version:"1.0.0",frontMatter:{title:"Hauler Content - Charts",description:"Hauler Content - Charts Documentation",sidebar_label:"Charts"},sidebar:"haulerSidebar",previous:{title:"Images",permalink:"/hauler-docs/docs/1.0.0/guides-references/hauler-content/images"},next:{title:"Files",permalink:"/hauler-docs/docs/1.0.0/guides-references/hauler-content/files"}},h={},l=[{value:"Hauler Command Line for Charts",id:"hauler-command-line-for-charts",level:2},{value:"Example Commands for Charts",id:"example-commands-for-charts",level:2},{value:"Hauler Manifest for Charts",id:"hauler-manifest-for-charts",level:2},{value:"Example Manifest for Charts",id:"example-manifest-for-charts",level:2}];function i(e){const r={code:"code",h2:"h2",pre:"pre",...(0,n.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h2,{id:"hauler-command-line-for-charts",children:"Hauler Command Line for Charts"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-bash",children:"hauler store add chart --repo --version \n"})}),"\n",(0,t.jsx)(r.h2,{id:"example-commands-for-charts",children:"Example Commands for Charts"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-bash",children:"# fetch helm chart\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable\n\n# fetch helm chart with specific version\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.8.2\n"})}),"\n",(0,t.jsx)(r.h2,{id:"hauler-manifest-for-charts",children:"Hauler Manifest for Charts"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",metastring:'title="hauler-chart-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n # fetch helm chart\n - name: \n repoURL: \n version: \n"})}),"\n",(0,t.jsx)(r.h2,{id:"example-manifest-for-charts",children:"Example Manifest for Charts"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",metastring:'title="hauler-chart-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n # fetch helm chart\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n # fetch helm chart with specific version\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.8.2\n"})})]})}function d(e={}){const{wrapper:r}={...(0,n.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(i,{...e})}):i(e)}},8453:(e,r,a)=>{a.d(r,{R:()=>c,x:()=>o});var t=a(6540);const n={},s=t.createContext(n);function c(e){const r=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:c(e.components),t.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/86cd4487.60849ade.js b/assets/js/86cd4487.60849ade.js new file mode 100644 index 000000000..0597729e7 --- /dev/null +++ b/assets/js/86cd4487.60849ade.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3819],{1596:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>t,toc:()=>c});var o=r(4848),s=r(8453);const i={title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},l=void 0,t={id:"guides-references/command-line/hauler-version",title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",source:"@site/versioned_docs/version-0.4.0/guides-references/command-line/hauler-version.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-version",permalink:"/docs/0.4.0/guides-references/command-line/hauler-version",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.0/guides-references/command-line/hauler-version.md",tags:[],version:"0.4.0",frontMatter:{title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},sidebar:"haulerSidebar",previous:{title:"Hauler Completion",permalink:"/docs/0.4.0/guides-references/command-line/hauler-completion"},next:{title:"Known Issues/Limits",permalink:"/docs/0.4.0/known-limits"}},a={},c=[{value:"Command Overview",id:"command-overview",level:3}];function u(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Print Hauler's current version."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler version [flags]\n\nAliases:\n version, v\n\nFlags:\n -h, --help help for version\n --json toggle output in JSON\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>t});var o=r(6540);const s={},i=o.createContext(s);function l(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/86cd4487.e0b78c47.js b/assets/js/86cd4487.e0b78c47.js deleted file mode 100644 index 028d989cd..000000000 --- a/assets/js/86cd4487.e0b78c47.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3819],{1596:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>t,contentTitle:()=>l,default:()=>u,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var o=r(4848),s=r(8453);const i={title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},l=void 0,a={id:"guides-references/command-line/hauler-version",title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",source:"@site/versioned_docs/version-0.4.0/guides-references/command-line/hauler-version.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-version",permalink:"/hauler-docs/docs/0.4.0/guides-references/command-line/hauler-version",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.0/guides-references/command-line/hauler-version.md",tags:[],version:"0.4.0",frontMatter:{title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},sidebar:"haulerSidebar",previous:{title:"Hauler Completion",permalink:"/hauler-docs/docs/0.4.0/guides-references/command-line/hauler-completion"},next:{title:"Known Issues/Limits",permalink:"/hauler-docs/docs/0.4.0/known-limits"}},t={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Print Hauler's current version."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler version [flags]\n\nAliases:\n version, v\n\nFlags:\n -h, --help help for version\n --json toggle output in JSON\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>a});var o=r(6540);const s={},i=o.createContext(s);function l(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8981c19b.5cc0699d.js b/assets/js/8981c19b.5cc0699d.js new file mode 100644 index 000000000..1cd9d3848 --- /dev/null +++ b/assets/js/8981c19b.5cc0699d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2818],{1589:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"0.4.2","label":"0.4.2","banner":"unmaintained","badge":true,"noIndex":false,"className":"docs-version-0.4.2","isLast":false,"docsSidebars":{"haulerSidebar":[{"type":"link","label":"Introduction","href":"/docs/0.4.2/intro","docId":"intro","unlisted":false},{"type":"link","label":"Core Concepts","href":"/docs/0.4.2/core-concepts","docId":"core-concepts","unlisted":false},{"type":"link","label":"Airgap Workflow","href":"/docs/0.4.2/airgap-workflow","docId":"airgap-workflow","unlisted":false},{"type":"category","label":"Introduction","description":"Introduction Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Quickstart","href":"/docs/0.4.2/introduction/quickstart","docId":"introduction/quickstart","unlisted":false},{"type":"link","label":"Installation","href":"/docs/0.4.2/introduction/install","docId":"introduction/install","unlisted":false},{"type":"link","label":"Uninstall","href":"/docs/0.4.2/introduction/uninstall","docId":"introduction/uninstall","unlisted":false}],"collapsible":true},{"type":"category","label":"Guides & References","description":"Guides and References Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Overview","href":"/docs/0.4.2/guides-references/overview","docId":"guides-references/overview","unlisted":false},{"type":"link","label":"Fetch Cluster Images","href":"/docs/0.4.2/guides-references/cluster-images","docId":"guides-references/cluster-images","unlisted":false},{"type":"link","label":"RGS Carbide Customers","href":"/docs/0.4.2/guides-references/carbide-customers","docId":"guides-references/carbide-customers","unlisted":false},{"type":"category","label":"Hauler Collections","description":"Guides and References for Hauler Collections","items":[{"type":"link","label":"Overview","href":"/docs/0.4.2/guides-references/hauler-collections/overview","docId":"guides-references/hauler-collections/overview","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Hauler Content","description":"Guides and References for Hauler Content Types","items":[{"type":"link","label":"Overview","href":"/docs/0.4.2/guides-references/hauler-content/overview","docId":"guides-references/hauler-content/overview","unlisted":false},{"type":"link","label":"Images","href":"/docs/0.4.2/guides-references/hauler-content/images","docId":"guides-references/hauler-content/images","unlisted":false},{"type":"link","label":"Charts","href":"/docs/0.4.2/guides-references/hauler-content/charts","docId":"guides-references/hauler-content/charts","unlisted":false},{"type":"link","label":"Files","href":"/docs/0.4.2/guides-references/hauler-content/files","docId":"guides-references/hauler-content/files","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Command Line Interface","description":"Guides and References for the Hauler Command Line","items":[{"type":"link","label":"Hauler","href":"/docs/0.4.2/guides-references/command-line/hauler","docId":"guides-references/command-line/hauler","unlisted":false},{"type":"link","label":"Hauler Store","href":"/docs/0.4.2/guides-references/command-line/hauler-store","docId":"guides-references/command-line/hauler-store","unlisted":false},{"type":"link","label":"Hauler Completion","href":"/docs/0.4.2/guides-references/command-line/hauler-completion","docId":"guides-references/command-line/hauler-completion","unlisted":false},{"type":"link","label":"Hauler Version","href":"/docs/0.4.2/guides-references/command-line/hauler-version","docId":"guides-references/command-line/hauler-version","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true},{"type":"link","label":"Known Issues/Limits","href":"/docs/0.4.2/known-limits","docId":"known-limits","unlisted":false}]},"docs":{"airgap-workflow":{"id":"airgap-workflow","title":"Airgap Workflow","description":"Airgap Workflow Documentation for Hauler","sidebar":"haulerSidebar"},"core-concepts":{"id":"core-concepts","title":"Core Concepts","description":"Core Concepts Documentation for Hauler","sidebar":"haulerSidebar"},"guides-references/carbide-customers":{"id":"guides-references/carbide-customers","title":"RGS Carbide Customers","description":"RGS Carbide Customers Documentation","sidebar":"haulerSidebar"},"guides-references/cluster-images":{"id":"guides-references/cluster-images","title":"Fetching Cluster Images","description":"Fetching Images on a Cluster Documentation","sidebar":"haulerSidebar"},"guides-references/command-line/hauler":{"id":"guides-references/command-line/hauler","title":"Hauler (Command)","description":"Hauler CLI Reference for hauler","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-completion":{"id":"guides-references/command-line/hauler-completion","title":"Hauler Completion (Command)","description":"Hauler CLI Reference for hauler completion","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-store":{"id":"guides-references/command-line/hauler-store","title":"Hauler Store (Command)","description":"Hauler CLI Reference for hauler store","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-version":{"id":"guides-references/command-line/hauler-version","title":"Hauler Version (Command)","description":"Hauler CLI Reference for hauler version","sidebar":"haulerSidebar"},"guides-references/hauler-collections/overview":{"id":"guides-references/hauler-collections/overview","title":"Overview of Hauler Collections","description":"Hauler Collections Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/charts":{"id":"guides-references/hauler-content/charts","title":"Charts (Content Type)","description":"Hauler \\"Charts\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/files":{"id":"guides-references/hauler-content/files","title":"Files (Content Type)","description":"Hauler \\"Files\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/images":{"id":"guides-references/hauler-content/images","title":"Images (Content Type)","description":"Hauler \\"Images\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/overview":{"id":"guides-references/hauler-content/overview","title":"Overview of Hauler Content","description":"Hauler Content Documentation","sidebar":"haulerSidebar"},"guides-references/overview":{"id":"guides-references/overview","title":"Overview","description":"Reference Guides Overview Documentation for Hauler","sidebar":"haulerSidebar"},"intro":{"id":"intro","title":"Introduction","description":"Introduction to Rancher Government Hauler","sidebar":"haulerSidebar"},"introduction/install":{"id":"introduction/install","title":"Installation","description":"Installation Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/quickstart":{"id":"introduction/quickstart","title":"Quickstart","description":"Quickstart Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/uninstall":{"id":"introduction/uninstall","title":"Uninstall","description":"Uninstall Documentation for Hauler","sidebar":"haulerSidebar"},"known-limits":{"id":"known-limits","title":"Known Issues and Limits","description":"Known Issues and Limitations for Hauler","sidebar":"haulerSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/8995c3a4.656191f3.js b/assets/js/8995c3a4.656191f3.js deleted file mode 100644 index e00af0724..000000000 --- a/assets/js/8995c3a4.656191f3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2005],{7716:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>n,metadata:()=>c,toc:()=>d});var s=t(4848),o=t(8453);const n={title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",sidebar_label:"RGS Carbide Customers"},i=void 0,c={id:"guides-references/carbide-customers",title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",source:"@site/versioned_docs/version-1.0.x/guides-references/carbide-customers.md",sourceDirName:"guides-references",slug:"/guides-references/carbide-customers",permalink:"/hauler-docs/docs/guides-references/carbide-customers",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/carbide-customers.md",tags:[],version:"1.0.x",frontMatter:{title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",sidebar_label:"RGS Carbide Customers"},sidebar:"haulerSidebar",previous:{title:"Fetch Cluster Images",permalink:"/hauler-docs/docs/guides-references/cluster-images"},next:{title:"Hauler Registry",permalink:"/hauler-docs/docs/guides-references/utilities/registry"}},a={},d=[];function l(e){const r={a:"a",code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(r.p,{children:["For all supported customers of Rancher Government Solutions, under the umbrella of Rancher Government Carbide, there is addon functionality within ",(0,s.jsx)(r.code,{children:"Hauler"}),"."]}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"Hauler"})," has the the ability to reference ",(0,s.jsx)(r.code,{children:"Collections"})," from the Carbide Secured Registry (CSR). ",(0,s.jsx)(r.code,{children:"Hauler"})," is built to allow operators to fetch, store, package, and distribute content and collections, but most operators may be unsure of what to fetch, store, package, and distribue and that is where our supported customers are able to leverage these pre-defined manifests for all of the Rancher products. Below are some of the available ",(0,s.jsx)(r.code,{children:"product"})," flags."]}),"\n",(0,s.jsxs)(r.p,{children:["Please see the ",(0,s.jsx)(r.strong,{children:(0,s.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/intro",children:"Carbide Documentation"})})," for easily fetching, packing, and distributing Carbide with the ",(0,s.jsx)(r.code,{children:"hauler store sync --products ="}),". Please know that we are actively working to improve this workflow."]}),"\n",(0,s.jsxs)(r.ul,{children:["\n",(0,s.jsx)(r.li,{children:(0,s.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/registry-docs/copying-images",children:"Connected Environments"})}),"\n",(0,s.jsx)(r.li,{children:(0,s.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/registry-docs/downloading-images",children:"Disconnected Environments"})}),"\n"]})]})}function u(e={}){const{wrapper:r}={...(0,o.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>i,x:()=>c});var s=t(6540);const o={},n=s.createContext(o);function i(e){const r=s.useContext(n);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),s.createElement(n.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8995c3a4.6cef6bbd.js b/assets/js/8995c3a4.6cef6bbd.js new file mode 100644 index 000000000..eb1bcaf8f --- /dev/null +++ b/assets/js/8995c3a4.6cef6bbd.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2005],{7716:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>d,contentTitle:()=>i,default:()=>u,frontMatter:()=>n,metadata:()=>c,toc:()=>a});var s=t(4848),o=t(8453);const n={title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",sidebar_label:"RGS Carbide Customers"},i=void 0,c={id:"guides-references/carbide-customers",title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",source:"@site/versioned_docs/version-1.0.x/guides-references/carbide-customers.md",sourceDirName:"guides-references",slug:"/guides-references/carbide-customers",permalink:"/docs/guides-references/carbide-customers",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/carbide-customers.md",tags:[],version:"1.0.x",frontMatter:{title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",sidebar_label:"RGS Carbide Customers"},sidebar:"haulerSidebar",previous:{title:"Fetch Cluster Images",permalink:"/docs/guides-references/cluster-images"},next:{title:"Hauler Registry",permalink:"/docs/guides-references/utilities/registry"}},d={},a=[];function l(e){const r={a:"a",code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(r.p,{children:["For all supported customers of Rancher Government Solutions, under the umbrella of Rancher Government Carbide, there is addon functionality within ",(0,s.jsx)(r.code,{children:"Hauler"}),"."]}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"Hauler"})," has the the ability to reference ",(0,s.jsx)(r.code,{children:"Collections"})," from the Carbide Secured Registry (CSR). ",(0,s.jsx)(r.code,{children:"Hauler"})," is built to allow operators to fetch, store, package, and distribute content and collections, but most operators may be unsure of what to fetch, store, package, and distribue and that is where our supported customers are able to leverage these pre-defined manifests for all of the Rancher products. Below are some of the available ",(0,s.jsx)(r.code,{children:"product"})," flags."]}),"\n",(0,s.jsxs)(r.p,{children:["Please see the ",(0,s.jsx)(r.strong,{children:(0,s.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/intro",children:"Carbide Documentation"})})," for easily fetching, packing, and distributing Carbide with the ",(0,s.jsx)(r.code,{children:"hauler store sync --products ="}),". Please know that we are actively working to improve this workflow."]}),"\n",(0,s.jsxs)(r.ul,{children:["\n",(0,s.jsx)(r.li,{children:(0,s.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/registry-docs/copying-images",children:"Connected Environments"})}),"\n",(0,s.jsx)(r.li,{children:(0,s.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/registry-docs/downloading-images",children:"Disconnected Environments"})}),"\n"]})]})}function u(e={}){const{wrapper:r}={...(0,o.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>i,x:()=>c});var s=t(6540);const o={},n=s.createContext(o);function i(e){const r=s.useContext(n);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),s.createElement(n.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8a1acfe9.272b6964.js b/assets/js/8a1acfe9.272b6964.js deleted file mode 100644 index 7ebe26079..000000000 --- a/assets/js/8a1acfe9.272b6964.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9025],{9280:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"0.4.1","label":"0.4.1","banner":"unmaintained","badge":true,"noIndex":false,"className":"docs-version-0.4.1","isLast":false,"docsSidebars":{"haulerSidebar":[{"type":"link","label":"Introduction","href":"/hauler-docs/docs/0.4.1/intro","docId":"intro","unlisted":false},{"type":"link","label":"Core Concepts","href":"/hauler-docs/docs/0.4.1/core-concepts","docId":"core-concepts","unlisted":false},{"type":"link","label":"Airgap Workflow","href":"/hauler-docs/docs/0.4.1/airgap-workflow","docId":"airgap-workflow","unlisted":false},{"type":"category","label":"Introduction","description":"Introduction Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Quickstart","href":"/hauler-docs/docs/0.4.1/introduction/quickstart","docId":"introduction/quickstart","unlisted":false},{"type":"link","label":"Installation","href":"/hauler-docs/docs/0.4.1/introduction/install","docId":"introduction/install","unlisted":false},{"type":"link","label":"Uninstall","href":"/hauler-docs/docs/0.4.1/introduction/uninstall","docId":"introduction/uninstall","unlisted":false}],"collapsible":true},{"type":"category","label":"Guides & References","description":"Guides and References Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Overview","href":"/hauler-docs/docs/0.4.1/guides-references/overview","docId":"guides-references/overview","unlisted":false},{"type":"link","label":"Fetch Cluster Images","href":"/hauler-docs/docs/0.4.1/guides-references/cluster-images","docId":"guides-references/cluster-images","unlisted":false},{"type":"category","label":"Hauler Collections","description":"Guides and References for Hauler Collections","items":[{"type":"link","label":"Overview","href":"/hauler-docs/docs/0.4.1/guides-references/hauler-collections/overview","docId":"guides-references/hauler-collections/overview","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Hauler Content","description":"Guides and References for Hauler Content Types","items":[{"type":"link","label":"Overview","href":"/hauler-docs/docs/0.4.1/guides-references/hauler-content/overview","docId":"guides-references/hauler-content/overview","unlisted":false},{"type":"link","label":"Images","href":"/hauler-docs/docs/0.4.1/guides-references/hauler-content/images","docId":"guides-references/hauler-content/images","unlisted":false},{"type":"link","label":"Charts","href":"/hauler-docs/docs/0.4.1/guides-references/hauler-content/charts","docId":"guides-references/hauler-content/charts","unlisted":false},{"type":"link","label":"Files","href":"/hauler-docs/docs/0.4.1/guides-references/hauler-content/files","docId":"guides-references/hauler-content/files","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Command Line Interface","description":"Guides and References for the Hauler Command Line","items":[{"type":"link","label":"Hauler","href":"/hauler-docs/docs/0.4.1/guides-references/command-line/hauler","docId":"guides-references/command-line/hauler","unlisted":false},{"type":"link","label":"Hauler Store","href":"/hauler-docs/docs/0.4.1/guides-references/command-line/hauler-store","docId":"guides-references/command-line/hauler-store","unlisted":false},{"type":"link","label":"Hauler Completion","href":"/hauler-docs/docs/0.4.1/guides-references/command-line/hauler-completion","docId":"guides-references/command-line/hauler-completion","unlisted":false},{"type":"link","label":"Hauler Version","href":"/hauler-docs/docs/0.4.1/guides-references/command-line/hauler-version","docId":"guides-references/command-line/hauler-version","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true},{"type":"link","label":"Known Issues/Limits","href":"/hauler-docs/docs/0.4.1/known-limits","docId":"known-limits","unlisted":false}]},"docs":{"airgap-workflow":{"id":"airgap-workflow","title":"Airgap Workflow","description":"Airgap Workflow Documentation for Hauler","sidebar":"haulerSidebar"},"core-concepts":{"id":"core-concepts","title":"Core Concepts","description":"Core Concepts Documentation for Hauler","sidebar":"haulerSidebar"},"guides-references/cluster-images":{"id":"guides-references/cluster-images","title":"Fetching Cluster Images","description":"Fetching Images on a Cluster Documentation","sidebar":"haulerSidebar"},"guides-references/command-line/hauler":{"id":"guides-references/command-line/hauler","title":"Hauler (Command)","description":"Hauler CLI Reference for hauler","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-completion":{"id":"guides-references/command-line/hauler-completion","title":"Hauler Completion (Command)","description":"Hauler CLI Reference for hauler completion","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-store":{"id":"guides-references/command-line/hauler-store","title":"Hauler Store (Command)","description":"Hauler CLI Reference for hauler store","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-version":{"id":"guides-references/command-line/hauler-version","title":"Hauler Version (Command)","description":"Hauler CLI Reference for hauler version","sidebar":"haulerSidebar"},"guides-references/hauler-collections/overview":{"id":"guides-references/hauler-collections/overview","title":"Overview of Hauler Collections","description":"Hauler Collections Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/charts":{"id":"guides-references/hauler-content/charts","title":"Charts (Content Type)","description":"Hauler \\"Charts\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/files":{"id":"guides-references/hauler-content/files","title":"Files (Content Type)","description":"Hauler \\"Files\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/images":{"id":"guides-references/hauler-content/images","title":"Images (Content Type)","description":"Hauler \\"Images\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/overview":{"id":"guides-references/hauler-content/overview","title":"Overview of Hauler Content","description":"Hauler Content Documentation","sidebar":"haulerSidebar"},"guides-references/overview":{"id":"guides-references/overview","title":"Overview","description":"Reference Guides Overview Documentation for Hauler","sidebar":"haulerSidebar"},"intro":{"id":"intro","title":"Introduction","description":"Introduction to Rancher Government Hauler","sidebar":"haulerSidebar"},"introduction/install":{"id":"introduction/install","title":"Installation","description":"Installation Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/quickstart":{"id":"introduction/quickstart","title":"Quickstart","description":"Quickstart Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/uninstall":{"id":"introduction/uninstall","title":"Uninstall","description":"Uninstall Documentation for Hauler","sidebar":"haulerSidebar"},"known-limits":{"id":"known-limits","title":"Known Issues and Limits","description":"Known Issues and Limitations for Hauler","sidebar":"haulerSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/8b123aa6.35849cc4.js b/assets/js/8b123aa6.35849cc4.js deleted file mode 100644 index 4c2ceaaf1..000000000 --- a/assets/js/8b123aa6.35849cc4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7117],{2330:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>i,contentTitle:()=>t,default:()=>u,frontMatter:()=>l,metadata:()=>s,toc:()=>c});var o=r(4848),a=r(8453);const l={title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},t=void 0,s={id:"guides-references/command-line/hauler",title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",source:"@site/versioned_docs/version-1.0.x/guides-references/command-line/hauler.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler",permalink:"/hauler-docs/docs/guides-references/command-line/hauler",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/command-line/hauler.md",tags:[],version:"1.0.x",frontMatter:{title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},sidebar:"haulerSidebar",previous:{title:"Files",permalink:"/hauler-docs/docs/guides-references/hauler-content/files"},next:{title:"Hauler Store",permalink:"/hauler-docs/docs/guides-references/command-line/hauler-store"}},i={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Interact with Hauler's command line."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler [flags]\n hauler [command]\n\nAvailable Commands:\n completion Generates completion scripts for various shells\n help Help about any command\n login Log in to a registry\n store Interact with hauler\'s embedded content store\n version Print the current version\n\nFlags:\n -h, --help help for hauler\n -l, --log-level string (default "info")\n\nUse "hauler [command] --help" for more information about a command.\n'})})]})}function u(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>t,x:()=>s});var o=r(6540);const a={},l=o.createContext(a);function t(e){const n=o.useContext(l);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:t(e.components),o.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8b123aa6.ab1928f7.js b/assets/js/8b123aa6.ab1928f7.js new file mode 100644 index 000000000..c16237b26 --- /dev/null +++ b/assets/js/8b123aa6.ab1928f7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7117],{2330:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>i,contentTitle:()=>l,default:()=>u,frontMatter:()=>a,metadata:()=>s,toc:()=>c});var o=r(4848),t=r(8453);const a={title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},l=void 0,s={id:"guides-references/command-line/hauler",title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",source:"@site/versioned_docs/version-1.0.x/guides-references/command-line/hauler.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler",permalink:"/docs/guides-references/command-line/hauler",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/command-line/hauler.md",tags:[],version:"1.0.x",frontMatter:{title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},sidebar:"haulerSidebar",previous:{title:"Files",permalink:"/docs/guides-references/hauler-content/files"},next:{title:"Hauler Store",permalink:"/docs/guides-references/command-line/hauler-store"}},i={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Interact with Hauler's command line."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler [flags]\n hauler [command]\n\nAvailable Commands:\n completion Generates completion scripts for various shells\n help Help about any command\n login Log in to a registry\n store Interact with hauler\'s embedded content store\n version Print the current version\n\nFlags:\n -h, --help help for hauler\n -l, --log-level string (default "info")\n\nUse "hauler [command] --help" for more information about a command.\n'})})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>s});var o=r(6540);const t={},a=o.createContext(t);function l(e){const n=o.useContext(a);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),o.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8e4a7bb4.08ff96d6.js b/assets/js/8e4a7bb4.08ff96d6.js deleted file mode 100644 index d96b3600b..000000000 --- a/assets/js/8e4a7bb4.08ff96d6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8126],{204:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var i=n(4848),t=n(8453);const r={title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},o=void 0,a={id:"known-limits",title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",source:"@site/versioned_docs/version-0.4.2/known-limits.md",sourceDirName:".",slug:"/known-limits",permalink:"/hauler-docs/docs/0.4.2/known-limits",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.2/known-limits.md",tags:[],version:"0.4.2",frontMatter:{title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},sidebar:"haulerSidebar",previous:{title:"Hauler Version",permalink:"/hauler-docs/docs/0.4.2/guides-references/command-line/hauler-version"}},l={},c=[{value:"Issues",id:"issues",level:2},{value:"Limitations",id:"limitations",level:2},{value:"Notices",id:"notices",level:2},{value:"Upcoming Deprecated Command(s):",id:"upcoming-deprecated-commands",level:4}];function d(e){const s={a:"a",code:"code",h2:"h2",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h2,{id:"issues",children:"Issues"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Copying SBOMS to AWS Elastic Container Registry (AWS ECR):","\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["When using ",(0,i.jsx)(s.code,{children:"hauler store copy"})," to AWS ECR, the Software Bill of Materials (SBOM) attachement will fail to copy due to changes in the way ",(0,i.jsx)(s.code,{children:"cosign"})," handles attachments. ",(0,i.jsx)(s.strong,{children:"We are investigating a way forward to address this issue."})]}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"https://github.com/sigstore/cosign/blob/main/specs/SBOM_SPEC.md",children:"https://github.com/sigstore/cosign/blob/main/specs/SBOM_SPEC.md"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"https://github.com/sigstore/cosign/issues/2755",children:"https://github.com/sigstore/cosign/issues/2755"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"limitations",children:"Limitations"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Display of Information in the Hauler Store:","\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["When using ",(0,i.jsx)(s.code,{children:"hauler store info"})," with signature verification, you may encounter errors in the presentation of the number layers and size of layers in the store. Hauler is correctly fetching, storing, packaging, and distributing each image, but the presentation and display can error. ",(0,i.jsx)(s.strong,{children:"We are actively working to address and fix this issue."})]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"notices",children:"Notices"}),"\n",(0,i.jsx)(s.h4,{id:"upcoming-deprecated-commands",children:"Upcoming Deprecated Command(s):"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.code,{children:"hauler download"})," (alternatively ",(0,i.jsx)(s.code,{children:"hauler dl"}),") is deprecated and will be removed in a future release."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.code,{children:"hauler serve"})," is deprecated and will be removed in a future release."]}),"\n"]})]})}function u(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>o,x:()=>a});var i=n(6540);const t={},r=i.createContext(t);function o(e){const s=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8e4a7bb4.f0eb7d28.js b/assets/js/8e4a7bb4.f0eb7d28.js new file mode 100644 index 000000000..94ebc1470 --- /dev/null +++ b/assets/js/8e4a7bb4.f0eb7d28.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8126],{204:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=n(4848),t=n(8453);const r={title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},o=void 0,a={id:"known-limits",title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",source:"@site/versioned_docs/version-0.4.2/known-limits.md",sourceDirName:".",slug:"/known-limits",permalink:"/docs/0.4.2/known-limits",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.2/known-limits.md",tags:[],version:"0.4.2",frontMatter:{title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},sidebar:"haulerSidebar",previous:{title:"Hauler Version",permalink:"/docs/0.4.2/guides-references/command-line/hauler-version"}},l={},d=[{value:"Issues",id:"issues",level:2},{value:"Limitations",id:"limitations",level:2},{value:"Notices",id:"notices",level:2},{value:"Upcoming Deprecated Command(s):",id:"upcoming-deprecated-commands",level:4}];function c(e){const s={a:"a",code:"code",h2:"h2",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h2,{id:"issues",children:"Issues"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Copying SBOMS to AWS Elastic Container Registry (AWS ECR):","\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["When using ",(0,i.jsx)(s.code,{children:"hauler store copy"})," to AWS ECR, the Software Bill of Materials (SBOM) attachement will fail to copy due to changes in the way ",(0,i.jsx)(s.code,{children:"cosign"})," handles attachments. ",(0,i.jsx)(s.strong,{children:"We are investigating a way forward to address this issue."})]}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"https://github.com/sigstore/cosign/blob/main/specs/SBOM_SPEC.md",children:"https://github.com/sigstore/cosign/blob/main/specs/SBOM_SPEC.md"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"https://github.com/sigstore/cosign/issues/2755",children:"https://github.com/sigstore/cosign/issues/2755"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"limitations",children:"Limitations"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Display of Information in the Hauler Store:","\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["When using ",(0,i.jsx)(s.code,{children:"hauler store info"})," with signature verification, you may encounter errors in the presentation of the number layers and size of layers in the store. Hauler is correctly fetching, storing, packaging, and distributing each image, but the presentation and display can error. ",(0,i.jsx)(s.strong,{children:"We are actively working to address and fix this issue."})]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"notices",children:"Notices"}),"\n",(0,i.jsx)(s.h4,{id:"upcoming-deprecated-commands",children:"Upcoming Deprecated Command(s):"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.code,{children:"hauler download"})," (alternatively ",(0,i.jsx)(s.code,{children:"hauler dl"}),") is deprecated and will be removed in a future release."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.code,{children:"hauler serve"})," is deprecated and will be removed in a future release."]}),"\n"]})]})}function u(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>o,x:()=>a});var i=n(6540);const t={},r=i.createContext(t);function o(e){const s=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8f3c2c5e.0d70d008.js b/assets/js/8f3c2c5e.0d70d008.js new file mode 100644 index 000000000..5dcf3d0a2 --- /dev/null +++ b/assets/js/8f3c2c5e.0d70d008.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[844],{4571:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>a});var s=i(4848),t=i(8453);const o={title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},l=void 0,r={id:"known-limits",title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",source:"@site/versioned_docs/version-1.0.x/known-limits.md",sourceDirName:".",slug:"/known-limits",permalink:"/docs/known-limits",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.x/known-limits.md",tags:[],version:"1.0.x",frontMatter:{title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},sidebar:"haulerSidebar",previous:{title:"Hauler Version",permalink:"/docs/guides-references/command-line/hauler-version"},next:{title:"Feedback",permalink:"/docs/feedback"}},c={},a=[{value:"Issues",id:"issues",level:2},{value:"Limitations",id:"limitations",level:2},{value:"Notices",id:"notices",level:2}];function d(e){const n={a:"a",code:"code",h2:"h2",li:"li",ul:"ul",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h2,{id:"issues",children:"Issues"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"No Issues at this time."}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"limitations",children:"Limitations"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["When using a ",(0,s.jsx)(n.code,{children:"store"})," for ",(0,s.jsx)(n.code,{children:"hauler"})," that has the same name of a ",(0,s.jsx)(n.code,{children:"helm"})," chart, ",(0,s.jsx)(n.code,{children:"hauler"})," will fail to fetch the chart.","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["For example, if you tried to use a ",(0,s.jsx)(n.code,{children:"store"})," name of ",(0,s.jsx)(n.code,{children:"rancher"})," with a ",(0,s.jsx)(n.code,{children:"helm"})," chart name ",(0,s.jsx)(n.code,{children:"rancher"}),", the fetch will fail due to the fact that ",(0,s.jsx)(n.code,{children:"helm"})," defaults to using an exisiting local directory, if it matches the name of the chart."]}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://github.com/helm/helm/blob/e81f6140ddb22bc99a08f7409522a8dbe5338ee3/pkg/action/install.go#L714-L815",children:"https://github.com/helm/helm/blob/e81f6140ddb22bc99a08f7409522a8dbe5338ee3/pkg/action/install.go#L714-L815"})}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["When using ",(0,s.jsx)(n.code,{children:"hauler"}),", it will default to write temporary files to ",(0,s.jsx)(n.code,{children:"/tmp"}),". If you do not have about 3x the amount of space available in your ",(0,s.jsx)(n.code,{children:"/tmp"})," compared to the size of the ",(0,s.jsx)(n.code,{children:"store"})," or the ",(0,s.jsx)(n.code,{children:"haul"}),", then ",(0,s.jsx)(n.code,{children:"hauler"})," may fail."]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"notices",children:"Notices"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"No Notices at this time."}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>l,x:()=>r});var s=i(6540);const t={},o=s.createContext(t);function l(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8f3c2c5e.3d77c10b.js b/assets/js/8f3c2c5e.3d77c10b.js deleted file mode 100644 index 6f94cddd5..000000000 --- a/assets/js/8f3c2c5e.3d77c10b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[844],{4571:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>a});var i=s(4848),t=s(8453);const o={title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},l=void 0,r={id:"known-limits",title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",source:"@site/versioned_docs/version-1.0.x/known-limits.md",sourceDirName:".",slug:"/known-limits",permalink:"/hauler-docs/docs/known-limits",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.x/known-limits.md",tags:[],version:"1.0.x",frontMatter:{title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},sidebar:"haulerSidebar",previous:{title:"Hauler Version",permalink:"/hauler-docs/docs/guides-references/command-line/hauler-version"},next:{title:"Feedback",permalink:"/hauler-docs/docs/feedback"}},c={},a=[{value:"Issues",id:"issues",level:2},{value:"Limitations",id:"limitations",level:2},{value:"Notices",id:"notices",level:2}];function d(e){const n={a:"a",code:"code",h2:"h2",li:"li",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"issues",children:"Issues"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"No Issues at this time."}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"limitations",children:"Limitations"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["When using a ",(0,i.jsx)(n.code,{children:"store"})," for ",(0,i.jsx)(n.code,{children:"hauler"})," that has the same name of a ",(0,i.jsx)(n.code,{children:"helm"})," chart, ",(0,i.jsx)(n.code,{children:"hauler"})," will fail to fetch the chart.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["For example, if you tried to use a ",(0,i.jsx)(n.code,{children:"store"})," name of ",(0,i.jsx)(n.code,{children:"rancher"})," with a ",(0,i.jsx)(n.code,{children:"helm"})," chart name ",(0,i.jsx)(n.code,{children:"rancher"}),", the fetch will fail due to the fact that ",(0,i.jsx)(n.code,{children:"helm"})," defaults to using an exisiting local directory, if it matches the name of the chart."]}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://github.com/helm/helm/blob/e81f6140ddb22bc99a08f7409522a8dbe5338ee3/pkg/action/install.go#L714-L815",children:"https://github.com/helm/helm/blob/e81f6140ddb22bc99a08f7409522a8dbe5338ee3/pkg/action/install.go#L714-L815"})}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["When using ",(0,i.jsx)(n.code,{children:"hauler"}),", it will default to write temporary files to ",(0,i.jsx)(n.code,{children:"/tmp"}),". If you do not have about 3x the amount of space available in your ",(0,i.jsx)(n.code,{children:"/tmp"})," compared to the size of the ",(0,i.jsx)(n.code,{children:"store"})," or the ",(0,i.jsx)(n.code,{children:"haul"}),", then ",(0,i.jsx)(n.code,{children:"hauler"})," may fail."]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"notices",children:"Notices"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"No Notices at this time."}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>l,x:()=>r});var i=s(6540);const t={},o=i.createContext(t);function l(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8fc29581.1ee1579d.js b/assets/js/8fc29581.1ee1579d.js deleted file mode 100644 index 97b186d89..000000000 --- a/assets/js/8fc29581.1ee1579d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1721],{1098:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>a});var t=s(4848),i=s(8453);const o={title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},l=void 0,r={id:"known-limits",title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",source:"@site/docs/known-limits.md",sourceDirName:".",slug:"/known-limits",permalink:"/hauler-docs/docs/next/known-limits",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/docs/known-limits.md",tags:[],version:"current",frontMatter:{title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},sidebar:"haulerSidebar",previous:{title:"Hauler Version",permalink:"/hauler-docs/docs/next/guides-references/command-line/hauler-version"},next:{title:"Feedback",permalink:"/hauler-docs/docs/next/feedback"}},c={},a=[{value:"Issues",id:"issues",level:2},{value:"Limitations",id:"limitations",level:2},{value:"Notices",id:"notices",level:2}];function d(e){const n={a:"a",code:"code",h2:"h2",li:"li",ul:"ul",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"issues",children:"Issues"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"No Issues at this time."}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"limitations",children:"Limitations"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["When using a ",(0,t.jsx)(n.code,{children:"store"})," for ",(0,t.jsx)(n.code,{children:"hauler"})," that has the same name of a ",(0,t.jsx)(n.code,{children:"helm"})," chart, ",(0,t.jsx)(n.code,{children:"hauler"})," will fail to fetch the chart.","\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["For example, if you tried to use a ",(0,t.jsx)(n.code,{children:"store"})," name of ",(0,t.jsx)(n.code,{children:"rancher"})," with a ",(0,t.jsx)(n.code,{children:"helm"})," chart name ",(0,t.jsx)(n.code,{children:"rancher"}),", the fetch will fail due to the fact that ",(0,t.jsx)(n.code,{children:"helm"})," defaults to using an exisiting local directory, if it matches the name of the chart."]}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://github.com/helm/helm/blob/e81f6140ddb22bc99a08f7409522a8dbe5338ee3/pkg/action/install.go#L714-L815",children:"https://github.com/helm/helm/blob/e81f6140ddb22bc99a08f7409522a8dbe5338ee3/pkg/action/install.go#L714-L815"})}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["When using ",(0,t.jsx)(n.code,{children:"hauler"}),", it will default to write temporary files to ",(0,t.jsx)(n.code,{children:"/tmp"}),". If you do not have about 3x the amount of space available in your ",(0,t.jsx)(n.code,{children:"/tmp"})," compared to the size of the ",(0,t.jsx)(n.code,{children:"store"})," or the ",(0,t.jsx)(n.code,{children:"haul"}),", then ",(0,t.jsx)(n.code,{children:"hauler"})," may fail."]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"notices",children:"Notices"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"No Notices at this time."}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>l,x:()=>r});var t=s(6540);const i={},o=t.createContext(i);function l(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8fc29581.f5a0bd3c.js b/assets/js/8fc29581.f5a0bd3c.js new file mode 100644 index 000000000..ddc6f72b9 --- /dev/null +++ b/assets/js/8fc29581.f5a0bd3c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1721],{1098:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>a});var i=t(4848),s=t(8453);const o={title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},l=void 0,r={id:"known-limits",title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",source:"@site/docs/known-limits.md",sourceDirName:".",slug:"/known-limits",permalink:"/docs/next/known-limits",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/docs/known-limits.md",tags:[],version:"current",frontMatter:{title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},sidebar:"haulerSidebar",previous:{title:"Hauler Version",permalink:"/docs/next/guides-references/command-line/hauler-version"},next:{title:"Feedback",permalink:"/docs/next/feedback"}},c={},a=[{value:"Issues",id:"issues",level:2},{value:"Limitations",id:"limitations",level:2},{value:"Notices",id:"notices",level:2}];function d(e){const n={a:"a",code:"code",h2:"h2",li:"li",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"issues",children:"Issues"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"No Issues at this time."}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"limitations",children:"Limitations"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["When using a ",(0,i.jsx)(n.code,{children:"store"})," for ",(0,i.jsx)(n.code,{children:"hauler"})," that has the same name of a ",(0,i.jsx)(n.code,{children:"helm"})," chart, ",(0,i.jsx)(n.code,{children:"hauler"})," will fail to fetch the chart.","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["For example, if you tried to use a ",(0,i.jsx)(n.code,{children:"store"})," name of ",(0,i.jsx)(n.code,{children:"rancher"})," with a ",(0,i.jsx)(n.code,{children:"helm"})," chart name ",(0,i.jsx)(n.code,{children:"rancher"}),", the fetch will fail due to the fact that ",(0,i.jsx)(n.code,{children:"helm"})," defaults to using an exisiting local directory, if it matches the name of the chart."]}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://github.com/helm/helm/blob/e81f6140ddb22bc99a08f7409522a8dbe5338ee3/pkg/action/install.go#L714-L815",children:"https://github.com/helm/helm/blob/e81f6140ddb22bc99a08f7409522a8dbe5338ee3/pkg/action/install.go#L714-L815"})}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["When using ",(0,i.jsx)(n.code,{children:"hauler"}),", it will default to write temporary files to ",(0,i.jsx)(n.code,{children:"/tmp"}),". If you do not have about 3x the amount of space available in your ",(0,i.jsx)(n.code,{children:"/tmp"})," compared to the size of the ",(0,i.jsx)(n.code,{children:"store"})," or the ",(0,i.jsx)(n.code,{children:"haul"}),", then ",(0,i.jsx)(n.code,{children:"hauler"})," may fail."]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"notices",children:"Notices"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"No Notices at this time."}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>l,x:()=>r});var i=t(6540);const s={},o=i.createContext(s);function l(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/90636519.09526a87.js b/assets/js/90636519.09526a87.js new file mode 100644 index 000000000..a241fccb8 --- /dev/null +++ b/assets/js/90636519.09526a87.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1056],{4672:(n,t,e)=>{e.r(t),e.d(t,{assets:()=>a,contentTitle:()=>s,default:()=>d,frontMatter:()=>r,metadata:()=>l,toc:()=>c});var i=e(4848),o=e(8453);const r={title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},s=void 0,l={id:"introduction/uninstall",title:"Uninstall",description:"Uninstall Documentation for Hauler",source:"@site/versioned_docs/version-0.4.1/introduction/uninstall.md",sourceDirName:"introduction",slug:"/introduction/uninstall",permalink:"/docs/0.4.1/introduction/uninstall",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.1/introduction/uninstall.md",tags:[],version:"0.4.1",frontMatter:{title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},sidebar:"haulerSidebar",previous:{title:"Installation",permalink:"/docs/0.4.1/introduction/install"},next:{title:"Overview",permalink:"/docs/0.4.1/guides-references/overview"}},a={},c=[];function u(n){const t={p:"p",...(0,o.R)(),...n.components};return(0,i.jsx)(t.p,{children:"Uninstall Documentation pending a future release!"})}function d(n={}){const{wrapper:t}={...(0,o.R)(),...n.components};return t?(0,i.jsx)(t,{...n,children:(0,i.jsx)(u,{...n})}):u(n)}},8453:(n,t,e)=>{e.d(t,{R:()=>s,x:()=>l});var i=e(6540);const o={},r=i.createContext(o);function s(n){const t=i.useContext(r);return i.useMemo((function(){return"function"==typeof n?n(t):{...t,...n}}),[t,n])}function l(n){let t;return t=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:s(n.components),i.createElement(r.Provider,{value:t},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/90636519.4605aac5.js b/assets/js/90636519.4605aac5.js deleted file mode 100644 index 982eda893..000000000 --- a/assets/js/90636519.4605aac5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1056],{4672:(n,t,e)=>{e.r(t),e.d(t,{assets:()=>a,contentTitle:()=>s,default:()=>d,frontMatter:()=>r,metadata:()=>l,toc:()=>c});var o=e(4848),i=e(8453);const r={title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},s=void 0,l={id:"introduction/uninstall",title:"Uninstall",description:"Uninstall Documentation for Hauler",source:"@site/versioned_docs/version-0.4.1/introduction/uninstall.md",sourceDirName:"introduction",slug:"/introduction/uninstall",permalink:"/hauler-docs/docs/0.4.1/introduction/uninstall",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.1/introduction/uninstall.md",tags:[],version:"0.4.1",frontMatter:{title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},sidebar:"haulerSidebar",previous:{title:"Installation",permalink:"/hauler-docs/docs/0.4.1/introduction/install"},next:{title:"Overview",permalink:"/hauler-docs/docs/0.4.1/guides-references/overview"}},a={},c=[];function u(n){const t={p:"p",...(0,i.R)(),...n.components};return(0,o.jsx)(t.p,{children:"Uninstall Documentation pending a future release!"})}function d(n={}){const{wrapper:t}={...(0,i.R)(),...n.components};return t?(0,o.jsx)(t,{...n,children:(0,o.jsx)(u,{...n})}):u(n)}},8453:(n,t,e)=>{e.d(t,{R:()=>s,x:()=>l});var o=e(6540);const i={},r=o.createContext(i);function s(n){const t=o.useContext(r);return o.useMemo((function(){return"function"==typeof n?n(t):{...t,...n}}),[t,n])}function l(n){let t;return t=n.disableParentContext?"function"==typeof n.components?n.components(i):n.components||i:s(n.components),o.createElement(r.Provider,{value:t},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/915076b3.8a722691.js b/assets/js/915076b3.8a722691.js new file mode 100644 index 000000000..057b0879c --- /dev/null +++ b/assets/js/915076b3.8a722691.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5584],{1633:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>i,contentTitle:()=>l,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>d});var t=n(4848),a=n(8453);const s={title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},l=void 0,o={id:"guides-references/command-line/hauler-store",title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",source:"@site/docs/guides-references/command-line/hauler-store.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-store",permalink:"/docs/next/guides-references/command-line/hauler-store",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/docs/guides-references/command-line/hauler-store.md",tags:[],version:"current",frontMatter:{title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},sidebar:"haulerSidebar",previous:{title:"Hauler",permalink:"/docs/next/guides-references/command-line/hauler"},next:{title:"Hauler Completion",permalink:"/docs/next/guides-references/command-line/hauler-completion"}},i={},d=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler store add:",id:"hauler-store-add",level:4},{value:"hauler store add image:",id:"hauler-store-add-image",level:4},{value:"hauler store add chart:",id:"hauler-store-add-chart",level:4},{value:"hauler store add file:",id:"hauler-store-add-file",level:4},{value:"hauler store copy:",id:"hauler-store-copy",level:4},{value:"hauler store extract:",id:"hauler-store-extract",level:4},{value:"hauler store info:",id:"hauler-store-info",level:4},{value:"hauler store load:",id:"hauler-store-load",level:4},{value:"hauler store save:",id:"hauler-store-save",level:4},{value:"hauler store sync:",id:"hauler-store-sync",level:4},{value:"hauler store serve:",id:"hauler-store-serve",level:4},{value:"hauler store serve registry:",id:"hauler-store-serve-registry",level:4},{value:"hauler store serve fileserver:",id:"hauler-store-serve-fileserver",level:4}];function c(e){const r={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Interact with Hauler's embedded content store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store [flags]\n hauler store [command]\n\nAliases:\n store, s\n\nAvailable Commands:\n add Add content to store\n copy Copy all store contents to another OCI registry\n extract Extract content from the store to disk\n info Print out information about the store\n load Load a content store from a store archive\n save Save a content store to a store archive\n serve Expose the content of a local store through an OCI compliant registry or file server\n sync Sync content to the embedded content store\n\nFlags:\n --cache string (deprecated flag and currently not used)\n -h, --help help for store\n -s, --store string Location to create store at (default "store")\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler store [command] --help" for more information about a command.\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-add",children:[(0,t.jsx)(r.code,{children:"hauler store add"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Add content to store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add [flags]\n hauler store add [command]\n\nAvailable Commands:\n chart Add a local or remote chart to the content store\n file Add a file to the content store\n image Add an image to the content store\n\nFlags:\n -h, --help help for add\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n\nUse "hauler store add [command] --help" for more information about a command.\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-add-image",children:[(0,t.jsx)(r.code,{children:"hauler store add image"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Add an image to the content store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add image [flags]\n\nFlags:\n -h, --help help for image\n -k, --key string (Optional) Path to the key for digital signature verification\n -p, --platform string (Optional) Specific platform to save. i.e. linux/amd64. Defaults to all if flag is omitted.\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-add-chart",children:[(0,t.jsx)(r.code,{children:"hauler store add chart"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Add a local or remote chart to the content store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add chart [flags]\n\nExamples:\n\n# add a local chart\nhauler store add chart path/to/chart/directory\n\n# add a local compressed chart\nhauler store add chart path/to/chart.tar.gz\n\n# add a remote chart\nhauler store add chart longhorn --repo "https://charts.longhorn.io"\n\n# add a specific version of a chart\nhauler store add chart rancher --repo "https://releases.rancher.com/server-charts/latest" --version "2.6.2"\n\n\nFlags:\n --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle\n --cert-file string identify HTTPS client using this SSL certificate file\n -h, --help help for chart\n --insecure-skip-tls-verify skip tls certificate checks for the chart download\n --key-file string identify HTTPS client using this SSL key file\n --password string chart repository password where to locate the requested chart\n --repo string chart repository url where to locate the requested chart\n --username string chart repository username where to locate the requested chart\n --verify verify the package before using it\n --version string specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-add-file",children:[(0,t.jsx)(r.code,{children:"hauler store add file"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Add a file to the content store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add file [flags]\n\nFlags:\n -h, --help help for file\n -n, --name string (Optional) Name to assign to file in store\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-copy",children:[(0,t.jsx)(r.code,{children:"hauler store copy"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Copy all store contents to another OCI registry."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store copy [flags]\n\nFlags:\n -h, --help help for copy\n --insecure Toggle allowing insecure connections when copying to a remote registry\n -p, --password string Password when copying to an authenticated remote registry\n --plain-http Toggle allowing plain http connections when copying to a remote registry\n -u, --username string Username when copying to an authenticated remote registry\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-extract",children:[(0,t.jsx)(r.code,{children:"hauler store extract"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Extract content from the store to disk."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store extract [flags]\n\nAliases:\n extract, x\n\nFlags:\n -h, --help help for extract\n -o, --output string Directory to save contents to (defaults to current directory)\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-info",children:[(0,t.jsx)(r.code,{children:"hauler store info"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Print out information about the store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store info [flags]\n\nAliases:\n info, i, list, ls\n\nFlags:\n -h, --help help for info\n -o, --output string Output format (table, json) (default "table")\n -t, --type string Filter on type (image, chart, file, sigs, atts, sbom) (default "all")\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-load",children:[(0,t.jsx)(r.code,{children:"hauler store load"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Load a content store from a store archive."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store load [flags]\n\nFlags:\n -h, --help help for load\n -t, --tempdir string overrides the default directory for temporary files, as returned by your OS.\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-save",children:[(0,t.jsx)(r.code,{children:"hauler store save"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Save a content store to a store archive."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store save [flags]\n\nFlags:\n -f, --filename string Name of archive (default "haul.tar.zst")\n -h, --help help for save\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-sync",children:[(0,t.jsx)(r.code,{children:"hauler store sync"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Sync content to the embedded content store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store sync [flags]\n\nFlags:\n -f, --files strings Path to content files\n -h, --help help for sync\n -k, --key string (Optional) Path to the key for signature verification\n -p, --platform string (Optional) Specific platform to save. i.e. linux/amd64. Defaults to all if flag is omitted.\n -c, --product-registry string (Optional) Specific Product Registry to use. Defaults to RGS Carbide Registry (rgcrprod.azurecr.us).\n --products strings Used for RGS Carbide customers to supply a product and version and Hauler will retrieve the images. i.e. \'--product rancher=v2.7.6\'\n -r, --registry string (Optional) Default pull registry for image refs that are not specifying a registry name.\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-serve",children:[(0,t.jsx)(r.code,{children:"hauler store serve"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Expose the content of a local store through an OCI compliant registry or file server."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve [flags]\n hauler store serve [command]\n\nAvailable Commands:\n fileserver Serve the file server\n registry Serve the embedded registry\n\nFlags:\n -h, --help help for serve\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n\nUse "hauler store serve [command] --help" for more information about a command.\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-serve-registry",children:[(0,t.jsx)(r.code,{children:"hauler store serve registry"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Serve the embedded registry"}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve registry [flags]\n\nFlags:\n -c, --config string Path to a config file, will override all other configs\n --directory string Directory to use for backend. Defaults to $PWD/registry (default "registry")\n -h, --help help for registry\n -p, --port int Port to listen on. (default 5000)\n --readonly Run the registry as readonly. (default true)\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-serve-fileserver",children:[(0,t.jsx)(r.code,{children:"hauler store serve fileserver"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Serve the fileserver"}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve fileserver [flags]\n\nFlags:\n --directory string Directory to use for backend. Defaults to $PWD/fileserver (default "fileserver")\n -h, --help help for fileserver\n -p, --port int Port to listen on. (default 8080)\n -t, --timeout int Set the http request timeout duration in seconds for both reads and write. (default 60)\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})})]})}function h(e={}){const{wrapper:r}={...(0,a.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>l,x:()=>o});var t=n(6540);const a={},s=t.createContext(a);function l(e){const r=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:l(e.components),t.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/915076b3.976eb014.js b/assets/js/915076b3.976eb014.js deleted file mode 100644 index d72dc7b52..000000000 --- a/assets/js/915076b3.976eb014.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5584],{1633:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>i,contentTitle:()=>l,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>d});var t=n(4848),a=n(8453);const s={title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},l=void 0,o={id:"guides-references/command-line/hauler-store",title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",source:"@site/docs/guides-references/command-line/hauler-store.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-store",permalink:"/hauler-docs/docs/next/guides-references/command-line/hauler-store",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/docs/guides-references/command-line/hauler-store.md",tags:[],version:"current",frontMatter:{title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},sidebar:"haulerSidebar",previous:{title:"Hauler",permalink:"/hauler-docs/docs/next/guides-references/command-line/hauler"},next:{title:"Hauler Completion",permalink:"/hauler-docs/docs/next/guides-references/command-line/hauler-completion"}},i={},d=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler store add:",id:"hauler-store-add",level:4},{value:"hauler store add image:",id:"hauler-store-add-image",level:4},{value:"hauler store add chart:",id:"hauler-store-add-chart",level:4},{value:"hauler store add file:",id:"hauler-store-add-file",level:4},{value:"hauler store copy:",id:"hauler-store-copy",level:4},{value:"hauler store extract:",id:"hauler-store-extract",level:4},{value:"hauler store info:",id:"hauler-store-info",level:4},{value:"hauler store load:",id:"hauler-store-load",level:4},{value:"hauler store save:",id:"hauler-store-save",level:4},{value:"hauler store sync:",id:"hauler-store-sync",level:4},{value:"hauler store serve:",id:"hauler-store-serve",level:4},{value:"hauler store serve registry:",id:"hauler-store-serve-registry",level:4},{value:"hauler store serve fileserver:",id:"hauler-store-serve-fileserver",level:4}];function c(e){const r={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Interact with Hauler's embedded content store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store [flags]\n hauler store [command]\n\nAliases:\n store, s\n\nAvailable Commands:\n add Add content to store\n copy Copy all store contents to another OCI registry\n extract Extract content from the store to disk\n info Print out information about the store\n load Load a content store from a store archive\n save Save a content store to a store archive\n serve Expose the content of a local store through an OCI compliant registry or file server\n sync Sync content to the embedded content store\n\nFlags:\n --cache string (deprecated flag and currently not used)\n -h, --help help for store\n -s, --store string Location to create store at (default "store")\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler store [command] --help" for more information about a command.\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-add",children:[(0,t.jsx)(r.code,{children:"hauler store add"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Add content to store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add [flags]\n hauler store add [command]\n\nAvailable Commands:\n chart Add a local or remote chart to the content store\n file Add a file to the content store\n image Add an image to the content store\n\nFlags:\n -h, --help help for add\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n\nUse "hauler store add [command] --help" for more information about a command.\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-add-image",children:[(0,t.jsx)(r.code,{children:"hauler store add image"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Add an image to the content store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add image [flags]\n\nFlags:\n -h, --help help for image\n -k, --key string (Optional) Path to the key for digital signature verification\n -p, --platform string (Optional) Specific platform to save. i.e. linux/amd64. Defaults to all if flag is omitted.\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-add-chart",children:[(0,t.jsx)(r.code,{children:"hauler store add chart"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Add a local or remote chart to the content store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add chart [flags]\n\nExamples:\n\n# add a local chart\nhauler store add chart path/to/chart/directory\n\n# add a local compressed chart\nhauler store add chart path/to/chart.tar.gz\n\n# add a remote chart\nhauler store add chart longhorn --repo "https://charts.longhorn.io"\n\n# add a specific version of a chart\nhauler store add chart rancher --repo "https://releases.rancher.com/server-charts/latest" --version "2.6.2"\n\n\nFlags:\n --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle\n --cert-file string identify HTTPS client using this SSL certificate file\n -h, --help help for chart\n --insecure-skip-tls-verify skip tls certificate checks for the chart download\n --key-file string identify HTTPS client using this SSL key file\n --password string chart repository password where to locate the requested chart\n --repo string chart repository url where to locate the requested chart\n --username string chart repository username where to locate the requested chart\n --verify verify the package before using it\n --version string specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-add-file",children:[(0,t.jsx)(r.code,{children:"hauler store add file"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Add a file to the content store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add file [flags]\n\nFlags:\n -h, --help help for file\n -n, --name string (Optional) Name to assign to file in store\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-copy",children:[(0,t.jsx)(r.code,{children:"hauler store copy"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Copy all store contents to another OCI registry."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store copy [flags]\n\nFlags:\n -h, --help help for copy\n --insecure Toggle allowing insecure connections when copying to a remote registry\n -p, --password string Password when copying to an authenticated remote registry\n --plain-http Toggle allowing plain http connections when copying to a remote registry\n -u, --username string Username when copying to an authenticated remote registry\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-extract",children:[(0,t.jsx)(r.code,{children:"hauler store extract"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Extract content from the store to disk."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store extract [flags]\n\nAliases:\n extract, x\n\nFlags:\n -h, --help help for extract\n -o, --output string Directory to save contents to (defaults to current directory)\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-info",children:[(0,t.jsx)(r.code,{children:"hauler store info"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Print out information about the store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store info [flags]\n\nAliases:\n info, i, list, ls\n\nFlags:\n -h, --help help for info\n -o, --output string Output format (table, json) (default "table")\n -t, --type string Filter on type (image, chart, file, sigs, atts, sbom) (default "all")\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-load",children:[(0,t.jsx)(r.code,{children:"hauler store load"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Load a content store from a store archive."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store load [flags]\n\nFlags:\n -h, --help help for load\n -t, --tempdir string overrides the default directory for temporary files, as returned by your OS.\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-save",children:[(0,t.jsx)(r.code,{children:"hauler store save"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Save a content store to a store archive."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store save [flags]\n\nFlags:\n -f, --filename string Name of archive (default "haul.tar.zst")\n -h, --help help for save\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-sync",children:[(0,t.jsx)(r.code,{children:"hauler store sync"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Sync content to the embedded content store."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store sync [flags]\n\nFlags:\n -f, --files strings Path to content files\n -h, --help help for sync\n -k, --key string (Optional) Path to the key for signature verification\n -p, --platform string (Optional) Specific platform to save. i.e. linux/amd64. Defaults to all if flag is omitted.\n -c, --product-registry string (Optional) Specific Product Registry to use. Defaults to RGS Carbide Registry (rgcrprod.azurecr.us).\n --products strings Used for RGS Carbide customers to supply a product and version and Hauler will retrieve the images. i.e. \'--product rancher=v2.7.6\'\n -r, --registry string (Optional) Default pull registry for image refs that are not specifying a registry name.\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-serve",children:[(0,t.jsx)(r.code,{children:"hauler store serve"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Expose the content of a local store through an OCI compliant registry or file server."}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve [flags]\n hauler store serve [command]\n\nAvailable Commands:\n fileserver Serve the file server\n registry Serve the embedded registry\n\nFlags:\n -h, --help help for serve\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n\nUse "hauler store serve [command] --help" for more information about a command.\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-serve-registry",children:[(0,t.jsx)(r.code,{children:"hauler store serve registry"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Serve the embedded registry"}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve registry [flags]\n\nFlags:\n -c, --config string Path to a config file, will override all other configs\n --directory string Directory to use for backend. Defaults to $PWD/registry (default "registry")\n -h, --help help for registry\n -p, --port int Port to listen on. (default 5000)\n --readonly Run the registry as readonly. (default true)\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,t.jsxs)(r.h4,{id:"hauler-store-serve-fileserver",children:[(0,t.jsx)(r.code,{children:"hauler store serve fileserver"}),":"]}),"\n",(0,t.jsxs)(r.ul,{children:["\n",(0,t.jsx)(r.li,{children:"Serve the fileserver"}),"\n"]}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve fileserver [flags]\n\nFlags:\n --directory string Directory to use for backend. Defaults to $PWD/fileserver (default "fileserver")\n -h, --help help for fileserver\n -p, --port int Port to listen on. (default 8080)\n -t, --timeout int Set the http request timeout duration in seconds for both reads and write. (default 60)\n\nGlobal Flags:\n --cache string (deprecated flag and currently not used)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})})]})}function h(e={}){const{wrapper:r}={...(0,a.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},8453:(e,r,n)=>{n.d(r,{R:()=>l,x:()=>o});var t=n(6540);const a={},s=t.createContext(a);function l(e){const r=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:l(e.components),t.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/94b10bcf.301675d2.js b/assets/js/94b10bcf.301675d2.js deleted file mode 100644 index c968a385e..000000000 --- a/assets/js/94b10bcf.301675d2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1754],{9263:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>n,metadata:()=>c,toc:()=>d});var s=t(4848),o=t(8453);const n={title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",sidebar_label:"RGS Carbide Customers"},i=void 0,c={id:"guides-references/carbide-customers",title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",source:"@site/docs/guides-references/carbide-customers.md",sourceDirName:"guides-references",slug:"/guides-references/carbide-customers",permalink:"/hauler-docs/docs/next/guides-references/carbide-customers",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/docs/guides-references/carbide-customers.md",tags:[],version:"current",frontMatter:{title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",sidebar_label:"RGS Carbide Customers"},sidebar:"haulerSidebar",previous:{title:"Fetch Cluster Images",permalink:"/hauler-docs/docs/next/guides-references/cluster-images"},next:{title:"Hauler Registry",permalink:"/hauler-docs/docs/next/guides-references/utilities/registry"}},a={},d=[];function l(e){const r={a:"a",code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(r.p,{children:["For all supported customers of Rancher Government Solutions, under the umbrella of Rancher Government Carbide, there is addon functionality within ",(0,s.jsx)(r.code,{children:"Hauler"}),"."]}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"Hauler"})," has the the ability to reference ",(0,s.jsx)(r.code,{children:"Collections"})," from the Carbide Secured Registry (CSR). ",(0,s.jsx)(r.code,{children:"Hauler"})," is built to allow operators to fetch, store, package, and distribute content and collections, but most operators may be unsure of what to fetch, store, package, and distribue and that is where our supported customers are able to leverage these pre-defined manifests for all of the Rancher products. Below are some of the available ",(0,s.jsx)(r.code,{children:"product"})," flags."]}),"\n",(0,s.jsxs)(r.p,{children:["Please see the ",(0,s.jsx)(r.strong,{children:(0,s.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/intro",children:"Carbide Documentation"})})," for easily fetching, packing, and distributing Carbide with the ",(0,s.jsx)(r.code,{children:"hauler store sync --products ="}),". Please know that we are actively working to improve this workflow."]}),"\n",(0,s.jsxs)(r.ul,{children:["\n",(0,s.jsx)(r.li,{children:(0,s.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/registry-docs/copying-images",children:"Connected Environments"})}),"\n",(0,s.jsx)(r.li,{children:(0,s.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/registry-docs/downloading-images",children:"Disconnected Environments"})}),"\n"]})]})}function u(e={}){const{wrapper:r}={...(0,o.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>i,x:()=>c});var s=t(6540);const o={},n=s.createContext(o);function i(e){const r=s.useContext(n);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),s.createElement(n.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/94b10bcf.eb20cba1.js b/assets/js/94b10bcf.eb20cba1.js new file mode 100644 index 000000000..20e195ced --- /dev/null +++ b/assets/js/94b10bcf.eb20cba1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1754],{9263:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var s=t(4848),n=t(8453);const o={title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",sidebar_label:"RGS Carbide Customers"},i=void 0,c={id:"guides-references/carbide-customers",title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",source:"@site/docs/guides-references/carbide-customers.md",sourceDirName:"guides-references",slug:"/guides-references/carbide-customers",permalink:"/docs/next/guides-references/carbide-customers",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/docs/guides-references/carbide-customers.md",tags:[],version:"current",frontMatter:{title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",sidebar_label:"RGS Carbide Customers"},sidebar:"haulerSidebar",previous:{title:"Fetch Cluster Images",permalink:"/docs/next/guides-references/cluster-images"},next:{title:"Hauler Registry",permalink:"/docs/next/guides-references/utilities/registry"}},a={},d=[];function l(e){const r={a:"a",code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,n.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(r.p,{children:["For all supported customers of Rancher Government Solutions, under the umbrella of Rancher Government Carbide, there is addon functionality within ",(0,s.jsx)(r.code,{children:"Hauler"}),"."]}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"Hauler"})," has the the ability to reference ",(0,s.jsx)(r.code,{children:"Collections"})," from the Carbide Secured Registry (CSR). ",(0,s.jsx)(r.code,{children:"Hauler"})," is built to allow operators to fetch, store, package, and distribute content and collections, but most operators may be unsure of what to fetch, store, package, and distribue and that is where our supported customers are able to leverage these pre-defined manifests for all of the Rancher products. Below are some of the available ",(0,s.jsx)(r.code,{children:"product"})," flags."]}),"\n",(0,s.jsxs)(r.p,{children:["Please see the ",(0,s.jsx)(r.strong,{children:(0,s.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/intro",children:"Carbide Documentation"})})," for easily fetching, packing, and distributing Carbide with the ",(0,s.jsx)(r.code,{children:"hauler store sync --products ="}),". Please know that we are actively working to improve this workflow."]}),"\n",(0,s.jsxs)(r.ul,{children:["\n",(0,s.jsx)(r.li,{children:(0,s.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/registry-docs/copying-images",children:"Connected Environments"})}),"\n",(0,s.jsx)(r.li,{children:(0,s.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/registry-docs/downloading-images",children:"Disconnected Environments"})}),"\n"]})]})}function u(e={}){const{wrapper:r}={...(0,n.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>i,x:()=>c});var s=t(6540);const n={},o=s.createContext(n);function i(e){const r=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),s.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/95c65ae4.04827154.js b/assets/js/95c65ae4.04827154.js new file mode 100644 index 000000000..019f6069d --- /dev/null +++ b/assets/js/95c65ae4.04827154.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[759],{1949:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>i,contentTitle:()=>l,default:()=>d,frontMatter:()=>s,metadata:()=>o,toc:()=>h});var r=a(4848),n=a(8453);const s={title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},l=void 0,o={id:"introduction/quickstart",title:"Quickstart",description:"Quickstart Documentation for Hauler",source:"@site/versioned_docs/version-0.4.1/introduction/quickstart.md",sourceDirName:"introduction",slug:"/introduction/quickstart",permalink:"/docs/0.4.1/introduction/quickstart",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.1/introduction/quickstart.md",tags:[],version:"0.4.1",frontMatter:{title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},sidebar:"haulerSidebar",previous:{title:"Airgap Workflow",permalink:"/docs/0.4.1/airgap-workflow"},next:{title:"Installation",permalink:"/docs/0.4.1/introduction/install"}},i={},h=[{value:"Quick Installation",id:"quick-installation",level:2},{value:"Example Use of Hauler",id:"example-use-of-hauler",level:2},{value:"Add Content to the Hauler Store",id:"add-content-to-the-hauler-store",level:3},{value:"Using the Command Line:",id:"using-the-command-line",level:4},{value:"Using a Hauler Manifest:",id:"using-a-hauler-manifest",level:4},{value:"View the Hauler Store",id:"view-the-hauler-store",level:3},{value:"Save the Hauler Store",id:"save-the-hauler-store",level:3},{value:"Load the Airgapped Hauler Store",id:"load-the-airgapped-hauler-store",level:3},{value:"Serve the Hauler Store",id:"serve-the-hauler-store",level:3},{value:"Copy the Hauler Store to a Registry",id:"copy-the-hauler-store-to-a-registry",level:3},{value:"Copy the Hauler Store to a Directory",id:"copy-the-hauler-store-to-a-directory",level:3}];function c(e){const t={code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.p,{children:"Skipping past most of the documentation? Here's an easy to follow Quick Start Guide:"}),"\n",(0,r.jsx)(t.h2,{id:"quick-installation",children:"Quick Installation"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n"})}),"\n",(0,r.jsx)(t.h2,{id:"example-use-of-hauler",children:"Example Use of Hauler"}),"\n",(0,r.jsx)(t.h3,{id:"add-content-to-the-hauler-store",children:"Add Content to the Hauler Store"}),"\n",(0,r.jsx)(t.h4,{id:"using-the-command-line",children:"Using the Command Line:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# add a image: neuvector/scanner:latest\nhauler store add image neuvector/scanner:latest\n\n# add a image with supply chain artifacts\nhauler store add image rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.2 --key carbide-key.pub\n\n# add a chart: rancher-stable/rancher (v2.7.9)\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.7.9\n\n# add a file: rke2-install.sh\nhauler store add file https://get.rke2.io --name install.sh\n"})}),"\n",(0,r.jsx)(t.h4,{id:"using-a-hauler-manifest",children:"Using a Hauler Manifest:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"hauler store sync --files hauler-manfiest.yaml\n"})}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\nspec:\n images:\n - name: neuvector/scanner:latest\n - name: rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.1\n key: carbide-key.pub\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.7.9\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n - path: https://get.rke2.io\n name: install.sh\n"})}),"\n",(0,r.jsx)(t.h3,{id:"view-the-hauler-store",children:"View the Hauler Store"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# view and verify the content in the local hauler store\nhauler store info\n"})}),"\n",(0,r.jsx)(t.h3,{id:"save-the-hauler-store",children:"Save the Hauler Store"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# save and export the content in the local hauler store\nhauler store save --filename haul.tar.zst\n"})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsxs)(t.strong,{children:["airgap the ",(0,r.jsx)(t.code,{children:"haul.tar.zst"})," to the disconnected environment"]})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"load-the-airgapped-hauler-store",children:"Load the Airgapped Hauler Store"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# load and import the airgapped content to the new local hauler store\nhauler store load haul.tar.zst\n"})}),"\n",(0,r.jsx)(t.h3,{id:"serve-the-hauler-store",children:"Serve the Hauler Store"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# serve the content as a registry from the hauler store\nhauler store serve\n"})}),"\n",(0,r.jsx)(t.h3,{id:"copy-the-hauler-store-to-a-registry",children:"Copy the Hauler Store to a Registry"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# copy the content to a registry from the hauler store\nhauler store copy registry://harbor.example.com\n"})}),"\n",(0,r.jsx)(t.h3,{id:"copy-the-hauler-store-to-a-directory",children:"Copy the Hauler Store to a Directory"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# copy the content to a directory from the hauler store\nhauler store copy dir://hauler-files\n"})})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},8453:(e,t,a)=>{a.d(t,{R:()=>l,x:()=>o});var r=a(6540);const n={},s=r.createContext(n);function l(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:l(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/95c65ae4.715e8538.js b/assets/js/95c65ae4.715e8538.js deleted file mode 100644 index c2d1438f0..000000000 --- a/assets/js/95c65ae4.715e8538.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[759],{1949:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>i,contentTitle:()=>l,default:()=>d,frontMatter:()=>s,metadata:()=>o,toc:()=>h});var r=a(4848),n=a(8453);const s={title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},l=void 0,o={id:"introduction/quickstart",title:"Quickstart",description:"Quickstart Documentation for Hauler",source:"@site/versioned_docs/version-0.4.1/introduction/quickstart.md",sourceDirName:"introduction",slug:"/introduction/quickstart",permalink:"/hauler-docs/docs/0.4.1/introduction/quickstart",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.1/introduction/quickstart.md",tags:[],version:"0.4.1",frontMatter:{title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},sidebar:"haulerSidebar",previous:{title:"Airgap Workflow",permalink:"/hauler-docs/docs/0.4.1/airgap-workflow"},next:{title:"Installation",permalink:"/hauler-docs/docs/0.4.1/introduction/install"}},i={},h=[{value:"Quick Installation",id:"quick-installation",level:2},{value:"Example Use of Hauler",id:"example-use-of-hauler",level:2},{value:"Add Content to the Hauler Store",id:"add-content-to-the-hauler-store",level:3},{value:"Using the Command Line:",id:"using-the-command-line",level:4},{value:"Using a Hauler Manifest:",id:"using-a-hauler-manifest",level:4},{value:"View the Hauler Store",id:"view-the-hauler-store",level:3},{value:"Save the Hauler Store",id:"save-the-hauler-store",level:3},{value:"Load the Airgapped Hauler Store",id:"load-the-airgapped-hauler-store",level:3},{value:"Serve the Hauler Store",id:"serve-the-hauler-store",level:3},{value:"Copy the Hauler Store to a Registry",id:"copy-the-hauler-store-to-a-registry",level:3},{value:"Copy the Hauler Store to a Directory",id:"copy-the-hauler-store-to-a-directory",level:3}];function c(e){const t={code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.p,{children:"Skipping past most of the documentation? Here's an easy to follow Quick Start Guide:"}),"\n",(0,r.jsx)(t.h2,{id:"quick-installation",children:"Quick Installation"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n"})}),"\n",(0,r.jsx)(t.h2,{id:"example-use-of-hauler",children:"Example Use of Hauler"}),"\n",(0,r.jsx)(t.h3,{id:"add-content-to-the-hauler-store",children:"Add Content to the Hauler Store"}),"\n",(0,r.jsx)(t.h4,{id:"using-the-command-line",children:"Using the Command Line:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# add a image: neuvector/scanner:latest\nhauler store add image neuvector/scanner:latest\n\n# add a image with supply chain artifacts\nhauler store add image rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.2 --key carbide-key.pub\n\n# add a chart: rancher-stable/rancher (v2.7.9)\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.7.9\n\n# add a file: rke2-install.sh\nhauler store add file https://get.rke2.io --name install.sh\n"})}),"\n",(0,r.jsx)(t.h4,{id:"using-a-hauler-manifest",children:"Using a Hauler Manifest:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"hauler store sync --files hauler-manfiest.yaml\n"})}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\nspec:\n images:\n - name: neuvector/scanner:latest\n - name: rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.1\n key: carbide-key.pub\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.7.9\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n - path: https://get.rke2.io\n name: install.sh\n"})}),"\n",(0,r.jsx)(t.h3,{id:"view-the-hauler-store",children:"View the Hauler Store"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# view and verify the content in the local hauler store\nhauler store info\n"})}),"\n",(0,r.jsx)(t.h3,{id:"save-the-hauler-store",children:"Save the Hauler Store"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# save and export the content in the local hauler store\nhauler store save --filename haul.tar.zst\n"})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsxs)(t.strong,{children:["airgap the ",(0,r.jsx)(t.code,{children:"haul.tar.zst"})," to the disconnected environment"]})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"load-the-airgapped-hauler-store",children:"Load the Airgapped Hauler Store"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# load and import the airgapped content to the new local hauler store\nhauler store load haul.tar.zst\n"})}),"\n",(0,r.jsx)(t.h3,{id:"serve-the-hauler-store",children:"Serve the Hauler Store"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# serve the content as a registry from the hauler store\nhauler store serve\n"})}),"\n",(0,r.jsx)(t.h3,{id:"copy-the-hauler-store-to-a-registry",children:"Copy the Hauler Store to a Registry"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# copy the content to a registry from the hauler store\nhauler store copy registry://harbor.example.com\n"})}),"\n",(0,r.jsx)(t.h3,{id:"copy-the-hauler-store-to-a-directory",children:"Copy the Hauler Store to a Directory"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# copy the content to a directory from the hauler store\nhauler store copy dir://hauler-files\n"})})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},8453:(e,t,a)=>{a.d(t,{R:()=>l,x:()=>o});var r=a(6540);const n={},s=r.createContext(n);function l(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:l(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/96c5fba0.5745f86f.js b/assets/js/96c5fba0.5745f86f.js new file mode 100644 index 000000000..8869ed190 --- /dev/null +++ b/assets/js/96c5fba0.5745f86f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7461],{1032:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>l,toc:()=>a});var r=n(4848),s=n(8453);const o={title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',sidebar_label:"Files"},i=void 0,l={id:"guides-references/hauler-content/files",title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',source:"@site/versioned_docs/version-0.4.2/guides-references/hauler-content/files.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/files",permalink:"/docs/0.4.2/guides-references/hauler-content/files",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.2/guides-references/hauler-content/files.md",tags:[],version:"0.4.2",frontMatter:{title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',sidebar_label:"Files"},sidebar:"haulerSidebar",previous:{title:"Charts",permalink:"/docs/0.4.2/guides-references/hauler-content/charts"},next:{title:"Hauler",permalink:"/docs/0.4.2/guides-references/command-line/hauler"}},c={},a=[];function u(e){const t={code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.p,{children:"Generic content that can be represented as a file, either sourced locally or remotely:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-yaml",children:"# local file\nhauler store add file path/to/local/file.txt\n\n# remote file with name\nhauler store add file https://get.rke2.io --name install.sh\n"})})]})}function d(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>l});var r=n(6540);const s={},o=r.createContext(s);function i(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/96c5fba0.89a42ae2.js b/assets/js/96c5fba0.89a42ae2.js deleted file mode 100644 index 54eb7c06a..000000000 --- a/assets/js/96c5fba0.89a42ae2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7461],{1032:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>l,toc:()=>a});var r=n(4848),s=n(8453);const o={title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',sidebar_label:"Files"},i=void 0,l={id:"guides-references/hauler-content/files",title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',source:"@site/versioned_docs/version-0.4.2/guides-references/hauler-content/files.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/files",permalink:"/hauler-docs/docs/0.4.2/guides-references/hauler-content/files",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.2/guides-references/hauler-content/files.md",tags:[],version:"0.4.2",frontMatter:{title:"Files (Content Type)",description:'Hauler "Files" Content Documentation',sidebar_label:"Files"},sidebar:"haulerSidebar",previous:{title:"Charts",permalink:"/hauler-docs/docs/0.4.2/guides-references/hauler-content/charts"},next:{title:"Hauler",permalink:"/hauler-docs/docs/0.4.2/guides-references/command-line/hauler"}},c={},a=[];function u(e){const t={code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.p,{children:"Generic content that can be represented as a file, either sourced locally or remotely:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-yaml",children:"# local file\nhauler store add file path/to/local/file.txt\n\n# remote file with name\nhauler store add file https://get.rke2.io --name install.sh\n"})})]})}function d(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>l});var r=n(6540);const s={},o=r.createContext(s);function i(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/989e584c.57080d78.js b/assets/js/989e584c.57080d78.js new file mode 100644 index 000000000..852093971 --- /dev/null +++ b/assets/js/989e584c.57080d78.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7446],{6218:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>o,contentTitle:()=>i,default:()=>m,frontMatter:()=>s,metadata:()=>l,toc:()=>c});var t=a(4848),r=a(8453);const s={title:"Hauler Manifests",description:"Hauler Manifests Documentation",sidebar_label:"Hauler Manifests"},i=void 0,l={id:"guides-references/manifests",title:"Hauler Manifests",description:"Hauler Manifests Documentation",source:"@site/versioned_docs/version-1.0.x/guides-references/manifests.md",sourceDirName:"guides-references",slug:"/guides-references/manifests",permalink:"/docs/guides-references/manifests",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/manifests.md",tags:[],version:"1.0.x",frontMatter:{title:"Hauler Manifests",description:"Hauler Manifests Documentation",sidebar_label:"Hauler Manifests"},sidebar:"haulerSidebar",previous:{title:"Hauler Fileserver",permalink:"/docs/guides-references/utilities/fileserver"},next:{title:"Community Collections",permalink:"/docs/guides-references/hauler-collections/community-collections"}},o={},c=[{value:"Example Manifest for Images",id:"example-manifest-for-images",level:2},{value:"Example Manifest for Charts",id:"example-manifest-for-charts",level:2},{value:"Example Manifest for Files",id:"example-manifest-for-files",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"example-manifest-for-images",children:"Example Manifest for Images"}),"\n",(0,t.jsxs)(n.p,{children:["Please review the Hauler Content Pages for ",(0,t.jsx)(n.a,{href:"/docs/guides-references/hauler-content/images",children:"Images"})," for more detailed information."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-image-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\n annotations:\n # global flags for all images in the manifest\n # image flags override global flags\n hauler.dev/key: \n hauler.dev/platform: \n hauler.dev/registry: \nspec:\n images:\n # fetch image\n - name: neuvector/scanner\n # fetch image with full image reference\n - name: docker.io/neuvector/updater:latest\n # fetch image with full image reference with digest\n - name: docker.io/neuvector/updater@sha256:0076b356368c9988eec5f3cead771d29a377074b982f22800f4d9c8c3b215a56\n # fetch image with full image reference, specific version, specific platform\n - name: docker.io/longhornio/longhorn-ui:v1.6.0\n platform: linux/amd64\n # fetch image with full image reference, specific version, specific platform, and signature verification\n - name: docker.io/longhornio/longhorn-manager:v1.6.0\n key: cosign-public-key.pub\n platform: linux/amd64\n"})}),"\n",(0,t.jsx)(n.h2,{id:"example-manifest-for-charts",children:"Example Manifest for Charts"}),"\n",(0,t.jsxs)(n.p,{children:["Please review the Hauler Content Pages for ",(0,t.jsx)(n.a,{href:"/docs/guides-references/hauler-content/charts",children:"Charts"})," for more detailed information."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-chart-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n # fetch helm chart\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n # fetch helm chart with specific version\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.8.2\n"})}),"\n",(0,t.jsx)(n.h2,{id:"example-manifest-for-files",children:"Example Manifest for Files"}),"\n",(0,t.jsxs)(n.p,{children:["Please review the Hauler Content Pages for ",(0,t.jsx)(n.a,{href:"/docs/guides-references/hauler-content/files",children:"Files"})," for more detailed information."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-file-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n # fetch remote file\n - path: https://get.rke2.io\n # fetch remote file and assign new name\n - path: https://get.rke2.io\n name: install.sh\n # fetch local file\n - path: path/to/local/file.txt\n # fetch local file and assign new name\n - path: path/to/local/file.txt\n name: local-file.txt\n"})})]})}function m(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}},8453:(e,n,a)=>{a.d(n,{R:()=>i,x:()=>l});var t=a(6540);const r={},s=t.createContext(r);function i(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/989e584c.de1fb608.js b/assets/js/989e584c.de1fb608.js deleted file mode 100644 index c421b4f92..000000000 --- a/assets/js/989e584c.de1fb608.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7446],{6218:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>o,contentTitle:()=>i,default:()=>m,frontMatter:()=>s,metadata:()=>l,toc:()=>c});var t=a(4848),r=a(8453);const s={title:"Hauler Manifests",description:"Hauler Manifests Documentation",sidebar_label:"Hauler Manifests"},i=void 0,l={id:"guides-references/manifests",title:"Hauler Manifests",description:"Hauler Manifests Documentation",source:"@site/versioned_docs/version-1.0.x/guides-references/manifests.md",sourceDirName:"guides-references",slug:"/guides-references/manifests",permalink:"/hauler-docs/docs/guides-references/manifests",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/manifests.md",tags:[],version:"1.0.x",frontMatter:{title:"Hauler Manifests",description:"Hauler Manifests Documentation",sidebar_label:"Hauler Manifests"},sidebar:"haulerSidebar",previous:{title:"Hauler Fileserver",permalink:"/hauler-docs/docs/guides-references/utilities/fileserver"},next:{title:"Community Collections",permalink:"/hauler-docs/docs/guides-references/hauler-collections/community-collections"}},o={},c=[{value:"Example Manifest for Images",id:"example-manifest-for-images",level:2},{value:"Example Manifest for Charts",id:"example-manifest-for-charts",level:2},{value:"Example Manifest for Files",id:"example-manifest-for-files",level:2}];function f(e){const n={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"example-manifest-for-images",children:"Example Manifest for Images"}),"\n",(0,t.jsxs)(n.p,{children:["Please review the Hauler Content Pages for ",(0,t.jsx)(n.a,{href:"/hauler-docs/docs/guides-references/hauler-content/images",children:"Images"})," for more detailed information."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-image-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\n annotations:\n # global flags for all images in the manifest\n # image flags override global flags\n hauler.dev/key: \n hauler.dev/platform: \n hauler.dev/registry: \nspec:\n images:\n # fetch image\n - name: neuvector/scanner\n # fetch image with full image reference\n - name: docker.io/neuvector/updater:latest\n # fetch image with full image reference with digest\n - name: docker.io/neuvector/updater@sha256:0076b356368c9988eec5f3cead771d29a377074b982f22800f4d9c8c3b215a56\n # fetch image with full image reference, specific version, specific platform\n - name: docker.io/longhornio/longhorn-ui:v1.6.0\n platform: linux/amd64\n # fetch image with full image reference, specific version, specific platform, and signature verification\n - name: docker.io/longhornio/longhorn-manager:v1.6.0\n key: cosign-public-key.pub\n platform: linux/amd64\n"})}),"\n",(0,t.jsx)(n.h2,{id:"example-manifest-for-charts",children:"Example Manifest for Charts"}),"\n",(0,t.jsxs)(n.p,{children:["Please review the Hauler Content Pages for ",(0,t.jsx)(n.a,{href:"/hauler-docs/docs/guides-references/hauler-content/charts",children:"Charts"})," for more detailed information."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-chart-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n # fetch helm chart\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n # fetch helm chart with specific version\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.8.2\n"})}),"\n",(0,t.jsx)(n.h2,{id:"example-manifest-for-files",children:"Example Manifest for Files"}),"\n",(0,t.jsxs)(n.p,{children:["Please review the Hauler Content Pages for ",(0,t.jsx)(n.a,{href:"/hauler-docs/docs/guides-references/hauler-content/files",children:"Files"})," for more detailed information."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-file-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n # fetch remote file\n - path: https://get.rke2.io\n # fetch remote file and assign new name\n - path: https://get.rke2.io\n name: install.sh\n # fetch local file\n - path: path/to/local/file.txt\n # fetch local file and assign new name\n - path: path/to/local/file.txt\n name: local-file.txt\n"})})]})}function m(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(f,{...e})}):f(e)}},8453:(e,n,a)=>{a.d(n,{R:()=>i,x:()=>l});var t=a(6540);const r={},s=t.createContext(r);function i(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/989f82e2.5135a5af.js b/assets/js/989f82e2.5135a5af.js new file mode 100644 index 000000000..921826787 --- /dev/null +++ b/assets/js/989f82e2.5135a5af.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4198],{3727:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>o,contentTitle:()=>s,default:()=>f,frontMatter:()=>i,metadata:()=>r,toc:()=>c});var t=l(4848),a=l(8453);const i={title:"Hauler Content - Files",description:"Hauler Content - Files Documentation",sidebar_label:"Files"},s=void 0,r={id:"guides-references/hauler-content/files",title:"Hauler Content - Files",description:"Hauler Content - Files Documentation",source:"@site/versioned_docs/version-1.0.x/guides-references/hauler-content/files.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/files",permalink:"/docs/guides-references/hauler-content/files",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/hauler-content/files.md",tags:[],version:"1.0.x",frontMatter:{title:"Hauler Content - Files",description:"Hauler Content - Files Documentation",sidebar_label:"Files"},sidebar:"haulerSidebar",previous:{title:"Charts",permalink:"/docs/guides-references/hauler-content/charts"},next:{title:"Hauler",permalink:"/docs/guides-references/command-line/hauler"}},o={},c=[{value:"Hauler Command Line for Files",id:"hauler-command-line-for-files",level:2},{value:"Example Commands for Files",id:"example-commands-for-files",level:2},{value:"Hauler Manifest for Files",id:"hauler-manifest-for-files",level:2},{value:"Example Manifest for Files",id:"example-manifest-for-files",level:2}];function d(e){const n={code:"code",h2:"h2",pre:"pre",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"hauler-command-line-for-files",children:"Hauler Command Line for Files"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"hauler store add file --name \n"})}),"\n",(0,t.jsx)(n.h2,{id:"example-commands-for-files",children:"Example Commands for Files"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"# fetch remote file\nhauler store add file https://get.rke2.io\n\n# fetch local file and assign new name\nhauler store add file path/to/local/file.txt --name local-file.txt\n"})}),"\n",(0,t.jsx)(n.h2,{id:"hauler-manifest-for-files",children:"Hauler Manifest for Files"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-file-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n - path: \n name: \n"})}),"\n",(0,t.jsx)(n.h2,{id:"example-manifest-for-files",children:"Example Manifest for Files"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-file-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n # fetch remote file\n - path: https://get.rke2.io\n # fetch remote file and assign new name\n - path: https://get.rke2.io\n name: install.sh\n # fetch local file\n - path: path/to/local/file.txt\n # fetch local file and assign new name\n - path: path/to/local/file.txt\n name: local-file.txt\n"})})]})}function f(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,n,l)=>{l.d(n,{R:()=>s,x:()=>r});var t=l(6540);const a={},i=t.createContext(a);function s(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/989f82e2.6046680d.js b/assets/js/989f82e2.6046680d.js deleted file mode 100644 index 0715e1daa..000000000 --- a/assets/js/989f82e2.6046680d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4198],{3727:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>o,contentTitle:()=>s,default:()=>f,frontMatter:()=>i,metadata:()=>r,toc:()=>c});var t=l(4848),a=l(8453);const i={title:"Hauler Content - Files",description:"Hauler Content - Files Documentation",sidebar_label:"Files"},s=void 0,r={id:"guides-references/hauler-content/files",title:"Hauler Content - Files",description:"Hauler Content - Files Documentation",source:"@site/versioned_docs/version-1.0.x/guides-references/hauler-content/files.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/files",permalink:"/hauler-docs/docs/guides-references/hauler-content/files",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/hauler-content/files.md",tags:[],version:"1.0.x",frontMatter:{title:"Hauler Content - Files",description:"Hauler Content - Files Documentation",sidebar_label:"Files"},sidebar:"haulerSidebar",previous:{title:"Charts",permalink:"/hauler-docs/docs/guides-references/hauler-content/charts"},next:{title:"Hauler",permalink:"/hauler-docs/docs/guides-references/command-line/hauler"}},o={},c=[{value:"Hauler Command Line for Files",id:"hauler-command-line-for-files",level:2},{value:"Example Commands for Files",id:"example-commands-for-files",level:2},{value:"Hauler Manifest for Files",id:"hauler-manifest-for-files",level:2},{value:"Example Manifest for Files",id:"example-manifest-for-files",level:2}];function d(e){const n={code:"code",h2:"h2",pre:"pre",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"hauler-command-line-for-files",children:"Hauler Command Line for Files"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"hauler store add file --name \n"})}),"\n",(0,t.jsx)(n.h2,{id:"example-commands-for-files",children:"Example Commands for Files"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"# fetch remote file\nhauler store add file https://get.rke2.io\n\n# fetch local file and assign new name\nhauler store add file path/to/local/file.txt --name local-file.txt\n"})}),"\n",(0,t.jsx)(n.h2,{id:"hauler-manifest-for-files",children:"Hauler Manifest for Files"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-file-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n - path: \n name: \n"})}),"\n",(0,t.jsx)(n.h2,{id:"example-manifest-for-files",children:"Example Manifest for Files"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-file-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n # fetch remote file\n - path: https://get.rke2.io\n # fetch remote file and assign new name\n - path: https://get.rke2.io\n name: install.sh\n # fetch local file\n - path: path/to/local/file.txt\n # fetch local file and assign new name\n - path: path/to/local/file.txt\n name: local-file.txt\n"})})]})}function f(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8453:(e,n,l)=>{l.d(n,{R:()=>s,x:()=>r});var t=l(6540);const a={},i=t.createContext(a);function s(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/99d8f5e1.b5d2a680.js b/assets/js/99d8f5e1.b5d2a680.js new file mode 100644 index 000000000..3ea71e9f1 --- /dev/null +++ b/assets/js/99d8f5e1.b5d2a680.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1520],{8489:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>i,contentTitle:()=>l,default:()=>u,frontMatter:()=>a,metadata:()=>s,toc:()=>c});var o=r(4848),t=r(8453);const a={title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},l=void 0,s={id:"guides-references/command-line/hauler",title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",source:"@site/versioned_docs/version-0.4.0/guides-references/command-line/hauler.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler",permalink:"/docs/0.4.0/guides-references/command-line/hauler",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.0/guides-references/command-line/hauler.md",tags:[],version:"0.4.0",frontMatter:{title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},sidebar:"haulerSidebar",previous:{title:"Files",permalink:"/docs/0.4.0/guides-references/hauler-content/files"},next:{title:"Hauler Store",permalink:"/docs/0.4.0/guides-references/command-line/hauler-store"}},i={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Interact with Hauler's command line."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler [flags]\n hauler [command]\n\nAvailable Commands:\n completion Generate the autocompletion script for the specified shell\n download Download OCI content from a registry and populate it on disk\n help Help about any command\n serve Run one or more of hauler\'s embedded servers types\n store Interact with hauler\'s embedded content store\n version Print the current version\n\nFlags:\n -h, --help help for hauler\n -l, --log-level string (default "info")\n\nUse "hauler [command] --help" for more information about a command.\n'})})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>s});var o=r(6540);const t={},a=o.createContext(t);function l(e){const n=o.useContext(a);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),o.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/99d8f5e1.cbfc160d.js b/assets/js/99d8f5e1.cbfc160d.js deleted file mode 100644 index 8b1803451..000000000 --- a/assets/js/99d8f5e1.cbfc160d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1520],{8489:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>i,contentTitle:()=>l,default:()=>u,frontMatter:()=>t,metadata:()=>s,toc:()=>c});var o=r(4848),a=r(8453);const t={title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},l=void 0,s={id:"guides-references/command-line/hauler",title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",source:"@site/versioned_docs/version-0.4.0/guides-references/command-line/hauler.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler",permalink:"/hauler-docs/docs/0.4.0/guides-references/command-line/hauler",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.0/guides-references/command-line/hauler.md",tags:[],version:"0.4.0",frontMatter:{title:"Hauler (Command)",description:"Hauler CLI Reference for hauler",sidebar_label:"Hauler"},sidebar:"haulerSidebar",previous:{title:"Files",permalink:"/hauler-docs/docs/0.4.0/guides-references/hauler-content/files"},next:{title:"Hauler Store",permalink:"/hauler-docs/docs/0.4.0/guides-references/command-line/hauler-store"}},i={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Interact with Hauler's command line."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler [flags]\n hauler [command]\n\nAvailable Commands:\n completion Generate the autocompletion script for the specified shell\n download Download OCI content from a registry and populate it on disk\n help Help about any command\n serve Run one or more of hauler\'s embedded servers types\n store Interact with hauler\'s embedded content store\n version Print the current version\n\nFlags:\n -h, --help help for hauler\n -l, --log-level string (default "info")\n\nUse "hauler [command] --help" for more information about a command.\n'})})]})}function u(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>s});var o=r(6540);const a={},t=o.createContext(a);function l(e){const n=o.useContext(t);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:l(e.components),o.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9ae84177.3d64abfd.js b/assets/js/9ae84177.3d64abfd.js deleted file mode 100644 index 4ebee2181..000000000 --- a/assets/js/9ae84177.3d64abfd.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[6821],{1502:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>t,contentTitle:()=>s,default:()=>u,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var o=r(4848),l=r(8453);const i={title:"Hauler Login (Command)",description:"Hauler CLI Reference for hauler login",sidebar_label:"Hauler Login"},s=void 0,a={id:"guides-references/command-line/hauler-login",title:"Hauler Login (Command)",description:"Hauler CLI Reference for hauler login",source:"@site/versioned_docs/version-1.0.x/guides-references/command-line/hauler-login.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-login",permalink:"/hauler-docs/docs/guides-references/command-line/hauler-login",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/command-line/hauler-login.md",tags:[],version:"1.0.x",frontMatter:{title:"Hauler Login (Command)",description:"Hauler CLI Reference for hauler login",sidebar_label:"Hauler Login"}},t={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,l.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Log in to a registry"}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler login [flags]\n\nExamples:\n\n# login to registry.example.com\nhauler login registry.example.com -u bob -p haulin\n\nFlags:\n -h, --help help for login\n -p, --password string Password\n --password-stdin Take the password from stdin\n -u, --username string Username\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})})]})}function u(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>a});var o=r(6540);const l={},i=o.createContext(l);function s(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9ae84177.cc424bc1.js b/assets/js/9ae84177.cc424bc1.js new file mode 100644 index 000000000..97ca62679 --- /dev/null +++ b/assets/js/9ae84177.cc424bc1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[6821],{1502:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>t,contentTitle:()=>s,default:()=>u,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var o=r(4848),l=r(8453);const i={title:"Hauler Login (Command)",description:"Hauler CLI Reference for hauler login",sidebar_label:"Hauler Login"},s=void 0,a={id:"guides-references/command-line/hauler-login",title:"Hauler Login (Command)",description:"Hauler CLI Reference for hauler login",source:"@site/versioned_docs/version-1.0.x/guides-references/command-line/hauler-login.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-login",permalink:"/docs/guides-references/command-line/hauler-login",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/command-line/hauler-login.md",tags:[],version:"1.0.x",frontMatter:{title:"Hauler Login (Command)",description:"Hauler CLI Reference for hauler login",sidebar_label:"Hauler Login"}},t={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,l.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Log in to a registry"}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler login [flags]\n\nExamples:\n\n# login to registry.example.com\nhauler login registry.example.com -u bob -p haulin\n\nFlags:\n -h, --help help for login\n -p, --password string Password\n --password-stdin Take the password from stdin\n -u, --username string Username\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})})]})}function u(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>a});var o=r(6540);const l={},i=o.createContext(l);function s(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9b4a10b8.c355d340.js b/assets/js/9b4a10b8.c355d340.js deleted file mode 100644 index b64c93ebe..000000000 --- a/assets/js/9b4a10b8.c355d340.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4662],{2160:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>s,metadata:()=>i,toc:()=>d});var l=n(4848),r=n(8453);const s={title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},a=void 0,i={id:"introduction/install",title:"Installation",description:"Installation Documentation for Hauler",source:"@site/docs/introduction/install.md",sourceDirName:"introduction",slug:"/introduction/install",permalink:"/hauler-docs/docs/next/introduction/install",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/docs/introduction/install.md",tags:[],version:"current",frontMatter:{title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},sidebar:"haulerSidebar",previous:{title:"Quickstart",permalink:"/hauler-docs/docs/next/introduction/quickstart"},next:{title:"Uninstall",permalink:"/hauler-docs/docs/next/introduction/uninstall"}},c={},d=[{value:"Overview",id:"overview",level:2},{value:"Supported Architectures",id:"supported-architectures",level:2},{value:"Installation Steps",id:"installation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin",level:3},{value:"Homebrew",id:"homebrew",level:3},{value:"Windows",id:"windows",level:3},{value:"Manual Installation Steps",id:"manual-installation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin-1",level:3},{value:"Homebrew",id:"homebrew-1",level:3},{value:"Windows",id:"windows-1",level:3}];function o(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(t.h2,{id:"overview",children:"Overview"}),"\n",(0,l.jsxs)(t.p,{children:["Hauler is a purpose built to be a single binary with no specific prerequistes, depedencies, or runtime environment. It's installation is very simple and easy to follow. To view the latest release, please view our ",(0,l.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"GitHub Release"})," page."]}),"\n",(0,l.jsx)(t.h2,{id:"supported-architectures",children:"Supported Architectures"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"center"},children:"Base Platform"}),(0,l.jsx)(t.th,{style:{textAlign:"center"},children:"Architecture"}),(0,l.jsx)(t.th,{style:{textAlign:"center"},children:"Latest Release"})]})}),(0,l.jsxs)(t.tbody,{children:[(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"center"},children:"Linux"}),(0,l.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,l.jsx)(t.code,{children:"amd64"})," and ",(0,l.jsx)(t.code,{children:"arm64"})]}),(0,l.jsx)(t.td,{style:{textAlign:"center"},children:(0,l.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"center"},children:"Darwin"}),(0,l.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,l.jsx)(t.code,{children:"amd64"})," and ",(0,l.jsx)(t.code,{children:"arm64"})]}),(0,l.jsx)(t.td,{style:{textAlign:"center"},children:(0,l.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"center"},children:"Windows"}),(0,l.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,l.jsx)(t.code,{children:"amd64"})," and ",(0,l.jsx)(t.code,{children:"arm64"})]}),(0,l.jsx)(t.td,{style:{textAlign:"center"},children:(0,l.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]})]})]}),"\n",(0,l.jsx)(t.h2,{id:"installation-steps",children:"Installation Steps"}),"\n",(0,l.jsx)(t.h3,{id:"linuxdarwin",children:"Linux/Darwin"}),"\n",(0,l.jsx)(t.pre,{children:(0,l.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n\n# install specific release\ncurl -sfL https://get.hauler.dev | HAULER_VERSION=1.0.0 bash\n"})}),"\n",(0,l.jsx)(t.h3,{id:"homebrew",children:"Homebrew"}),"\n",(0,l.jsx)(t.pre,{children:(0,l.jsx)(t.code,{className:"language-bash",children:"# installs latest release\nbrew tap rancherfederal/homebrew-tap\nbrew install hauler\n"})}),"\n",(0,l.jsx)(t.h3,{id:"windows",children:"Windows"}),"\n",(0,l.jsx)(t.pre,{children:(0,l.jsx)(t.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,l.jsx)(t.h2,{id:"manual-installation-steps",children:"Manual Installation Steps"}),"\n",(0,l.jsx)(t.h3,{id:"linuxdarwin-1",children:"Linux/Darwin"}),"\n",(0,l.jsx)(t.pre,{children:(0,l.jsx)(t.code,{className:"language-bash",children:'# set the hauler version (i.e. "1.0.0")\nexport vHauler=HAULER_VERSION\n\n# set the specific platform (i.e. "linux")\nexport platform=PLATFORM\n\n# set the specific arch (i.e. "amd64")\nexport arch=ARCH\n\ncurl -sOL https://github.com/rancherfederal/hauler/releases/download/v${vHauler}/hauler_${vHauler}_${platform}_${arch}.tar.gz\ntar -xf hauler_${vHauler}_${platform}_${arch}.tar.gz\nsudo mv hauler /usr/bin/hauler\n'})}),"\n",(0,l.jsx)(t.h3,{id:"homebrew-1",children:"Homebrew"}),"\n",(0,l.jsx)(t.pre,{children:(0,l.jsx)(t.code,{className:"language-bash",children:"# not applicable\n"})}),"\n",(0,l.jsx)(t.h3,{id:"windows-1",children:"Windows"}),"\n",(0,l.jsx)(t.pre,{children:(0,l.jsx)(t.code,{className:"language-bash",children:"# coming soon\n"})})]})}function h(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(o,{...e})}):o(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>i});var l=n(6540);const r={},s=l.createContext(r);function a(e){const t=l.useContext(s);return l.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),l.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9b4a10b8.ed0c1cba.js b/assets/js/9b4a10b8.ed0c1cba.js new file mode 100644 index 000000000..8bbb5db0b --- /dev/null +++ b/assets/js/9b4a10b8.ed0c1cba.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4662],{2160:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var l=n(4848),r=n(8453);const s={title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},i=void 0,a={id:"introduction/install",title:"Installation",description:"Installation Documentation for Hauler",source:"@site/docs/introduction/install.md",sourceDirName:"introduction",slug:"/introduction/install",permalink:"/docs/next/introduction/install",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/docs/introduction/install.md",tags:[],version:"current",frontMatter:{title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},sidebar:"haulerSidebar",previous:{title:"Quickstart",permalink:"/docs/next/introduction/quickstart"},next:{title:"Uninstall",permalink:"/docs/next/introduction/uninstall"}},c={},d=[{value:"Overview",id:"overview",level:2},{value:"Supported Architectures",id:"supported-architectures",level:2},{value:"Installation Steps",id:"installation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin",level:3},{value:"Homebrew",id:"homebrew",level:3},{value:"Windows",id:"windows",level:3},{value:"Manual Installation Steps",id:"manual-installation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin-1",level:3},{value:"Homebrew",id:"homebrew-1",level:3},{value:"Windows",id:"windows-1",level:3}];function o(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(t.h2,{id:"overview",children:"Overview"}),"\n",(0,l.jsxs)(t.p,{children:["Hauler is a purpose built to be a single binary with no specific prerequistes, depedencies, or runtime environment. It's installation is very simple and easy to follow. To view the latest release, please view our ",(0,l.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"GitHub Release"})," page."]}),"\n",(0,l.jsx)(t.h2,{id:"supported-architectures",children:"Supported Architectures"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"center"},children:"Base Platform"}),(0,l.jsx)(t.th,{style:{textAlign:"center"},children:"Architecture"}),(0,l.jsx)(t.th,{style:{textAlign:"center"},children:"Latest Release"})]})}),(0,l.jsxs)(t.tbody,{children:[(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"center"},children:"Linux"}),(0,l.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,l.jsx)(t.code,{children:"amd64"})," and ",(0,l.jsx)(t.code,{children:"arm64"})]}),(0,l.jsx)(t.td,{style:{textAlign:"center"},children:(0,l.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"center"},children:"Darwin"}),(0,l.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,l.jsx)(t.code,{children:"amd64"})," and ",(0,l.jsx)(t.code,{children:"arm64"})]}),(0,l.jsx)(t.td,{style:{textAlign:"center"},children:(0,l.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"center"},children:"Windows"}),(0,l.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,l.jsx)(t.code,{children:"amd64"})," and ",(0,l.jsx)(t.code,{children:"arm64"})]}),(0,l.jsx)(t.td,{style:{textAlign:"center"},children:(0,l.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]})]})]}),"\n",(0,l.jsx)(t.h2,{id:"installation-steps",children:"Installation Steps"}),"\n",(0,l.jsx)(t.h3,{id:"linuxdarwin",children:"Linux/Darwin"}),"\n",(0,l.jsx)(t.pre,{children:(0,l.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n\n# install specific release\ncurl -sfL https://get.hauler.dev | HAULER_VERSION=1.0.0 bash\n"})}),"\n",(0,l.jsx)(t.h3,{id:"homebrew",children:"Homebrew"}),"\n",(0,l.jsx)(t.pre,{children:(0,l.jsx)(t.code,{className:"language-bash",children:"# installs latest release\nbrew tap rancherfederal/homebrew-tap\nbrew install hauler\n"})}),"\n",(0,l.jsx)(t.h3,{id:"windows",children:"Windows"}),"\n",(0,l.jsx)(t.pre,{children:(0,l.jsx)(t.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,l.jsx)(t.h2,{id:"manual-installation-steps",children:"Manual Installation Steps"}),"\n",(0,l.jsx)(t.h3,{id:"linuxdarwin-1",children:"Linux/Darwin"}),"\n",(0,l.jsx)(t.pre,{children:(0,l.jsx)(t.code,{className:"language-bash",children:'# set the hauler version (i.e. "1.0.0")\nexport vHauler=HAULER_VERSION\n\n# set the specific platform (i.e. "linux")\nexport platform=PLATFORM\n\n# set the specific arch (i.e. "amd64")\nexport arch=ARCH\n\ncurl -sOL https://github.com/rancherfederal/hauler/releases/download/v${vHauler}/hauler_${vHauler}_${platform}_${arch}.tar.gz\ntar -xf hauler_${vHauler}_${platform}_${arch}.tar.gz\nsudo mv hauler /usr/bin/hauler\n'})}),"\n",(0,l.jsx)(t.h3,{id:"homebrew-1",children:"Homebrew"}),"\n",(0,l.jsx)(t.pre,{children:(0,l.jsx)(t.code,{className:"language-bash",children:"# not applicable\n"})}),"\n",(0,l.jsx)(t.h3,{id:"windows-1",children:"Windows"}),"\n",(0,l.jsx)(t.pre,{children:(0,l.jsx)(t.code,{className:"language-bash",children:"# coming soon\n"})})]})}function h(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(o,{...e})}):o(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>a});var l=n(6540);const r={},s=l.createContext(r);function i(e){const t=l.useContext(s);return l.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),l.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9ea6ce46.890e6c59.js b/assets/js/9ea6ce46.890e6c59.js deleted file mode 100644 index 804017053..000000000 --- a/assets/js/9ea6ce46.890e6c59.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3254],{6742:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>t,metadata:()=>l,toc:()=>d});var a=r(4848),s=r(8453);const t={title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},i=void 0,l={id:"guides-references/cluster-images",title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",source:"@site/versioned_docs/version-0.4.2/guides-references/cluster-images.md",sourceDirName:"guides-references",slug:"/guides-references/cluster-images",permalink:"/hauler-docs/docs/0.4.2/guides-references/cluster-images",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.2/guides-references/cluster-images.md",tags:[],version:"0.4.2",frontMatter:{title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/hauler-docs/docs/0.4.2/guides-references/overview"},next:{title:"RGS Carbide Customers",permalink:"/hauler-docs/docs/0.4.2/guides-references/carbide-customers"}},c={},d=[{value:"Example Output",id:"example-output",level:3},{value:"Hauler Manifest using the Images",id:"hauler-manifest-using-the-images",level:3},{value:"Resulting Hauler Manifest",id:"resulting-hauler-manifest",level:3}];function o(e){const n={code:"code",h3:"h3",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsxs)(n.p,{children:["It may be difficult to understand exactly what ",(0,a.jsx)(n.code,{children:"content"})," is actively within your environment. Below is a simple way to generate a list of all images running in your environment, store it as an environment variable, and show the list by echoing the environment variable."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"export IMAGE_LIST=$(kubectl get pods --all-namespaces -o jsonpath=\"{.items[*].spec.containers[*].image}\" |tr -s '[[:space:]]' '\\n' |sort |uniq -c | cut -c 9-)\necho \"$IMAGE_LIST\"\n"})}),"\n",(0,a.jsx)(n.h3,{id:"example-output",children:"Example Output"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:"index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\nindex.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\nindex.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\nrancher/hardened-calico:v3.21.4-build20220228\nrancher/hardened-cluster-autoscaler:v1.8.5-build20211119\nrancher/hardened-coredns:v1.9.1-build20220318\nrancher/hardened-flannel:v0.17.0-build20220317\nrancher/hardened-k8s-metrics-server:v0.5.0-build20211119\nrancher/klipper-helm:v0.7.0-build20220315\nrancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})}),"\n",(0,a.jsx)(n.h3,{id:"hauler-manifest-using-the-images",children:"Hauler Manifest using the Images"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:"IMAGE_LIST_MODIFIED=$(cat \"$IMAGE_LIST\" | sed 's/^/ - name: /')\n# sed, stream editor, appends 2 spaces of indentation denotes\n# an entry in a list, then adds name: to match expected syntax\n"})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images-example\nspec:\n images:\n$IMAGE_LIST_MODIFIED\n"})}),"\n",(0,a.jsx)(n.h3,{id:"resulting-hauler-manifest",children:"Resulting Hauler Manifest"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images-example\nspec:\n images:\n - name: index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\n - name: index.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\n - name: index.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\n - name: rancher/hardened-calico:v3.21.4-build20220228\n - name: rancher/hardened-cluster-autoscaler:v1.8.5-build20211119\n - name: rancher/hardened-coredns:v1.9.1-build20220318\n - name: rancher/hardened-flannel:v0.17.0-build20220317\n - name: rancher/hardened-k8s-metrics-server:v0.5.0-build20211119\n - name: rancher/klipper-helm:v0.7.0-build20220315\n - name: rancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(o,{...e})}):o(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>l});var a=r(6540);const s={},t=a.createContext(s);function i(e){const n=a.useContext(t);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),a.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9ea6ce46.f53aa604.js b/assets/js/9ea6ce46.f53aa604.js new file mode 100644 index 000000000..f7f809d92 --- /dev/null +++ b/assets/js/9ea6ce46.f53aa604.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3254],{6742:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>t,metadata:()=>l,toc:()=>d});var a=r(4848),s=r(8453);const t={title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},i=void 0,l={id:"guides-references/cluster-images",title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",source:"@site/versioned_docs/version-0.4.2/guides-references/cluster-images.md",sourceDirName:"guides-references",slug:"/guides-references/cluster-images",permalink:"/docs/0.4.2/guides-references/cluster-images",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.2/guides-references/cluster-images.md",tags:[],version:"0.4.2",frontMatter:{title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/docs/0.4.2/guides-references/overview"},next:{title:"RGS Carbide Customers",permalink:"/docs/0.4.2/guides-references/carbide-customers"}},c={},d=[{value:"Example Output",id:"example-output",level:3},{value:"Hauler Manifest using the Images",id:"hauler-manifest-using-the-images",level:3},{value:"Resulting Hauler Manifest",id:"resulting-hauler-manifest",level:3}];function o(e){const n={code:"code",h3:"h3",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsxs)(n.p,{children:["It may be difficult to understand exactly what ",(0,a.jsx)(n.code,{children:"content"})," is actively within your environment. Below is a simple way to generate a list of all images running in your environment, store it as an environment variable, and show the list by echoing the environment variable."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"export IMAGE_LIST=$(kubectl get pods --all-namespaces -o jsonpath=\"{.items[*].spec.containers[*].image}\" |tr -s '[[:space:]]' '\\n' |sort |uniq -c | cut -c 9-)\necho \"$IMAGE_LIST\"\n"})}),"\n",(0,a.jsx)(n.h3,{id:"example-output",children:"Example Output"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:"index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\nindex.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\nindex.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\nrancher/hardened-calico:v3.21.4-build20220228\nrancher/hardened-cluster-autoscaler:v1.8.5-build20211119\nrancher/hardened-coredns:v1.9.1-build20220318\nrancher/hardened-flannel:v0.17.0-build20220317\nrancher/hardened-k8s-metrics-server:v0.5.0-build20211119\nrancher/klipper-helm:v0.7.0-build20220315\nrancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})}),"\n",(0,a.jsx)(n.h3,{id:"hauler-manifest-using-the-images",children:"Hauler Manifest using the Images"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:"IMAGE_LIST_MODIFIED=$(cat \"$IMAGE_LIST\" | sed 's/^/ - name: /')\n# sed, stream editor, appends 2 spaces of indentation denotes\n# an entry in a list, then adds name: to match expected syntax\n"})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images-example\nspec:\n images:\n$IMAGE_LIST_MODIFIED\n"})}),"\n",(0,a.jsx)(n.h3,{id:"resulting-hauler-manifest",children:"Resulting Hauler Manifest"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images-example\nspec:\n images:\n - name: index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\n - name: index.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\n - name: index.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\n - name: rancher/hardened-calico:v3.21.4-build20220228\n - name: rancher/hardened-cluster-autoscaler:v1.8.5-build20211119\n - name: rancher/hardened-coredns:v1.9.1-build20220318\n - name: rancher/hardened-flannel:v0.17.0-build20220317\n - name: rancher/hardened-k8s-metrics-server:v0.5.0-build20211119\n - name: rancher/klipper-helm:v0.7.0-build20220315\n - name: rancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(o,{...e})}):o(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>l});var a=r(6540);const s={},t=a.createContext(s);function i(e){const n=a.useContext(t);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),a.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a0e1656a.b2741e47.js b/assets/js/a0e1656a.b2741e47.js deleted file mode 100644 index ba74a6555..000000000 --- a/assets/js/a0e1656a.b2741e47.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[6506],{3303:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>o,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>l});var r=t(4848),a=t(8453);const s={title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',sidebar_label:"Images"},o=void 0,c={id:"guides-references/hauler-content/images",title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',source:"@site/versioned_docs/version-0.4.4/guides-references/hauler-content/images.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/images",permalink:"/hauler-docs/docs/0.4.4/guides-references/hauler-content/images",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.4/guides-references/hauler-content/images.md",tags:[],version:"0.4.4",frontMatter:{title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',sidebar_label:"Images"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/hauler-docs/docs/0.4.4/guides-references/hauler-content/overview"},next:{title:"Charts",permalink:"/hauler-docs/docs/0.4.4/guides-references/hauler-content/charts"}},i={},l=[];function d(e){const n={code:"code",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.p,{children:"Any OCI compatible image can be fetched remotely:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'# "shorthand" image references\nhauler store add image rancher/rancher:v2.8.2\n\n# fully qualified image references\nhauler store add image ghcr.io/fluxcd/flux-cli@sha256:02aa820c3a9c57d67208afcfc4bce9661658c17d15940aea369da259d2b976dd\n\n# adds an arch/platform specific version of a multi-arch image to the haul/store. by default, hauler will pull and save all archs/platforms contained in the image manifest.\nhauler store add image rancher/rancher:v2.8.2 --platform linux/amd64\n'})})]})}function u(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>c});var r=t(6540);const a={},s=r.createContext(a);function o(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:o(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a0e1656a.c562aeb5.js b/assets/js/a0e1656a.c562aeb5.js new file mode 100644 index 000000000..139979b1a --- /dev/null +++ b/assets/js/a0e1656a.c562aeb5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[6506],{3303:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>o,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>l});var r=t(4848),a=t(8453);const s={title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',sidebar_label:"Images"},o=void 0,c={id:"guides-references/hauler-content/images",title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',source:"@site/versioned_docs/version-0.4.4/guides-references/hauler-content/images.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/images",permalink:"/docs/0.4.4/guides-references/hauler-content/images",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.4/guides-references/hauler-content/images.md",tags:[],version:"0.4.4",frontMatter:{title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',sidebar_label:"Images"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/docs/0.4.4/guides-references/hauler-content/overview"},next:{title:"Charts",permalink:"/docs/0.4.4/guides-references/hauler-content/charts"}},i={},l=[];function d(e){const n={code:"code",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.p,{children:"Any OCI compatible image can be fetched remotely:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'# "shorthand" image references\nhauler store add image rancher/rancher:v2.8.2\n\n# fully qualified image references\nhauler store add image ghcr.io/fluxcd/flux-cli@sha256:02aa820c3a9c57d67208afcfc4bce9661658c17d15940aea369da259d2b976dd\n\n# adds an arch/platform specific version of a multi-arch image to the haul/store. by default, hauler will pull and save all archs/platforms contained in the image manifest.\nhauler store add image rancher/rancher:v2.8.2 --platform linux/amd64\n'})})]})}function u(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>c});var r=t(6540);const a={},s=r.createContext(a);function o(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:o(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a1085104.4cb73ad5.js b/assets/js/a1085104.4cb73ad5.js new file mode 100644 index 000000000..b0f146c32 --- /dev/null +++ b/assets/js/a1085104.4cb73ad5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7107],{6909:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>l,contentTitle:()=>c,default:()=>m,frontMatter:()=>s,metadata:()=>r,toc:()=>u});var n=o(4848),i=o(8453);const s={title:"Hauler Community Collections",description:"Hauler Community Collections Documentation",sidebar_label:"Community Collections"},c=void 0,r={id:"guides-references/hauler-collections/community-collections",title:"Hauler Community Collections",description:"Hauler Community Collections Documentation",source:"@site/versioned_docs/version-1.0.0/guides-references/hauler-collections/community-collections.md",sourceDirName:"guides-references/hauler-collections",slug:"/guides-references/hauler-collections/community-collections",permalink:"/docs/1.0.0/guides-references/hauler-collections/community-collections",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.0/guides-references/hauler-collections/community-collections.md",tags:[],version:"1.0.0",frontMatter:{title:"Hauler Community Collections",description:"Hauler Community Collections Documentation",sidebar_label:"Community Collections"},sidebar:"haulerSidebar",previous:{title:"RGS Carbide Customers",permalink:"/docs/1.0.0/guides-references/carbide-customers"},next:{title:"Images",permalink:"/docs/1.0.0/guides-references/hauler-content/images"}},l={},u=[];function a(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,n.jsx)(t.p,{children:"Hauler Community Collections are pending a future release!"})}function m(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},8453:(e,t,o)=>{o.d(t,{R:()=>c,x:()=>r});var n=o(6540);const i={},s=n.createContext(i);function c(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a1085104.f011827f.js b/assets/js/a1085104.f011827f.js deleted file mode 100644 index efa090ef5..000000000 --- a/assets/js/a1085104.f011827f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7107],{6909:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>l,contentTitle:()=>i,default:()=>m,frontMatter:()=>c,metadata:()=>r,toc:()=>u});var n=t(4848),s=t(8453);const c={title:"Hauler Community Collections",description:"Hauler Community Collections Documentation",sidebar_label:"Community Collections"},i=void 0,r={id:"guides-references/hauler-collections/community-collections",title:"Hauler Community Collections",description:"Hauler Community Collections Documentation",source:"@site/versioned_docs/version-1.0.0/guides-references/hauler-collections/community-collections.md",sourceDirName:"guides-references/hauler-collections",slug:"/guides-references/hauler-collections/community-collections",permalink:"/hauler-docs/docs/1.0.0/guides-references/hauler-collections/community-collections",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.0/guides-references/hauler-collections/community-collections.md",tags:[],version:"1.0.0",frontMatter:{title:"Hauler Community Collections",description:"Hauler Community Collections Documentation",sidebar_label:"Community Collections"},sidebar:"haulerSidebar",previous:{title:"RGS Carbide Customers",permalink:"/hauler-docs/docs/1.0.0/guides-references/carbide-customers"},next:{title:"Images",permalink:"/hauler-docs/docs/1.0.0/guides-references/hauler-content/images"}},l={},u=[];function a(e){const o={p:"p",...(0,s.R)(),...e.components};return(0,n.jsx)(o.p,{children:"Hauler Community Collections are pending a future release!"})}function m(e={}){const{wrapper:o}={...(0,s.R)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},8453:(e,o,t)=>{t.d(o,{R:()=>i,x:()=>r});var n=t(6540);const s={},c=n.createContext(s);function i(e){const o=n.useContext(c);return n.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function r(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),n.createElement(c.Provider,{value:o},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a1833862.bd9a1f5f.js b/assets/js/a1833862.bd9a1f5f.js deleted file mode 100644 index 88d8adfec..000000000 --- a/assets/js/a1833862.bd9a1f5f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[775],{2814:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next \ud83d\udea7","banner":"unreleased","badge":true,"noIndex":false,"className":"docs-version-current","isLast":false,"docsSidebars":{"haulerSidebar":[{"type":"link","label":"Introduction","href":"/hauler-docs/docs/next/intro","docId":"intro","unlisted":false},{"type":"link","label":"Core Concepts","href":"/hauler-docs/docs/next/core-concepts","docId":"core-concepts","unlisted":false},{"type":"link","label":"Airgap Workflow","href":"/hauler-docs/docs/next/airgap-workflow","docId":"airgap-workflow","unlisted":false},{"type":"category","label":"Introduction","description":"Introduction Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Quickstart","href":"/hauler-docs/docs/next/introduction/quickstart","docId":"introduction/quickstart","unlisted":false},{"type":"link","label":"Installation","href":"/hauler-docs/docs/next/introduction/install","docId":"introduction/install","unlisted":false},{"type":"link","label":"Uninstall","href":"/hauler-docs/docs/next/introduction/uninstall","docId":"introduction/uninstall","unlisted":false}],"collapsible":true},{"type":"category","label":"Guides & References","description":"Guides and References Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Overview","href":"/hauler-docs/docs/next/guides-references/overview","docId":"guides-references/overview","unlisted":false},{"type":"link","label":"Fetch Cluster Images","href":"/hauler-docs/docs/next/guides-references/cluster-images","docId":"guides-references/cluster-images","unlisted":false},{"type":"link","label":"RGS Carbide Customers","href":"/hauler-docs/docs/next/guides-references/carbide-customers","docId":"guides-references/carbide-customers","unlisted":false},{"type":"category","label":"Bootstrapping Utilities","description":"Guides and References for Hauler Bootstrapping Utilities","collapsed":false,"items":[{"type":"link","label":"Hauler Registry","href":"/hauler-docs/docs/next/guides-references/utilities/registry","docId":"guides-references/utilities/registry","unlisted":false},{"type":"link","label":"Hauler Fileserver","href":"/hauler-docs/docs/next/guides-references/utilities/fileserver","docId":"guides-references/utilities/fileserver","unlisted":false}],"collapsible":true},{"type":"link","label":"Hauler Manifests","href":"/hauler-docs/docs/next/guides-references/manifests","docId":"guides-references/manifests","unlisted":false},{"type":"category","label":"Hauler Collections","description":"Guides and References for Hauler Collections","items":[{"type":"link","label":"Community Collections","href":"/hauler-docs/docs/next/guides-references/hauler-collections/community-collections","docId":"guides-references/hauler-collections/community-collections","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Hauler Content","description":"Guides and References for Hauler Content Types","items":[{"type":"link","label":"Images","href":"/hauler-docs/docs/next/guides-references/hauler-content/images","docId":"guides-references/hauler-content/images","unlisted":false},{"type":"link","label":"Charts","href":"/hauler-docs/docs/next/guides-references/hauler-content/charts","docId":"guides-references/hauler-content/charts","unlisted":false},{"type":"link","label":"Files","href":"/hauler-docs/docs/next/guides-references/hauler-content/files","docId":"guides-references/hauler-content/files","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Hauler Command Line","description":"Guides and References for the Hauler Command Line","items":[{"type":"link","label":"Hauler","href":"/hauler-docs/docs/next/guides-references/command-line/hauler","docId":"guides-references/command-line/hauler","unlisted":false},{"type":"link","label":"Hauler Store","href":"/hauler-docs/docs/next/guides-references/command-line/hauler-store","docId":"guides-references/command-line/hauler-store","unlisted":false},{"type":"link","label":"Hauler Completion","href":"/hauler-docs/docs/next/guides-references/command-line/hauler-completion","docId":"guides-references/command-line/hauler-completion","unlisted":false},{"type":"link","label":"Hauler Version","href":"/hauler-docs/docs/next/guides-references/command-line/hauler-version","docId":"guides-references/command-line/hauler-version","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true},{"type":"link","label":"Known Issues/Limits","href":"/hauler-docs/docs/next/known-limits","docId":"known-limits","unlisted":false},{"type":"link","label":"Feedback","href":"/hauler-docs/docs/next/feedback","docId":"feedback","unlisted":false}]},"docs":{"airgap-workflow":{"id":"airgap-workflow","title":"Airgap Workflow","description":"Airgap Workflow Documentation for Hauler","sidebar":"haulerSidebar"},"core-concepts":{"id":"core-concepts","title":"Core Concepts","description":"Core Concepts Documentation for Hauler","sidebar":"haulerSidebar"},"feedback":{"id":"feedback","title":"Feedback","description":"Feedback for Hauler","sidebar":"haulerSidebar"},"guides-references/carbide-customers":{"id":"guides-references/carbide-customers","title":"RGS Carbide Customers","description":"RGS Carbide Customers Documentation","sidebar":"haulerSidebar"},"guides-references/cluster-images":{"id":"guides-references/cluster-images","title":"Fetching Cluster Images","description":"Fetching Images on a Cluster Documentation","sidebar":"haulerSidebar"},"guides-references/command-line/hauler":{"id":"guides-references/command-line/hauler","title":"Hauler (Command)","description":"Hauler CLI Reference for hauler","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-completion":{"id":"guides-references/command-line/hauler-completion","title":"Hauler Completion (Command)","description":"Hauler CLI Reference for hauler completion","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-login":{"id":"guides-references/command-line/hauler-login","title":"Hauler Login (Command)","description":"Hauler CLI Reference for hauler login"},"guides-references/command-line/hauler-store":{"id":"guides-references/command-line/hauler-store","title":"Hauler Store (Command)","description":"Hauler CLI Reference for hauler store","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-version":{"id":"guides-references/command-line/hauler-version","title":"Hauler Version (Command)","description":"Hauler CLI Reference for hauler version","sidebar":"haulerSidebar"},"guides-references/hauler-collections/community-collections":{"id":"guides-references/hauler-collections/community-collections","title":"Hauler Community Collections","description":"Hauler Community Collections Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/charts":{"id":"guides-references/hauler-content/charts","title":"Hauler Content - Charts","description":"Hauler Content - Charts Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/files":{"id":"guides-references/hauler-content/files","title":"Hauler Content - Files","description":"Hauler Content - Files Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/images":{"id":"guides-references/hauler-content/images","title":"Hauler Content - Images","description":"Hauler Content - Images Documentation","sidebar":"haulerSidebar"},"guides-references/manifests":{"id":"guides-references/manifests","title":"Hauler Manifests","description":"Hauler Manifests Documentation","sidebar":"haulerSidebar"},"guides-references/overview":{"id":"guides-references/overview","title":"Overview","description":"Reference Guides Overview Documentation for Hauler","sidebar":"haulerSidebar"},"guides-references/utilities/fileserver":{"id":"guides-references/utilities/fileserver","title":"Hauler Fileserver","description":"Hauler Fileserver Documentation","sidebar":"haulerSidebar"},"guides-references/utilities/registry":{"id":"guides-references/utilities/registry","title":"Hauler Registry","description":"Hauler Registry Documentation","sidebar":"haulerSidebar"},"intro":{"id":"intro","title":"Introduction","description":"Introduction to Rancher Government Hauler","sidebar":"haulerSidebar"},"introduction/install":{"id":"introduction/install","title":"Installation","description":"Installation Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/quickstart":{"id":"introduction/quickstart","title":"Quickstart","description":"Quickstart Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/uninstall":{"id":"introduction/uninstall","title":"Uninstall","description":"Uninstall Documentation for Hauler","sidebar":"haulerSidebar"},"known-limits":{"id":"known-limits","title":"Known Issues and Limits","description":"Known Issues and Limitations for Hauler","sidebar":"haulerSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/a3c9f3d7.718e6240.js b/assets/js/a3c9f3d7.718e6240.js deleted file mode 100644 index 0b44f7115..000000000 --- a/assets/js/a3c9f3d7.718e6240.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5957],{8832:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>t,toc:()=>c});var o=l(4848),s=l(8453);const r={title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},i=void 0,t={id:"guides-references/command-line/hauler-completion",title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",source:"@site/versioned_docs/version-0.4.4/guides-references/command-line/hauler-completion.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-completion",permalink:"/hauler-docs/docs/0.4.4/guides-references/command-line/hauler-completion",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.4/guides-references/command-line/hauler-completion.md",tags:[],version:"0.4.4",frontMatter:{title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},sidebar:"haulerSidebar",previous:{title:"Hauler Store",permalink:"/hauler-docs/docs/0.4.4/guides-references/command-line/hauler-store"},next:{title:"Hauler Version",permalink:"/hauler-docs/docs/0.4.4/guides-references/command-line/hauler-version"}},a={},c=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler completion bash:",id:"hauler-completion-bash",level:4},{value:"hauler completion fish:",id:"hauler-completion-fish",level:4},{value:"hauler completion powershell:",id:"hauler-completion-powershell",level:4},{value:"hauler completion zsh:",id:"hauler-completion-zsh",level:4}];function h(e){const n={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate an autocompletion script for hauler for the specified shell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler completion [command]\n\nAvailable Commands:\n bash Generates bash completion scripts\n fish Generates fish completion scripts\n powershell Generates powershell completion scripts\n zsh Generates zsh completion scripts\n\nFlags:\n -h, --help help for completion\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler completion [command] --help" for more information about a command.\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-bash",children:[(0,o.jsx)(n.code,{children:"hauler completion bash"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Generate the autocompletion script for the bash shell.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Note:"})," This script depends on the 'bash-completion' package."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion bash)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion bash > /etc/bash_completion.d/hauler\n\n#### macOS:\n\n hauler completion bash > $(brew --prefix)/etc/bash_completion.d/hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion bash\n\nFlags:\n -h, --help help for bash\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-fish",children:[(0,o.jsx)(n.code,{children:"hauler completion fish"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate the autocompletion script for the fish shell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion fish | source\n\nTo load completions for every new session, execute once:\n\n hauler completion fish > ~/.config/fish/completions/hauler.fish\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion fish [flags]\n\nFlags:\n -h, --help help for fish\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-powershell",children:[(0,o.jsx)(n.code,{children:"hauler completion powershell"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate the autocompletion script for powershell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion powershell | Out-String | Invoke-Expression\n\nTo load completions for every new session, add the output of the above command\nto your powershell profile.\n\nUsage:\n hauler completion powershell [flags]\n\nFlags:\n -h, --help help for powershell\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-zsh",children:[(0,o.jsx)(n.code,{children:"hauler completion zsh"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Generate the autocompletion script for the zsh shell.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Note:"})," If shell completion is not already enabled in your environment you will need to enable it."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion zsh)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion zsh > "${fpath[1]}/_hauler"\n\n#### macOS:\n\n hauler completion zsh > $(brew --prefix)/share/zsh/site-functions/_hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion zsh [flags]\n\nFlags:\n -h, --help help for zsh\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n'})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},8453:(e,n,l)=>{l.d(n,{R:()=>i,x:()=>t});var o=l(6540);const s={},r=o.createContext(s);function i(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a3c9f3d7.87d04772.js b/assets/js/a3c9f3d7.87d04772.js new file mode 100644 index 000000000..1310c4952 --- /dev/null +++ b/assets/js/a3c9f3d7.87d04772.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5957],{8832:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>t,toc:()=>c});var o=l(4848),s=l(8453);const r={title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},i=void 0,t={id:"guides-references/command-line/hauler-completion",title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",source:"@site/versioned_docs/version-0.4.4/guides-references/command-line/hauler-completion.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-completion",permalink:"/docs/0.4.4/guides-references/command-line/hauler-completion",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.4/guides-references/command-line/hauler-completion.md",tags:[],version:"0.4.4",frontMatter:{title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},sidebar:"haulerSidebar",previous:{title:"Hauler Store",permalink:"/docs/0.4.4/guides-references/command-line/hauler-store"},next:{title:"Hauler Version",permalink:"/docs/0.4.4/guides-references/command-line/hauler-version"}},a={},c=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler completion bash:",id:"hauler-completion-bash",level:4},{value:"hauler completion fish:",id:"hauler-completion-fish",level:4},{value:"hauler completion powershell:",id:"hauler-completion-powershell",level:4},{value:"hauler completion zsh:",id:"hauler-completion-zsh",level:4}];function h(e){const n={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate an autocompletion script for hauler for the specified shell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler completion [command]\n\nAvailable Commands:\n bash Generates bash completion scripts\n fish Generates fish completion scripts\n powershell Generates powershell completion scripts\n zsh Generates zsh completion scripts\n\nFlags:\n -h, --help help for completion\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler completion [command] --help" for more information about a command.\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-bash",children:[(0,o.jsx)(n.code,{children:"hauler completion bash"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Generate the autocompletion script for the bash shell.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Note:"})," This script depends on the 'bash-completion' package."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion bash)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion bash > /etc/bash_completion.d/hauler\n\n#### macOS:\n\n hauler completion bash > $(brew --prefix)/etc/bash_completion.d/hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion bash\n\nFlags:\n -h, --help help for bash\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-fish",children:[(0,o.jsx)(n.code,{children:"hauler completion fish"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate the autocompletion script for the fish shell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion fish | source\n\nTo load completions for every new session, execute once:\n\n hauler completion fish > ~/.config/fish/completions/hauler.fish\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion fish [flags]\n\nFlags:\n -h, --help help for fish\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-powershell",children:[(0,o.jsx)(n.code,{children:"hauler completion powershell"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Generate the autocompletion script for powershell."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion powershell | Out-String | Invoke-Expression\n\nTo load completions for every new session, add the output of the above command\nto your powershell profile.\n\nUsage:\n hauler completion powershell [flags]\n\nFlags:\n -h, --help help for powershell\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,o.jsxs)(n.h4,{id:"hauler-completion-zsh",children:[(0,o.jsx)(n.code,{children:"hauler completion zsh"}),":"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:["Generate the autocompletion script for the zsh shell.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.strong,{children:"Note:"})," If shell completion is not already enabled in your environment you will need to enable it."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion zsh)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion zsh > "${fpath[1]}/_hauler"\n\n#### macOS:\n\n hauler completion zsh > $(brew --prefix)/share/zsh/site-functions/_hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion zsh [flags]\n\nFlags:\n -h, --help help for zsh\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n'})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(h,{...e})}):h(e)}},8453:(e,n,l)=>{l.d(n,{R:()=>i,x:()=>t});var o=l(6540);const s={},r=o.createContext(s);function i(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a6e70215.341a6703.js b/assets/js/a6e70215.341a6703.js deleted file mode 100644 index 6e6f6d714..000000000 --- a/assets/js/a6e70215.341a6703.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1890],{9848:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>s,metadata:()=>i,toc:()=>d});var r=n(4848),l=n(8453);const s={title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},a=void 0,i={id:"introduction/install",title:"Installation",description:"Installation Documentation for Hauler",source:"@site/versioned_docs/version-0.4.0/introduction/install.md",sourceDirName:"introduction",slug:"/introduction/install",permalink:"/hauler-docs/docs/0.4.0/introduction/install",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.0/introduction/install.md",tags:[],version:"0.4.0",frontMatter:{title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},sidebar:"haulerSidebar",previous:{title:"Quickstart",permalink:"/hauler-docs/docs/0.4.0/introduction/quickstart"},next:{title:"Uninstall",permalink:"/hauler-docs/docs/0.4.0/introduction/uninstall"}},c={},d=[{value:"Overview",id:"overview",level:2},{value:"Supported Architectures",id:"supported-architectures",level:2},{value:"Installation Steps",id:"installation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin",level:3},{value:"Windows",id:"windows",level:3},{value:"Homebrew",id:"homebrew",level:3},{value:"Manual Installation Steps",id:"manual-installation-steps",level:2}];function o(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h2,{id:"overview",children:"Overview"}),"\n",(0,r.jsxs)(t.p,{children:["Hauler is a purpose built to be a single binary with no specific prerequistes or depedencies. It's installation is very simple and easy to follow. To view the latest release, please view our ",(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"GitHub Release"})," page."]}),"\n",(0,r.jsx)(t.h2,{id:"supported-architectures",children:"Supported Architectures"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Base Platform"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Architecture"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Latest Release"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Linux"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Darwin"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Windows"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]})]})]}),"\n",(0,r.jsx)(t.h2,{id:"installation-steps",children:"Installation Steps"}),"\n",(0,r.jsx)(t.h3,{id:"linuxdarwin",children:"Linux/Darwin"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n\n# install specific release\ncurl -sfL https://get.hauler.dev | HAULER_VERSION=0.4.0 bash\n"})}),"\n",(0,r.jsx)(t.h3,{id:"windows",children:"Windows"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,r.jsx)(t.h3,{id:"homebrew",children:"Homebrew"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,r.jsx)(t.h2,{id:"manual-installation-steps",children:"Manual Installation Steps"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:'# set the hauler version (i.e. "0.4.0")\nexport vHauler=HAULER_VERSION\n\n# set the specific platform (i.e. "linux")\nexport platform=PLATFORM\n\n# set the specific arch (i.e. "amd64")\nexport arch=ARCH\n\ncurl -sOL https://github.com/rancherfederal/hauler/releases/download/v${vHauler}/hauler_${vHauler}_${platform}_${arch}.tar.gz\ntar -xf hauler_${vHauler}_${platform}_${arch}.tar.gz\nsudo mv hauler /usr/bin/hauler\n'})})]})}function h(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>i});var r=n(6540);const l={},s=r.createContext(l);function a(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:a(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a6e70215.85de7cec.js b/assets/js/a6e70215.85de7cec.js new file mode 100644 index 000000000..e4017a731 --- /dev/null +++ b/assets/js/a6e70215.85de7cec.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1890],{9848:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var r=n(4848),l=n(8453);const s={title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},i=void 0,a={id:"introduction/install",title:"Installation",description:"Installation Documentation for Hauler",source:"@site/versioned_docs/version-0.4.0/introduction/install.md",sourceDirName:"introduction",slug:"/introduction/install",permalink:"/docs/0.4.0/introduction/install",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.0/introduction/install.md",tags:[],version:"0.4.0",frontMatter:{title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},sidebar:"haulerSidebar",previous:{title:"Quickstart",permalink:"/docs/0.4.0/introduction/quickstart"},next:{title:"Uninstall",permalink:"/docs/0.4.0/introduction/uninstall"}},c={},d=[{value:"Overview",id:"overview",level:2},{value:"Supported Architectures",id:"supported-architectures",level:2},{value:"Installation Steps",id:"installation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin",level:3},{value:"Windows",id:"windows",level:3},{value:"Homebrew",id:"homebrew",level:3},{value:"Manual Installation Steps",id:"manual-installation-steps",level:2}];function o(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h2,{id:"overview",children:"Overview"}),"\n",(0,r.jsxs)(t.p,{children:["Hauler is a purpose built to be a single binary with no specific prerequistes or depedencies. It's installation is very simple and easy to follow. To view the latest release, please view our ",(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"GitHub Release"})," page."]}),"\n",(0,r.jsx)(t.h2,{id:"supported-architectures",children:"Supported Architectures"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Base Platform"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Architecture"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Latest Release"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Linux"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Darwin"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Windows"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]})]})]}),"\n",(0,r.jsx)(t.h2,{id:"installation-steps",children:"Installation Steps"}),"\n",(0,r.jsx)(t.h3,{id:"linuxdarwin",children:"Linux/Darwin"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n\n# install specific release\ncurl -sfL https://get.hauler.dev | HAULER_VERSION=0.4.0 bash\n"})}),"\n",(0,r.jsx)(t.h3,{id:"windows",children:"Windows"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,r.jsx)(t.h3,{id:"homebrew",children:"Homebrew"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,r.jsx)(t.h2,{id:"manual-installation-steps",children:"Manual Installation Steps"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:'# set the hauler version (i.e. "0.4.0")\nexport vHauler=HAULER_VERSION\n\n# set the specific platform (i.e. "linux")\nexport platform=PLATFORM\n\n# set the specific arch (i.e. "amd64")\nexport arch=ARCH\n\ncurl -sOL https://github.com/rancherfederal/hauler/releases/download/v${vHauler}/hauler_${vHauler}_${platform}_${arch}.tar.gz\ntar -xf hauler_${vHauler}_${platform}_${arch}.tar.gz\nsudo mv hauler /usr/bin/hauler\n'})})]})}function h(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>a});var r=n(6540);const l={},s=r.createContext(l);function i(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:i(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a74adf62.4f9e3510.js b/assets/js/a74adf62.4f9e3510.js deleted file mode 100644 index 57d9f5200..000000000 --- a/assets/js/a74adf62.4f9e3510.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1652],{2092:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>t,toc:()=>c});var l=o(4848),s=o(8453);const r={title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},i=void 0,t={id:"guides-references/command-line/hauler-completion",title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",source:"@site/versioned_docs/version-0.4.0/guides-references/command-line/hauler-completion.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-completion",permalink:"/hauler-docs/docs/0.4.0/guides-references/command-line/hauler-completion",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.0/guides-references/command-line/hauler-completion.md",tags:[],version:"0.4.0",frontMatter:{title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},sidebar:"haulerSidebar",previous:{title:"Hauler Store",permalink:"/hauler-docs/docs/0.4.0/guides-references/command-line/hauler-store"},next:{title:"Hauler Version",permalink:"/hauler-docs/docs/0.4.0/guides-references/command-line/hauler-version"}},a={},c=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler completion bash:",id:"hauler-completion-bash",level:4},{value:"hauler completion fish:",id:"hauler-completion-fish",level:4},{value:"hauler completion powershell:",id:"hauler-completion-powershell",level:4},{value:"hauler completion zsh:",id:"hauler-completion-zsh",level:4}];function h(e){const n={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"Generate an autocompletion script for hauler for the specified shell."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler completion [command]\n\nAvailable Commands:\n bash Generate the autocompletion script for bash\n fish Generate the autocompletion script for fish\n powershell Generate the autocompletion script for powershell\n zsh Generate the autocompletion script for zsh\n\nFlags:\n -h, --help help for completion\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler completion [command] --help" for more information about a command.\n'})}),"\n",(0,l.jsxs)(n.h4,{id:"hauler-completion-bash",children:[(0,l.jsx)(n.code,{children:"hauler completion bash"}),":"]}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:["Generate the autocompletion script for the bash shell.","\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"Note:"})," This script depends on the 'bash-completion' package."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion bash)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion bash > /etc/bash_completion.d/hauler\n\n#### macOS:\n\n hauler completion bash > $(brew --prefix)/etc/bash_completion.d/hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion bash\n\nFlags:\n -h, --help help for bash\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,l.jsxs)(n.h4,{id:"hauler-completion-fish",children:[(0,l.jsx)(n.code,{children:"hauler completion fish"}),":"]}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"Generate the autocompletion script for the fish shell."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion fish | source\n\nTo load completions for every new session, execute once:\n\n hauler completion fish > ~/.config/fish/completions/hauler.fish\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion fish [flags]\n\nFlags:\n -h, --help help for fish\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,l.jsxs)(n.h4,{id:"hauler-completion-powershell",children:[(0,l.jsx)(n.code,{children:"hauler completion powershell"}),":"]}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"Generate the autocompletion script for powershell."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion powershell | Out-String | Invoke-Expression\n\nTo load completions for every new session, add the output of the above command\nto your powershell profile.\n\nUsage:\n hauler completion powershell [flags]\n\nFlags:\n -h, --help help for powershell\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,l.jsxs)(n.h4,{id:"hauler-completion-zsh",children:[(0,l.jsx)(n.code,{children:"hauler completion zsh"}),":"]}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:["Generate the autocompletion script for the zsh shell.","\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"Note:"})," If shell completion is not already enabled in your environment you will need to enable it."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion zsh)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion zsh > "${fpath[1]}/_hauler"\n\n#### macOS:\n\n hauler completion zsh > $(brew --prefix)/share/zsh/site-functions/_hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion zsh [flags]\n\nFlags:\n -h, --help help for zsh\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n'})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(h,{...e})}):h(e)}},8453:(e,n,o)=>{o.d(n,{R:()=>i,x:()=>t});var l=o(6540);const s={},r=l.createContext(s);function i(e){const n=l.useContext(r);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),l.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a74adf62.cd316c77.js b/assets/js/a74adf62.cd316c77.js new file mode 100644 index 000000000..114da5e1b --- /dev/null +++ b/assets/js/a74adf62.cd316c77.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1652],{2092:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>t,toc:()=>c});var l=o(4848),s=o(8453);const r={title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},i=void 0,t={id:"guides-references/command-line/hauler-completion",title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",source:"@site/versioned_docs/version-0.4.0/guides-references/command-line/hauler-completion.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-completion",permalink:"/docs/0.4.0/guides-references/command-line/hauler-completion",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.0/guides-references/command-line/hauler-completion.md",tags:[],version:"0.4.0",frontMatter:{title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},sidebar:"haulerSidebar",previous:{title:"Hauler Store",permalink:"/docs/0.4.0/guides-references/command-line/hauler-store"},next:{title:"Hauler Version",permalink:"/docs/0.4.0/guides-references/command-line/hauler-version"}},a={},c=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler completion bash:",id:"hauler-completion-bash",level:4},{value:"hauler completion fish:",id:"hauler-completion-fish",level:4},{value:"hauler completion powershell:",id:"hauler-completion-powershell",level:4},{value:"hauler completion zsh:",id:"hauler-completion-zsh",level:4}];function h(e){const n={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"Generate an autocompletion script for hauler for the specified shell."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler completion [command]\n\nAvailable Commands:\n bash Generate the autocompletion script for bash\n fish Generate the autocompletion script for fish\n powershell Generate the autocompletion script for powershell\n zsh Generate the autocompletion script for zsh\n\nFlags:\n -h, --help help for completion\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler completion [command] --help" for more information about a command.\n'})}),"\n",(0,l.jsxs)(n.h4,{id:"hauler-completion-bash",children:[(0,l.jsx)(n.code,{children:"hauler completion bash"}),":"]}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:["Generate the autocompletion script for the bash shell.","\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"Note:"})," This script depends on the 'bash-completion' package."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion bash)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion bash > /etc/bash_completion.d/hauler\n\n#### macOS:\n\n hauler completion bash > $(brew --prefix)/etc/bash_completion.d/hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion bash\n\nFlags:\n -h, --help help for bash\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,l.jsxs)(n.h4,{id:"hauler-completion-fish",children:[(0,l.jsx)(n.code,{children:"hauler completion fish"}),":"]}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"Generate the autocompletion script for the fish shell."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion fish | source\n\nTo load completions for every new session, execute once:\n\n hauler completion fish > ~/.config/fish/completions/hauler.fish\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion fish [flags]\n\nFlags:\n -h, --help help for fish\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,l.jsxs)(n.h4,{id:"hauler-completion-powershell",children:[(0,l.jsx)(n.code,{children:"hauler completion powershell"}),":"]}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"Generate the autocompletion script for powershell."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion powershell | Out-String | Invoke-Expression\n\nTo load completions for every new session, add the output of the above command\nto your powershell profile.\n\nUsage:\n hauler completion powershell [flags]\n\nFlags:\n -h, --help help for powershell\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,l.jsxs)(n.h4,{id:"hauler-completion-zsh",children:[(0,l.jsx)(n.code,{children:"hauler completion zsh"}),":"]}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:["Generate the autocompletion script for the zsh shell.","\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"Note:"})," If shell completion is not already enabled in your environment you will need to enable it."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion zsh)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion zsh > "${fpath[1]}/_hauler"\n\n#### macOS:\n\n hauler completion zsh > $(brew --prefix)/share/zsh/site-functions/_hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion zsh [flags]\n\nFlags:\n -h, --help help for zsh\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n'})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(h,{...e})}):h(e)}},8453:(e,n,o)=>{o.d(n,{R:()=>i,x:()=>t});var l=o(6540);const s={},r=l.createContext(s);function i(e){const n=l.useContext(r);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),l.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a7b40412.6138c7d9.js b/assets/js/a7b40412.6138c7d9.js new file mode 100644 index 000000000..7625495c0 --- /dev/null +++ b/assets/js/a7b40412.6138c7d9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5284],{3566:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"0.4.0","label":"0.4.0","banner":"unmaintained","badge":true,"noIndex":false,"className":"docs-version-0.4.0","isLast":false,"docsSidebars":{"haulerSidebar":[{"type":"link","label":"Introduction","href":"/docs/0.4.0/intro","docId":"intro","unlisted":false},{"type":"link","label":"Core Concepts","href":"/docs/0.4.0/core-concepts","docId":"core-concepts","unlisted":false},{"type":"link","label":"Airgap Workflow","href":"/docs/0.4.0/airgap-workflow","docId":"airgap-workflow","unlisted":false},{"type":"category","label":"Introduction","description":"Introduction Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Quickstart","href":"/docs/0.4.0/introduction/quickstart","docId":"introduction/quickstart","unlisted":false},{"type":"link","label":"Installation","href":"/docs/0.4.0/introduction/install","docId":"introduction/install","unlisted":false},{"type":"link","label":"Uninstall","href":"/docs/0.4.0/introduction/uninstall","docId":"introduction/uninstall","unlisted":false}],"collapsible":true},{"type":"category","label":"Guides & References","description":"Guides and References Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Overview","href":"/docs/0.4.0/guides-references/overview","docId":"guides-references/overview","unlisted":false},{"type":"link","label":"Fetch Cluster Images","href":"/docs/0.4.0/guides-references/cluster-images","docId":"guides-references/cluster-images","unlisted":false},{"type":"category","label":"Hauler Collections","description":"Guides and References for Hauler Collections","items":[{"type":"link","label":"Overview","href":"/docs/0.4.0/guides-references/hauler-collections/overview","docId":"guides-references/hauler-collections/overview","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Hauler Content","description":"Guides and References for Hauler Content Types","items":[{"type":"link","label":"Overview","href":"/docs/0.4.0/guides-references/hauler-content/overview","docId":"guides-references/hauler-content/overview","unlisted":false},{"type":"link","label":"Images","href":"/docs/0.4.0/guides-references/hauler-content/images","docId":"guides-references/hauler-content/images","unlisted":false},{"type":"link","label":"Charts","href":"/docs/0.4.0/guides-references/hauler-content/charts","docId":"guides-references/hauler-content/charts","unlisted":false},{"type":"link","label":"Files","href":"/docs/0.4.0/guides-references/hauler-content/files","docId":"guides-references/hauler-content/files","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Command Line Interface","description":"Guides and References for the Hauler Command Line","items":[{"type":"link","label":"Hauler","href":"/docs/0.4.0/guides-references/command-line/hauler","docId":"guides-references/command-line/hauler","unlisted":false},{"type":"link","label":"Hauler Store","href":"/docs/0.4.0/guides-references/command-line/hauler-store","docId":"guides-references/command-line/hauler-store","unlisted":false},{"type":"link","label":"Hauler Completion","href":"/docs/0.4.0/guides-references/command-line/hauler-completion","docId":"guides-references/command-line/hauler-completion","unlisted":false},{"type":"link","label":"Hauler Version","href":"/docs/0.4.0/guides-references/command-line/hauler-version","docId":"guides-references/command-line/hauler-version","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true},{"type":"link","label":"Known Issues/Limits","href":"/docs/0.4.0/known-limits","docId":"known-limits","unlisted":false}]},"docs":{"airgap-workflow":{"id":"airgap-workflow","title":"Airgap Workflow","description":"Airgap Workflow Documentation for Hauler","sidebar":"haulerSidebar"},"core-concepts":{"id":"core-concepts","title":"Core Concepts","description":"Core Concepts Documentation for Hauler","sidebar":"haulerSidebar"},"guides-references/cluster-images":{"id":"guides-references/cluster-images","title":"Fetching Cluster Images","description":"Fetching Images on a Cluster Documentation","sidebar":"haulerSidebar"},"guides-references/command-line/hauler":{"id":"guides-references/command-line/hauler","title":"Hauler (Command)","description":"Hauler CLI Reference for hauler","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-completion":{"id":"guides-references/command-line/hauler-completion","title":"Hauler Completion (Command)","description":"Hauler CLI Reference for hauler completion","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-store":{"id":"guides-references/command-line/hauler-store","title":"Hauler Store (Command)","description":"Hauler CLI Reference for hauler store","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-version":{"id":"guides-references/command-line/hauler-version","title":"Hauler Version (Command)","description":"Hauler CLI Reference for hauler version","sidebar":"haulerSidebar"},"guides-references/hauler-collections/overview":{"id":"guides-references/hauler-collections/overview","title":"Overview of Hauler Collections","description":"Hauler Collections Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/charts":{"id":"guides-references/hauler-content/charts","title":"Charts (Content Type)","description":"Hauler \\"Charts\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/files":{"id":"guides-references/hauler-content/files","title":"Files (Content Type)","description":"Hauler \\"Files\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/images":{"id":"guides-references/hauler-content/images","title":"Images (Content Type)","description":"Hauler \\"Images\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/overview":{"id":"guides-references/hauler-content/overview","title":"Overview of Hauler Content","description":"Hauler Content Documentation","sidebar":"haulerSidebar"},"guides-references/overview":{"id":"guides-references/overview","title":"Overview","description":"Reference Guides Overview Documentation for Hauler","sidebar":"haulerSidebar"},"intro":{"id":"intro","title":"Introduction","description":"Introduction to Rancher Government Hauler","sidebar":"haulerSidebar"},"introduction/install":{"id":"introduction/install","title":"Installation","description":"Installation Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/quickstart":{"id":"introduction/quickstart","title":"Quickstart","description":"Quickstart Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/uninstall":{"id":"introduction/uninstall","title":"Uninstall","description":"Uninstall Documentation for Hauler","sidebar":"haulerSidebar"},"known-limits":{"id":"known-limits","title":"Known Issues and Limits","description":"Known Issues and Limitations for Hauler","sidebar":"haulerSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/a7d2e20e.694edafc.js b/assets/js/a7d2e20e.694edafc.js deleted file mode 100644 index 71a259eaa..000000000 --- a/assets/js/a7d2e20e.694edafc.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3497],{2150:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>u});var r=n(4848),o=n(8453);const i={title:"Overview of Hauler Content",description:"Hauler Content Documentation",sidebar_label:"Overview"},s=void 0,c={id:"guides-references/hauler-content/overview",title:"Overview of Hauler Content",description:"Hauler Content Documentation",source:"@site/versioned_docs/version-0.4.0/guides-references/hauler-content/overview.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/overview",permalink:"/hauler-docs/docs/0.4.0/guides-references/hauler-content/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.0/guides-references/hauler-content/overview.md",tags:[],version:"0.4.0",frontMatter:{title:"Overview of Hauler Content",description:"Hauler Content Documentation",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/hauler-docs/docs/0.4.0/guides-references/hauler-collections/overview"},next:{title:"Images",permalink:"/hauler-docs/docs/0.4.0/guides-references/hauler-content/images"}},a={},u=[];function l(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,r.jsx)(t.p,{children:"Hauler Content Overview Documentation pending a future release!"})}function d(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>c});var r=n(6540);const o={},i=r.createContext(o);function s(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a7d2e20e.cf8e63af.js b/assets/js/a7d2e20e.cf8e63af.js new file mode 100644 index 000000000..5aae35135 --- /dev/null +++ b/assets/js/a7d2e20e.cf8e63af.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3497],{2150:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>a});var r=n(4848),o=n(8453);const i={title:"Overview of Hauler Content",description:"Hauler Content Documentation",sidebar_label:"Overview"},s=void 0,c={id:"guides-references/hauler-content/overview",title:"Overview of Hauler Content",description:"Hauler Content Documentation",source:"@site/versioned_docs/version-0.4.0/guides-references/hauler-content/overview.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/overview",permalink:"/docs/0.4.0/guides-references/hauler-content/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.0/guides-references/hauler-content/overview.md",tags:[],version:"0.4.0",frontMatter:{title:"Overview of Hauler Content",description:"Hauler Content Documentation",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/docs/0.4.0/guides-references/hauler-collections/overview"},next:{title:"Images",permalink:"/docs/0.4.0/guides-references/hauler-content/images"}},u={},a=[];function l(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,r.jsx)(t.p,{children:"Hauler Content Overview Documentation pending a future release!"})}function d(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>c});var r=n(6540);const o={},i=r.createContext(o);function s(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a90ac227.33f0a9e3.js b/assets/js/a90ac227.33f0a9e3.js deleted file mode 100644 index eb2ed6dec..000000000 --- a/assets/js/a90ac227.33f0a9e3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7426],{3020:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>a,contentTitle:()=>i,default:()=>u,frontMatter:()=>n,metadata:()=>c,toc:()=>d});var s=t(4848),o=t(8453);const n={title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",sidebar_label:"RGS Carbide Customers"},i=void 0,c={id:"guides-references/carbide-customers",title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",source:"@site/versioned_docs/version-1.0.0/guides-references/carbide-customers.md",sourceDirName:"guides-references",slug:"/guides-references/carbide-customers",permalink:"/hauler-docs/docs/1.0.0/guides-references/carbide-customers",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.0/guides-references/carbide-customers.md",tags:[],version:"1.0.0",frontMatter:{title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",sidebar_label:"RGS Carbide Customers"},sidebar:"haulerSidebar",previous:{title:"Fetch Cluster Images",permalink:"/hauler-docs/docs/1.0.0/guides-references/cluster-images"},next:{title:"Community Collections",permalink:"/hauler-docs/docs/1.0.0/guides-references/hauler-collections/community-collections"}},a={},d=[];function l(e){const r={a:"a",code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(r.p,{children:["For all supported customers of Rancher Government Solutions, under the umbrella of Rancher Government Carbide, there is addon functionality within ",(0,s.jsx)(r.code,{children:"Hauler"}),"."]}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"Hauler"})," has the the ability to reference ",(0,s.jsx)(r.code,{children:"Collections"})," from the Carbide Secured Registry (CSR). ",(0,s.jsx)(r.code,{children:"Hauler"})," is built to allow operators to fetch, store, package, and distribute content and collections, but most operators may be unsure of what to fetch, store, package, and distribue and that is where our supported customers are able to leverage these pre-defined manifests for all of the Rancher products. Below are some of the available ",(0,s.jsx)(r.code,{children:"product"})," flags."]}),"\n",(0,s.jsxs)(r.p,{children:["Please see the ",(0,s.jsx)(r.strong,{children:(0,s.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/intro",children:"Carbide Documentation"})})," for easily fetching, packing, and distributing Carbide with the ",(0,s.jsx)(r.code,{children:"hauler store sync --products ="}),". Please know that we are actively working to improve this workflow."]}),"\n",(0,s.jsxs)(r.ul,{children:["\n",(0,s.jsx)(r.li,{children:(0,s.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/registry-docs/copying-images",children:"Connected Environments"})}),"\n",(0,s.jsx)(r.li,{children:(0,s.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/registry-docs/downloading-images",children:"Disconnected Environments"})}),"\n"]})]})}function u(e={}){const{wrapper:r}={...(0,o.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>i,x:()=>c});var s=t(6540);const o={},n=s.createContext(o);function i(e){const r=s.useContext(n);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),s.createElement(n.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a90ac227.d428ebd1.js b/assets/js/a90ac227.d428ebd1.js new file mode 100644 index 000000000..8bfd4faf9 --- /dev/null +++ b/assets/js/a90ac227.d428ebd1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7426],{3020:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>d,contentTitle:()=>i,default:()=>u,frontMatter:()=>n,metadata:()=>c,toc:()=>a});var s=t(4848),o=t(8453);const n={title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",sidebar_label:"RGS Carbide Customers"},i=void 0,c={id:"guides-references/carbide-customers",title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",source:"@site/versioned_docs/version-1.0.0/guides-references/carbide-customers.md",sourceDirName:"guides-references",slug:"/guides-references/carbide-customers",permalink:"/docs/1.0.0/guides-references/carbide-customers",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.0/guides-references/carbide-customers.md",tags:[],version:"1.0.0",frontMatter:{title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",sidebar_label:"RGS Carbide Customers"},sidebar:"haulerSidebar",previous:{title:"Fetch Cluster Images",permalink:"/docs/1.0.0/guides-references/cluster-images"},next:{title:"Community Collections",permalink:"/docs/1.0.0/guides-references/hauler-collections/community-collections"}},d={},a=[];function l(e){const r={a:"a",code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(r.p,{children:["For all supported customers of Rancher Government Solutions, under the umbrella of Rancher Government Carbide, there is addon functionality within ",(0,s.jsx)(r.code,{children:"Hauler"}),"."]}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.code,{children:"Hauler"})," has the the ability to reference ",(0,s.jsx)(r.code,{children:"Collections"})," from the Carbide Secured Registry (CSR). ",(0,s.jsx)(r.code,{children:"Hauler"})," is built to allow operators to fetch, store, package, and distribute content and collections, but most operators may be unsure of what to fetch, store, package, and distribue and that is where our supported customers are able to leverage these pre-defined manifests for all of the Rancher products. Below are some of the available ",(0,s.jsx)(r.code,{children:"product"})," flags."]}),"\n",(0,s.jsxs)(r.p,{children:["Please see the ",(0,s.jsx)(r.strong,{children:(0,s.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/intro",children:"Carbide Documentation"})})," for easily fetching, packing, and distributing Carbide with the ",(0,s.jsx)(r.code,{children:"hauler store sync --products ="}),". Please know that we are actively working to improve this workflow."]}),"\n",(0,s.jsxs)(r.ul,{children:["\n",(0,s.jsx)(r.li,{children:(0,s.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/registry-docs/copying-images",children:"Connected Environments"})}),"\n",(0,s.jsx)(r.li,{children:(0,s.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/registry-docs/downloading-images",children:"Disconnected Environments"})}),"\n"]})]})}function u(e={}){const{wrapper:r}={...(0,o.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>i,x:()=>c});var s=t(6540);const o={},n=s.createContext(o);function i(e){const r=s.useContext(n);return s.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),s.createElement(n.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/abf93448.65eb12e2.js b/assets/js/abf93448.65eb12e2.js new file mode 100644 index 000000000..ef8085d81 --- /dev/null +++ b/assets/js/abf93448.65eb12e2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2700],{5151:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>h,frontMatter:()=>a,metadata:()=>l,toc:()=>i});var r=t(4848),o=t(8453);const a={title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},s=void 0,l={id:"guides-references/command-line/hauler-store",title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",source:"@site/versioned_docs/version-0.4.2/guides-references/command-line/hauler-store.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-store",permalink:"/docs/0.4.2/guides-references/command-line/hauler-store",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.2/guides-references/command-line/hauler-store.md",tags:[],version:"0.4.2",frontMatter:{title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},sidebar:"haulerSidebar",previous:{title:"Hauler",permalink:"/docs/0.4.2/guides-references/command-line/hauler"},next:{title:"Hauler Completion",permalink:"/docs/0.4.2/guides-references/command-line/hauler-completion"}},c={},i=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler store add:",id:"hauler-store-add",level:4},{value:"hauler store copy:",id:"hauler-store-copy",level:4},{value:"hauler store extract:",id:"hauler-store-extract",level:4},{value:"hauler store info:",id:"hauler-store-info",level:4},{value:"hauler store load:",id:"hauler-store-load",level:4},{value:"hauler store save:",id:"hauler-store-save",level:4},{value:"hauler store serve:",id:"hauler-store-serve",level:4},{value:"hauler store sync:",id:"hauler-store-sync",level:4}];function d(e){const n={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",ul:"ul",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Interact with Hauler's embedded content store."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store [flags]\n hauler store [command]\n\nAliases:\n store, s\n\nAvailable Commands:\n add Add content to store\n copy Copy all store contents to another OCI registry\n extract Extract content from the store to disk\n info Print out information about the store\n load Load a content store from a store archive\n save Save a content store to a store archive\n serve Expose the content of a local store through an OCI compliant server\n sync Sync content to the embedded content store\n\nFlags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -h, --help help for store\n -s, --store string Location to create store at (default "store")\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler store [command] --help" for more information about a command.\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-add",children:[(0,r.jsx)(n.code,{children:"hauler store add"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Add content to store."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store add [flags]\n hauler store add [command]\n\nAvailable Commands:\n chart Add a local or remote chart to the content store\n file Add a file to the content store\n image Add an image to the content store\n\nFlags:\n -h, --help help for add\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n\nUse "hauler store add [command] --help" for more information about a command.\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-copy",children:[(0,r.jsx)(n.code,{children:"hauler store copy"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Copy all store contents to another OCI registry."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store copy [flags]\n\nFlags:\n -h, --help help for copy\n --insecure Toggle allowing insecure connections when copying to a remote registry\n -p, --password string Password when copying to an authenticated remote registry\n --plain-http Toggle allowing plain http connections when copying to a remote registry\n -u, --username string Username when copying to an authenticated remote registry\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")h\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-extract",children:[(0,r.jsx)(n.code,{children:"hauler store extract"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Extract content from the store to disk."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store extract [flags]\n\nAliases:\n extract, x\n\nFlags:\n -h, --help help for extract\n -o, --output string Directory to save contents to (defaults to current directory)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-info",children:[(0,r.jsx)(n.code,{children:"hauler store info"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Print out information about the store."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store info [flags]\n\nAliases:\n info, i, list, ls\n\nFlags:\n -h, --help help for info\n -o, --output string Output format (table, json) (default "table")\n -t, --type string Filter on type (image, chart, file) (default "all")\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-load",children:[(0,r.jsx)(n.code,{children:"hauler store load"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Load a content store from a store archive."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store load [flags]\n\nFlags:\n -h, --help help for load\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-save",children:[(0,r.jsx)(n.code,{children:"hauler store save"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Save a content store to a store archive."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store save [flags]\n\nFlags:\n -f, --filename string Name of archive (default "pkg.tar.zst")\n -h, --help help for save\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-serve",children:[(0,r.jsx)(n.code,{children:"hauler store serve"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Expose the content of a local store through an OCI compliant server."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store serve [flags]\n\nFlags:\n -c, --config string Path to a config file, will override all other configs\n -d, --daemon Toggle serving as a daemon\n --directory string Directory to use for registry backend (defaults to \'$PWD/registry\') (default "registry")\n -h, --help help for serve\n -p, --port int Port to listen on (default 5000)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-sync",children:[(0,r.jsx)(n.code,{children:"hauler store sync"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Sync content to the embedded content store."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store sync [flags]\n\nFlags:\n -f, --files strings Path to content files\n -h, --help help for sync\n -k, --key string (Optional) Path to the key for signature verification\n --products strings Used for RGS Carbide customers to supply a product and version and Hauler will retrieve the images. i.e. \'--product rancher=v2.7.6\'\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")h\n'})})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>l});var r=t(6540);const o={},a=r.createContext(o);function s(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/abf93448.eb7b5cba.js b/assets/js/abf93448.eb7b5cba.js deleted file mode 100644 index 8374f936c..000000000 --- a/assets/js/abf93448.eb7b5cba.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2700],{5151:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>h,frontMatter:()=>a,metadata:()=>l,toc:()=>i});var r=t(4848),o=t(8453);const a={title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},s=void 0,l={id:"guides-references/command-line/hauler-store",title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",source:"@site/versioned_docs/version-0.4.2/guides-references/command-line/hauler-store.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-store",permalink:"/hauler-docs/docs/0.4.2/guides-references/command-line/hauler-store",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.2/guides-references/command-line/hauler-store.md",tags:[],version:"0.4.2",frontMatter:{title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},sidebar:"haulerSidebar",previous:{title:"Hauler",permalink:"/hauler-docs/docs/0.4.2/guides-references/command-line/hauler"},next:{title:"Hauler Completion",permalink:"/hauler-docs/docs/0.4.2/guides-references/command-line/hauler-completion"}},c={},i=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler store add:",id:"hauler-store-add",level:4},{value:"hauler store copy:",id:"hauler-store-copy",level:4},{value:"hauler store extract:",id:"hauler-store-extract",level:4},{value:"hauler store info:",id:"hauler-store-info",level:4},{value:"hauler store load:",id:"hauler-store-load",level:4},{value:"hauler store save:",id:"hauler-store-save",level:4},{value:"hauler store serve:",id:"hauler-store-serve",level:4},{value:"hauler store sync:",id:"hauler-store-sync",level:4}];function d(e){const n={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",ul:"ul",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Interact with Hauler's embedded content store."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store [flags]\n hauler store [command]\n\nAliases:\n store, s\n\nAvailable Commands:\n add Add content to store\n copy Copy all store contents to another OCI registry\n extract Extract content from the store to disk\n info Print out information about the store\n load Load a content store from a store archive\n save Save a content store to a store archive\n serve Expose the content of a local store through an OCI compliant server\n sync Sync content to the embedded content store\n\nFlags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -h, --help help for store\n -s, --store string Location to create store at (default "store")\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler store [command] --help" for more information about a command.\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-add",children:[(0,r.jsx)(n.code,{children:"hauler store add"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Add content to store."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store add [flags]\n hauler store add [command]\n\nAvailable Commands:\n chart Add a local or remote chart to the content store\n file Add a file to the content store\n image Add an image to the content store\n\nFlags:\n -h, --help help for add\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n\nUse "hauler store add [command] --help" for more information about a command.\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-copy",children:[(0,r.jsx)(n.code,{children:"hauler store copy"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Copy all store contents to another OCI registry."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store copy [flags]\n\nFlags:\n -h, --help help for copy\n --insecure Toggle allowing insecure connections when copying to a remote registry\n -p, --password string Password when copying to an authenticated remote registry\n --plain-http Toggle allowing plain http connections when copying to a remote registry\n -u, --username string Username when copying to an authenticated remote registry\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")h\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-extract",children:[(0,r.jsx)(n.code,{children:"hauler store extract"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Extract content from the store to disk."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store extract [flags]\n\nAliases:\n extract, x\n\nFlags:\n -h, --help help for extract\n -o, --output string Directory to save contents to (defaults to current directory)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-info",children:[(0,r.jsx)(n.code,{children:"hauler store info"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Print out information about the store."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store info [flags]\n\nAliases:\n info, i, list, ls\n\nFlags:\n -h, --help help for info\n -o, --output string Output format (table, json) (default "table")\n -t, --type string Filter on type (image, chart, file) (default "all")\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-load",children:[(0,r.jsx)(n.code,{children:"hauler store load"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Load a content store from a store archive."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store load [flags]\n\nFlags:\n -h, --help help for load\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-save",children:[(0,r.jsx)(n.code,{children:"hauler store save"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Save a content store to a store archive."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store save [flags]\n\nFlags:\n -f, --filename string Name of archive (default "pkg.tar.zst")\n -h, --help help for save\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-serve",children:[(0,r.jsx)(n.code,{children:"hauler store serve"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Expose the content of a local store through an OCI compliant server."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store serve [flags]\n\nFlags:\n -c, --config string Path to a config file, will override all other configs\n -d, --daemon Toggle serving as a daemon\n --directory string Directory to use for registry backend (defaults to \'$PWD/registry\') (default "registry")\n -h, --help help for serve\n -p, --port int Port to listen on (default 5000)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-sync",children:[(0,r.jsx)(n.code,{children:"hauler store sync"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Sync content to the embedded content store."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store sync [flags]\n\nFlags:\n -f, --files strings Path to content files\n -h, --help help for sync\n -k, --key string (Optional) Path to the key for signature verification\n --products strings Used for RGS Carbide customers to supply a product and version and Hauler will retrieve the images. i.e. \'--product rancher=v2.7.6\'\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")h\n'})})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>l});var r=t(6540);const o={},a=r.createContext(o);function s(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/aee14194.75504026.js b/assets/js/aee14194.75504026.js new file mode 100644 index 000000000..e695d75c9 --- /dev/null +++ b/assets/js/aee14194.75504026.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1909],{5231:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>a,contentTitle:()=>l,default:()=>d,frontMatter:()=>n,metadata:()=>o,toc:()=>u});var i=s(4848),t=s(8453);const n={title:"Hauler Fileserver",description:"Hauler Fileserver Documentation",sidebar_label:"Hauler Fileserver"},l=void 0,o={id:"guides-references/utilities/fileserver",title:"Hauler Fileserver",description:"Hauler Fileserver Documentation",source:"@site/docs/guides-references/utilities/fileserver.md",sourceDirName:"guides-references/utilities",slug:"/guides-references/utilities/fileserver",permalink:"/docs/next/guides-references/utilities/fileserver",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/docs/guides-references/utilities/fileserver.md",tags:[],version:"current",frontMatter:{title:"Hauler Fileserver",description:"Hauler Fileserver Documentation",sidebar_label:"Hauler Fileserver"},sidebar:"haulerSidebar",previous:{title:"Hauler Registry",permalink:"/docs/next/guides-references/utilities/registry"},next:{title:"Hauler Manifests",permalink:"/docs/next/guides-references/manifests"}},a={},u=[{value:"Overview",id:"overview",level:2},{value:"Example Commands for the Hauler Fileserver",id:"example-commands-for-the-hauler-fileserver",level:2}];function c(e){const r={code:"code",h2:"h2",p:"p",pre:"pre",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(r.h2,{id:"overview",children:"Overview"}),"\n",(0,i.jsx)(r.p,{children:"Hauler Fileserver docs are pending a future release!"}),"\n",(0,i.jsx)(r.h2,{id:"example-commands-for-the-hauler-fileserver",children:"Example Commands for the Hauler Fileserver"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-bash",children:"# serve fileserver\nhauler store serve fileserver\n\n# serve fileserver on specific port\nhauler store serve fileserver --port \n"})})]})}function d(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>l,x:()=>o});var i=s(6540);const t={},n=i.createContext(t);function l(e){const r=i.useContext(n);return i.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),i.createElement(n.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/aee14194.9400b1a7.js b/assets/js/aee14194.9400b1a7.js deleted file mode 100644 index 039df6f60..000000000 --- a/assets/js/aee14194.9400b1a7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1909],{5231:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>a,contentTitle:()=>l,default:()=>d,frontMatter:()=>n,metadata:()=>o,toc:()=>u});var i=s(4848),t=s(8453);const n={title:"Hauler Fileserver",description:"Hauler Fileserver Documentation",sidebar_label:"Hauler Fileserver"},l=void 0,o={id:"guides-references/utilities/fileserver",title:"Hauler Fileserver",description:"Hauler Fileserver Documentation",source:"@site/docs/guides-references/utilities/fileserver.md",sourceDirName:"guides-references/utilities",slug:"/guides-references/utilities/fileserver",permalink:"/hauler-docs/docs/next/guides-references/utilities/fileserver",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/docs/guides-references/utilities/fileserver.md",tags:[],version:"current",frontMatter:{title:"Hauler Fileserver",description:"Hauler Fileserver Documentation",sidebar_label:"Hauler Fileserver"},sidebar:"haulerSidebar",previous:{title:"Hauler Registry",permalink:"/hauler-docs/docs/next/guides-references/utilities/registry"},next:{title:"Hauler Manifests",permalink:"/hauler-docs/docs/next/guides-references/manifests"}},a={},u=[{value:"Overview",id:"overview",level:2},{value:"Example Commands for the Hauler Fileserver",id:"example-commands-for-the-hauler-fileserver",level:2}];function c(e){const r={code:"code",h2:"h2",p:"p",pre:"pre",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(r.h2,{id:"overview",children:"Overview"}),"\n",(0,i.jsx)(r.p,{children:"Hauler Fileserver docs are pending a future release!"}),"\n",(0,i.jsx)(r.h2,{id:"example-commands-for-the-hauler-fileserver",children:"Example Commands for the Hauler Fileserver"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-bash",children:"# serve fileserver\nhauler store serve fileserver\n\n# serve fileserver on specific port\nhauler store serve fileserver --port \n"})})]})}function d(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,r,s)=>{s.d(r,{R:()=>l,x:()=>o});var i=s(6540);const t={},n=i.createContext(t);function l(e){const r=i.useContext(n);return i.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),i.createElement(n.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/af1b3cb5.38719a6a.js b/assets/js/af1b3cb5.38719a6a.js deleted file mode 100644 index 483f2c36d..000000000 --- a/assets/js/af1b3cb5.38719a6a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[6078],{7047:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var o=t(4848),r=t(8453);const i={title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},c=void 0,s={id:"core-concepts",title:"Core Concepts",description:"Core Concepts Documentation for Hauler",source:"@site/versioned_docs/version-0.4.2/core-concepts.md",sourceDirName:".",slug:"/core-concepts",permalink:"/hauler-docs/docs/0.4.2/core-concepts",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.2/core-concepts.md",tags:[],version:"0.4.2",frontMatter:{title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},sidebar:"haulerSidebar",previous:{title:"Introduction",permalink:"/hauler-docs/docs/0.4.2/intro"},next:{title:"Airgap Workflow",permalink:"/hauler-docs/docs/0.4.2/airgap-workflow"}},a={},l=[{value:"Haul",id:"haul",level:2},{value:"Collections",id:"collections",level:2},{value:"Community Collections",id:"community-collections",level:3},{value:"RGS Carbide Collections",id:"rgs-carbide-collections",level:3},{value:"Content",id:"content",level:2},{value:"Declarative Content",id:"declarative-content",level:3}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",ul:"ul",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"hauler-diagram",src:t(6178).A+"",width:"1949",height:"988"})}),"\n",(0,o.jsx)(n.h2,{id:"haul",children:"Haul"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauls"})," are Compressed Archive (Tarball) of Hauler Collections and Content."]})}),"\n",(0,o.jsxs)(n.p,{children:["At the heart of Hauler lies the concept of a ",(0,o.jsx)(n.code,{children:"Haul"}),". A ",(0,o.jsx)(n.code,{children:"Haul"})," is a compressed archive, often in the form of a tarball, containing Hauler collections and content. It serves as a container for grouping and transporting various data types, making it a fundamental element in the Hauler ecosystem."]}),"\n",(0,o.jsx)(n.h2,{id:"collections",children:"Collections"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are Grouping of one or more Hauler Contents."]})}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are the building blocks of Hauler. These are groupings of one or more Hauler ",(0,o.jsx)(n.code,{children:"contents"}),". Think of ",(0,o.jsx)(n.code,{children:"collections"})," as organized sets of data that collectively represent something desirable."]}),"\n",(0,o.jsx)(n.h3,{id:"community-collections",children:"Community Collections"}),"\n",(0,o.jsxs)(n.p,{children:["While ",(0,o.jsx)(n.code,{children:"collections"})," (and ",(0,o.jsx)(n.code,{children:"contents"}),") are built into Hauler, our goal is to empower users to define their own ",(0,o.jsx)(n.code,{children:"collections"}),". This way, you can tailor Hauler to your unique requirements and take full control of your artifacts."]}),"\n",(0,o.jsx)(n.h3,{id:"rgs-carbide-collections",children:"RGS Carbide Collections"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauler"})," provides the ability to import ",(0,o.jsx)(n.code,{children:"collections"})," for the Rancher products, making it seamless for RGS Supported Customers to airgap any of the Rancher products or projects. If you haven't heard of Rancher Government Carbide, check it out ",(0,o.jsx)(n.a,{href:"https://ranchergovernment.com/carbide",children:"here"}),"!"]}),"\n",(0,o.jsx)(n.h2,{id:"content",children:"Content"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Contents"})," are Artifacts such as Images, Charts, or Files."]})}),"\n",(0,o.jsxs)(n.p,{children:["In Hauler's terminology, ",(0,o.jsx)(n.code,{children:"content"})," refers to artifacts such as images, charts, or files. These are the fundamental types of resources that Hauler understands and manages. To understand the term better, let's break it down:"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Content"}),": The fundamental type of artifacts that Hauler recognizes (images, charts, and files)."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Artifact"}),": Anything that can be represented as an OCI (Open Container Initiative) artifact.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"OCI Artifacts provide a standardized way to store arbitrary files, making it easier to manage content efficiently."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"declarative-content",children:"Declarative Content"}),"\n",(0,o.jsxs)(n.p,{children:["While manually adding content to ",(0,o.jsx)(n.code,{children:"Hauler"})," is a straightforward way to get started, we recommend a much more sustainable approach. ",(0,o.jsx)(n.code,{children:"Hauler"})," provides a declarative approach for each ",(0,o.jsx)(n.code,{children:"content"})," type, allowing you to define all the ",(0,o.jsx)(n.code,{children:"content"})," within a manifest. This approach ensures a more reproducable workflow for managing the lifecycle of your ",(0,o.jsx)(n.code,{children:"hauls"}),"."]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},6178:(e,n,t)=>{t.d(n,{A:()=>o});const o=t.p+"assets/images/hauler-diagram-53f9182c0d98fe871fb3cf7fe8cd475a.png"},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>s});var o=t(6540);const r={},i=o.createContext(r);function c(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/af1b3cb5.e015b464.js b/assets/js/af1b3cb5.e015b464.js new file mode 100644 index 000000000..2ac75a132 --- /dev/null +++ b/assets/js/af1b3cb5.e015b464.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[6078],{7047:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var o=t(4848),r=t(8453);const i={title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},s=void 0,c={id:"core-concepts",title:"Core Concepts",description:"Core Concepts Documentation for Hauler",source:"@site/versioned_docs/version-0.4.2/core-concepts.md",sourceDirName:".",slug:"/core-concepts",permalink:"/docs/0.4.2/core-concepts",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.2/core-concepts.md",tags:[],version:"0.4.2",frontMatter:{title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},sidebar:"haulerSidebar",previous:{title:"Introduction",permalink:"/docs/0.4.2/intro"},next:{title:"Airgap Workflow",permalink:"/docs/0.4.2/airgap-workflow"}},a={},l=[{value:"Haul",id:"haul",level:2},{value:"Collections",id:"collections",level:2},{value:"Community Collections",id:"community-collections",level:3},{value:"RGS Carbide Collections",id:"rgs-carbide-collections",level:3},{value:"Content",id:"content",level:2},{value:"Declarative Content",id:"declarative-content",level:3}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",ul:"ul",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"hauler-diagram",src:t(6178).A+"",width:"1949",height:"988"})}),"\n",(0,o.jsx)(n.h2,{id:"haul",children:"Haul"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauls"})," are Compressed Archive (Tarball) of Hauler Collections and Content."]})}),"\n",(0,o.jsxs)(n.p,{children:["At the heart of Hauler lies the concept of a ",(0,o.jsx)(n.code,{children:"Haul"}),". A ",(0,o.jsx)(n.code,{children:"Haul"})," is a compressed archive, often in the form of a tarball, containing Hauler collections and content. It serves as a container for grouping and transporting various data types, making it a fundamental element in the Hauler ecosystem."]}),"\n",(0,o.jsx)(n.h2,{id:"collections",children:"Collections"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are Grouping of one or more Hauler Contents."]})}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are the building blocks of Hauler. These are groupings of one or more Hauler ",(0,o.jsx)(n.code,{children:"contents"}),". Think of ",(0,o.jsx)(n.code,{children:"collections"})," as organized sets of data that collectively represent something desirable."]}),"\n",(0,o.jsx)(n.h3,{id:"community-collections",children:"Community Collections"}),"\n",(0,o.jsxs)(n.p,{children:["While ",(0,o.jsx)(n.code,{children:"collections"})," (and ",(0,o.jsx)(n.code,{children:"contents"}),") are built into Hauler, our goal is to empower users to define their own ",(0,o.jsx)(n.code,{children:"collections"}),". This way, you can tailor Hauler to your unique requirements and take full control of your artifacts."]}),"\n",(0,o.jsx)(n.h3,{id:"rgs-carbide-collections",children:"RGS Carbide Collections"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauler"})," provides the ability to import ",(0,o.jsx)(n.code,{children:"collections"})," for the Rancher products, making it seamless for RGS Supported Customers to airgap any of the Rancher products or projects. If you haven't heard of Rancher Government Carbide, check it out ",(0,o.jsx)(n.a,{href:"https://ranchergovernment.com/carbide",children:"here"}),"!"]}),"\n",(0,o.jsx)(n.h2,{id:"content",children:"Content"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Contents"})," are Artifacts such as Images, Charts, or Files."]})}),"\n",(0,o.jsxs)(n.p,{children:["In Hauler's terminology, ",(0,o.jsx)(n.code,{children:"content"})," refers to artifacts such as images, charts, or files. These are the fundamental types of resources that Hauler understands and manages. To understand the term better, let's break it down:"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Content"}),": The fundamental type of artifacts that Hauler recognizes (images, charts, and files)."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Artifact"}),": Anything that can be represented as an OCI (Open Container Initiative) artifact.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"OCI Artifacts provide a standardized way to store arbitrary files, making it easier to manage content efficiently."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"declarative-content",children:"Declarative Content"}),"\n",(0,o.jsxs)(n.p,{children:["While manually adding content to ",(0,o.jsx)(n.code,{children:"Hauler"})," is a straightforward way to get started, we recommend a much more sustainable approach. ",(0,o.jsx)(n.code,{children:"Hauler"})," provides a declarative approach for each ",(0,o.jsx)(n.code,{children:"content"})," type, allowing you to define all the ",(0,o.jsx)(n.code,{children:"content"})," within a manifest. This approach ensures a more reproducable workflow for managing the lifecycle of your ",(0,o.jsx)(n.code,{children:"hauls"}),"."]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},6178:(e,n,t)=>{t.d(n,{A:()=>o});const o=t.p+"assets/images/hauler-diagram-53f9182c0d98fe871fb3cf7fe8cd475a.png"},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var o=t(6540);const r={},i=o.createContext(r);function s(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/af23d200.98a9f263.js b/assets/js/af23d200.98a9f263.js new file mode 100644 index 000000000..c70b3a089 --- /dev/null +++ b/assets/js/af23d200.98a9f263.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[913],{6151:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>l});var r=t(4848),s=t(8453);const i={title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},o="Rancher Government Hauler",a={id:"intro",title:"Introduction",description:"Introduction to Rancher Government Hauler",source:"@site/versioned_docs/version-0.4.1/intro.md",sourceDirName:".",slug:"/intro",permalink:"/docs/0.4.1/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.1/intro.md",tags:[],version:"0.4.1",frontMatter:{title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},sidebar:"haulerSidebar",next:{title:"Core Concepts",permalink:"/docs/0.4.1/core-concepts"}},c={},l=[{value:"What's Hauler?",id:"whats-hauler",level:2},{value:"Acknowledgements",id:"acknowledgements",level:2}];function d(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"rancher-government-hauler",children:"Rancher Government Hauler"}),"\n",(0,r.jsx)(n.h1,{id:"airgap-swiss-army-knife",children:"Airgap Swiss Army Knife"}),"\n",(0,r.jsxs)(n.admonition,{type:"caution",children:[(0,r.jsx)(n.p,{children:(0,r.jsxs)(n.strong,{children:["Note: Hauler and it's documentation are in active development and ",(0,r.jsx)(n.em,{children:"not Generally Available (GA)"}),"."]})}),(0,r.jsxs)(n.p,{children:["Most of the core functionality and features are ready for use, but may have breaking changes in future releases. Please help us by submitting any issues via ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler-docs/issues",children:"GitHub Issues"})})," and make sure to review the ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"/docs/known-limits",children:"Known Issues and Limitations"})}),"!"]})]}),"\n",(0,r.jsx)(n.h2,{id:"whats-hauler",children:"What's Hauler?"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Rancher Government Hauler"})," simplifies the airgap experience without requiring users to adopt a specific workflow. ",(0,r.jsx)(n.code,{children:"Hauler"})," simplifies the airgapping process, by representing assets (images, charts, files, etc...) as content and collections to allow users to easily fetch, store, package, and distribute these assets with declarative manifests or through the command line."]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Hauler"})," does this by storing contents and collections as OCI Artifacts and allows users to serve contents and collections with an embedded registry and fileserver. Additionally, ",(0,r.jsx)(n.code,{children:"Hauler"})," has the ability to store and inspect various non-image OCI Artifacts."]}),"\n",(0,r.jsx)(n.h2,{id:"acknowledgements",children:"Acknowledgements"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Hauler"})," wouldn't be possible without the open-source community, but there are a few projects that stand out:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/google/go-containerregistry",children:"go-containerregistry"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/oras-project/oras",children:"oras cli"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/sigstore/cosign",children:"cosign"})}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var r=t(6540);const s={},i=r.createContext(s);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/af23d200.c7c316bc.js b/assets/js/af23d200.c7c316bc.js deleted file mode 100644 index df449f8ce..000000000 --- a/assets/js/af23d200.c7c316bc.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[913],{6151:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>l});var r=t(4848),s=t(8453);const i={title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},o="Rancher Government Hauler",a={id:"intro",title:"Introduction",description:"Introduction to Rancher Government Hauler",source:"@site/versioned_docs/version-0.4.1/intro.md",sourceDirName:".",slug:"/intro",permalink:"/hauler-docs/docs/0.4.1/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.1/intro.md",tags:[],version:"0.4.1",frontMatter:{title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},sidebar:"haulerSidebar",next:{title:"Core Concepts",permalink:"/hauler-docs/docs/0.4.1/core-concepts"}},c={},l=[{value:"What's Hauler?",id:"whats-hauler",level:2},{value:"Acknowledgements",id:"acknowledgements",level:2}];function d(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"rancher-government-hauler",children:"Rancher Government Hauler"}),"\n",(0,r.jsx)(n.h1,{id:"airgap-swiss-army-knife",children:"Airgap Swiss Army Knife"}),"\n",(0,r.jsxs)(n.admonition,{type:"caution",children:[(0,r.jsx)(n.p,{children:(0,r.jsxs)(n.strong,{children:["Note: Hauler and it's documentation are in active development and ",(0,r.jsx)(n.em,{children:"not Generally Available (GA)"}),"."]})}),(0,r.jsxs)(n.p,{children:["Most of the core functionality and features are ready for use, but may have breaking changes in future releases. Please help us by submitting any issues via ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler-docs/issues",children:"GitHub Issues"})})," and make sure to review the ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"/docs/known-limits",children:"Known Issues and Limitations"})}),"!"]})]}),"\n",(0,r.jsx)(n.h2,{id:"whats-hauler",children:"What's Hauler?"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Rancher Government Hauler"})," simplifies the airgap experience without requiring users to adopt a specific workflow. ",(0,r.jsx)(n.code,{children:"Hauler"})," simplifies the airgapping process, by representing assets (images, charts, files, etc...) as content and collections to allow users to easily fetch, store, package, and distribute these assets with declarative manifests or through the command line."]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Hauler"})," does this by storing contents and collections as OCI Artifacts and allows users to serve contents and collections with an embedded registry and fileserver. Additionally, ",(0,r.jsx)(n.code,{children:"Hauler"})," has the ability to store and inspect various non-image OCI Artifacts."]}),"\n",(0,r.jsx)(n.h2,{id:"acknowledgements",children:"Acknowledgements"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Hauler"})," wouldn't be possible without the open-source community, but there are a few projects that stand out:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/google/go-containerregistry",children:"go-containerregistry"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/oras-project/oras",children:"oras cli"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/sigstore/cosign",children:"cosign"})}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var r=t(6540);const s={},i=r.createContext(s);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/af7bf720.1ee810cc.js b/assets/js/af7bf720.1ee810cc.js new file mode 100644 index 000000000..2f8c546db --- /dev/null +++ b/assets/js/af7bf720.1ee810cc.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7846],{5851:(e,r,o)=>{o.r(r),o.d(r,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>u});var t=o(4848),n=o(8453);const i={title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",sidebar_label:"Overview"},s=void 0,c={id:"guides-references/hauler-collections/overview",title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",source:"@site/versioned_docs/version-0.4.3/guides-references/hauler-collections/overview.md",sourceDirName:"guides-references/hauler-collections",slug:"/guides-references/hauler-collections/overview",permalink:"/docs/0.4.3/guides-references/hauler-collections/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.3/guides-references/hauler-collections/overview.md",tags:[],version:"0.4.3",frontMatter:{title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"RGS Carbide Customers",permalink:"/docs/0.4.3/guides-references/carbide-customers"},next:{title:"Overview",permalink:"/docs/0.4.3/guides-references/hauler-content/overview"}},l={},u=[];function a(e){const r={p:"p",...(0,n.R)(),...e.components};return(0,t.jsx)(r.p,{children:"Hauler Collections Overview Documentation pending a future release!"})}function d(e={}){const{wrapper:r}={...(0,n.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},8453:(e,r,o)=>{o.d(r,{R:()=>s,x:()=>c});var t=o(6540);const n={},i=t.createContext(n);function s(e){const r=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:s(e.components),t.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/af7bf720.fd9882c6.js b/assets/js/af7bf720.fd9882c6.js deleted file mode 100644 index 38228ada3..000000000 --- a/assets/js/af7bf720.fd9882c6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7846],{5851:(e,r,o)=>{o.r(r),o.d(r,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>s,metadata:()=>c,toc:()=>u});var t=o(4848),n=o(8453);const s={title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",sidebar_label:"Overview"},i=void 0,c={id:"guides-references/hauler-collections/overview",title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",source:"@site/versioned_docs/version-0.4.3/guides-references/hauler-collections/overview.md",sourceDirName:"guides-references/hauler-collections",slug:"/guides-references/hauler-collections/overview",permalink:"/hauler-docs/docs/0.4.3/guides-references/hauler-collections/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.3/guides-references/hauler-collections/overview.md",tags:[],version:"0.4.3",frontMatter:{title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"RGS Carbide Customers",permalink:"/hauler-docs/docs/0.4.3/guides-references/carbide-customers"},next:{title:"Overview",permalink:"/hauler-docs/docs/0.4.3/guides-references/hauler-content/overview"}},l={},u=[];function a(e){const r={p:"p",...(0,n.R)(),...e.components};return(0,t.jsx)(r.p,{children:"Hauler Collections Overview Documentation pending a future release!"})}function d(e={}){const{wrapper:r}={...(0,n.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},8453:(e,r,o)=>{o.d(r,{R:()=>i,x:()=>c});var t=o(6540);const n={},s=t.createContext(n);function i(e){const r=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),t.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/afb652b9.314e5499.js b/assets/js/afb652b9.314e5499.js deleted file mode 100644 index c79131f0d..000000000 --- a/assets/js/afb652b9.314e5499.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[688],{5396:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"0.4.0","label":"0.4.0","banner":"unmaintained","badge":true,"noIndex":false,"className":"docs-version-0.4.0","isLast":false,"docsSidebars":{"haulerSidebar":[{"type":"link","label":"Introduction","href":"/hauler-docs/docs/0.4.0/intro","docId":"intro","unlisted":false},{"type":"link","label":"Core Concepts","href":"/hauler-docs/docs/0.4.0/core-concepts","docId":"core-concepts","unlisted":false},{"type":"link","label":"Airgap Workflow","href":"/hauler-docs/docs/0.4.0/airgap-workflow","docId":"airgap-workflow","unlisted":false},{"type":"category","label":"Introduction","description":"Introduction Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Quickstart","href":"/hauler-docs/docs/0.4.0/introduction/quickstart","docId":"introduction/quickstart","unlisted":false},{"type":"link","label":"Installation","href":"/hauler-docs/docs/0.4.0/introduction/install","docId":"introduction/install","unlisted":false},{"type":"link","label":"Uninstall","href":"/hauler-docs/docs/0.4.0/introduction/uninstall","docId":"introduction/uninstall","unlisted":false}],"collapsible":true},{"type":"category","label":"Guides & References","description":"Guides and References Docs for Hauler","collapsed":false,"items":[{"type":"link","label":"Overview","href":"/hauler-docs/docs/0.4.0/guides-references/overview","docId":"guides-references/overview","unlisted":false},{"type":"link","label":"Fetch Cluster Images","href":"/hauler-docs/docs/0.4.0/guides-references/cluster-images","docId":"guides-references/cluster-images","unlisted":false},{"type":"category","label":"Hauler Collections","description":"Guides and References for Hauler Collections","items":[{"type":"link","label":"Overview","href":"/hauler-docs/docs/0.4.0/guides-references/hauler-collections/overview","docId":"guides-references/hauler-collections/overview","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Hauler Content","description":"Guides and References for Hauler Content Types","items":[{"type":"link","label":"Overview","href":"/hauler-docs/docs/0.4.0/guides-references/hauler-content/overview","docId":"guides-references/hauler-content/overview","unlisted":false},{"type":"link","label":"Images","href":"/hauler-docs/docs/0.4.0/guides-references/hauler-content/images","docId":"guides-references/hauler-content/images","unlisted":false},{"type":"link","label":"Charts","href":"/hauler-docs/docs/0.4.0/guides-references/hauler-content/charts","docId":"guides-references/hauler-content/charts","unlisted":false},{"type":"link","label":"Files","href":"/hauler-docs/docs/0.4.0/guides-references/hauler-content/files","docId":"guides-references/hauler-content/files","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Command Line Interface","description":"Guides and References for the Hauler Command Line","items":[{"type":"link","label":"Hauler","href":"/hauler-docs/docs/0.4.0/guides-references/command-line/hauler","docId":"guides-references/command-line/hauler","unlisted":false},{"type":"link","label":"Hauler Store","href":"/hauler-docs/docs/0.4.0/guides-references/command-line/hauler-store","docId":"guides-references/command-line/hauler-store","unlisted":false},{"type":"link","label":"Hauler Completion","href":"/hauler-docs/docs/0.4.0/guides-references/command-line/hauler-completion","docId":"guides-references/command-line/hauler-completion","unlisted":false},{"type":"link","label":"Hauler Version","href":"/hauler-docs/docs/0.4.0/guides-references/command-line/hauler-version","docId":"guides-references/command-line/hauler-version","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true},{"type":"link","label":"Known Issues/Limits","href":"/hauler-docs/docs/0.4.0/known-limits","docId":"known-limits","unlisted":false}]},"docs":{"airgap-workflow":{"id":"airgap-workflow","title":"Airgap Workflow","description":"Airgap Workflow Documentation for Hauler","sidebar":"haulerSidebar"},"core-concepts":{"id":"core-concepts","title":"Core Concepts","description":"Core Concepts Documentation for Hauler","sidebar":"haulerSidebar"},"guides-references/cluster-images":{"id":"guides-references/cluster-images","title":"Fetching Cluster Images","description":"Fetching Images on a Cluster Documentation","sidebar":"haulerSidebar"},"guides-references/command-line/hauler":{"id":"guides-references/command-line/hauler","title":"Hauler (Command)","description":"Hauler CLI Reference for hauler","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-completion":{"id":"guides-references/command-line/hauler-completion","title":"Hauler Completion (Command)","description":"Hauler CLI Reference for hauler completion","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-store":{"id":"guides-references/command-line/hauler-store","title":"Hauler Store (Command)","description":"Hauler CLI Reference for hauler store","sidebar":"haulerSidebar"},"guides-references/command-line/hauler-version":{"id":"guides-references/command-line/hauler-version","title":"Hauler Version (Command)","description":"Hauler CLI Reference for hauler version","sidebar":"haulerSidebar"},"guides-references/hauler-collections/overview":{"id":"guides-references/hauler-collections/overview","title":"Overview of Hauler Collections","description":"Hauler Collections Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/charts":{"id":"guides-references/hauler-content/charts","title":"Charts (Content Type)","description":"Hauler \\"Charts\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/files":{"id":"guides-references/hauler-content/files","title":"Files (Content Type)","description":"Hauler \\"Files\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/images":{"id":"guides-references/hauler-content/images","title":"Images (Content Type)","description":"Hauler \\"Images\\" Content Documentation","sidebar":"haulerSidebar"},"guides-references/hauler-content/overview":{"id":"guides-references/hauler-content/overview","title":"Overview of Hauler Content","description":"Hauler Content Documentation","sidebar":"haulerSidebar"},"guides-references/overview":{"id":"guides-references/overview","title":"Overview","description":"Reference Guides Overview Documentation for Hauler","sidebar":"haulerSidebar"},"intro":{"id":"intro","title":"Introduction","description":"Introduction to Rancher Government Hauler","sidebar":"haulerSidebar"},"introduction/install":{"id":"introduction/install","title":"Installation","description":"Installation Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/quickstart":{"id":"introduction/quickstart","title":"Quickstart","description":"Quickstart Documentation for Hauler","sidebar":"haulerSidebar"},"introduction/uninstall":{"id":"introduction/uninstall","title":"Uninstall","description":"Uninstall Documentation for Hauler","sidebar":"haulerSidebar"},"known-limits":{"id":"known-limits","title":"Known Issues and Limits","description":"Known Issues and Limitations for Hauler","sidebar":"haulerSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/afcf285f.1873abe8.js b/assets/js/afcf285f.1873abe8.js new file mode 100644 index 000000000..180fe4a50 --- /dev/null +++ b/assets/js/afcf285f.1873abe8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1482],{3277:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var r=n(4848),l=n(8453);const s={title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},i=void 0,a={id:"introduction/install",title:"Installation",description:"Installation Documentation for Hauler",source:"@site/versioned_docs/version-0.4.1/introduction/install.md",sourceDirName:"introduction",slug:"/introduction/install",permalink:"/docs/0.4.1/introduction/install",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.1/introduction/install.md",tags:[],version:"0.4.1",frontMatter:{title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},sidebar:"haulerSidebar",previous:{title:"Quickstart",permalink:"/docs/0.4.1/introduction/quickstart"},next:{title:"Uninstall",permalink:"/docs/0.4.1/introduction/uninstall"}},c={},d=[{value:"Overview",id:"overview",level:2},{value:"Supported Architectures",id:"supported-architectures",level:2},{value:"Installation Steps",id:"installation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin",level:3},{value:"Windows",id:"windows",level:3},{value:"Homebrew",id:"homebrew",level:3},{value:"Manual Installation Steps",id:"manual-installation-steps",level:2}];function o(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h2,{id:"overview",children:"Overview"}),"\n",(0,r.jsxs)(t.p,{children:["Hauler is a purpose built to be a single binary with no specific prerequistes or depedencies. It's installation is very simple and easy to follow. To view the latest release, please view our ",(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"GitHub Release"})," page."]}),"\n",(0,r.jsx)(t.h2,{id:"supported-architectures",children:"Supported Architectures"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Base Platform"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Architecture"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Latest Release"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Linux"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Darwin"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Windows"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]})]})]}),"\n",(0,r.jsx)(t.h2,{id:"installation-steps",children:"Installation Steps"}),"\n",(0,r.jsx)(t.h3,{id:"linuxdarwin",children:"Linux/Darwin"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n\n# install specific release\ncurl -sfL https://get.hauler.dev | HAULER_VERSION=0.4.1 bash\n"})}),"\n",(0,r.jsx)(t.h3,{id:"windows",children:"Windows"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,r.jsx)(t.h3,{id:"homebrew",children:"Homebrew"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,r.jsx)(t.h2,{id:"manual-installation-steps",children:"Manual Installation Steps"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:'# set the hauler version (i.e. "0.4.1")\nexport vHauler=HAULER_VERSION\n\n# set the specific platform (i.e. "linux")\nexport platform=PLATFORM\n\n# set the specific arch (i.e. "amd64")\nexport arch=ARCH\n\ncurl -sOL https://github.com/rancherfederal/hauler/releases/download/v${vHauler}/hauler_${vHauler}_${platform}_${arch}.tar.gz\ntar -xf hauler_${vHauler}_${platform}_${arch}.tar.gz\nsudo mv hauler /usr/bin/hauler\n'})})]})}function h(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>a});var r=n(6540);const l={},s=r.createContext(l);function i(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:i(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/afcf285f.f934e6a6.js b/assets/js/afcf285f.f934e6a6.js deleted file mode 100644 index 99b4d235a..000000000 --- a/assets/js/afcf285f.f934e6a6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1482],{3277:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>s,metadata:()=>i,toc:()=>d});var r=n(4848),l=n(8453);const s={title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},a=void 0,i={id:"introduction/install",title:"Installation",description:"Installation Documentation for Hauler",source:"@site/versioned_docs/version-0.4.1/introduction/install.md",sourceDirName:"introduction",slug:"/introduction/install",permalink:"/hauler-docs/docs/0.4.1/introduction/install",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.1/introduction/install.md",tags:[],version:"0.4.1",frontMatter:{title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},sidebar:"haulerSidebar",previous:{title:"Quickstart",permalink:"/hauler-docs/docs/0.4.1/introduction/quickstart"},next:{title:"Uninstall",permalink:"/hauler-docs/docs/0.4.1/introduction/uninstall"}},c={},d=[{value:"Overview",id:"overview",level:2},{value:"Supported Architectures",id:"supported-architectures",level:2},{value:"Installation Steps",id:"installation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin",level:3},{value:"Windows",id:"windows",level:3},{value:"Homebrew",id:"homebrew",level:3},{value:"Manual Installation Steps",id:"manual-installation-steps",level:2}];function o(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h2,{id:"overview",children:"Overview"}),"\n",(0,r.jsxs)(t.p,{children:["Hauler is a purpose built to be a single binary with no specific prerequistes or depedencies. It's installation is very simple and easy to follow. To view the latest release, please view our ",(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"GitHub Release"})," page."]}),"\n",(0,r.jsx)(t.h2,{id:"supported-architectures",children:"Supported Architectures"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Base Platform"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Architecture"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Latest Release"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Linux"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Darwin"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Windows"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]})]})]}),"\n",(0,r.jsx)(t.h2,{id:"installation-steps",children:"Installation Steps"}),"\n",(0,r.jsx)(t.h3,{id:"linuxdarwin",children:"Linux/Darwin"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n\n# install specific release\ncurl -sfL https://get.hauler.dev | HAULER_VERSION=0.4.1 bash\n"})}),"\n",(0,r.jsx)(t.h3,{id:"windows",children:"Windows"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,r.jsx)(t.h3,{id:"homebrew",children:"Homebrew"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,r.jsx)(t.h2,{id:"manual-installation-steps",children:"Manual Installation Steps"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:'# set the hauler version (i.e. "0.4.1")\nexport vHauler=HAULER_VERSION\n\n# set the specific platform (i.e. "linux")\nexport platform=PLATFORM\n\n# set the specific arch (i.e. "amd64")\nexport arch=ARCH\n\ncurl -sOL https://github.com/rancherfederal/hauler/releases/download/v${vHauler}/hauler_${vHauler}_${platform}_${arch}.tar.gz\ntar -xf hauler_${vHauler}_${platform}_${arch}.tar.gz\nsudo mv hauler /usr/bin/hauler\n'})})]})}function h(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>i});var r=n(6540);const l={},s=r.createContext(l);function a(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:a(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b3134099.9293fd84.js b/assets/js/b3134099.9293fd84.js deleted file mode 100644 index 8ae063b77..000000000 --- a/assets/js/b3134099.9293fd84.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8656],{6311:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var o=t(4848),r=t(8453);const i={title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},c=void 0,s={id:"core-concepts",title:"Core Concepts",description:"Core Concepts Documentation for Hauler",source:"@site/versioned_docs/version-0.4.3/core-concepts.md",sourceDirName:".",slug:"/core-concepts",permalink:"/hauler-docs/docs/0.4.3/core-concepts",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.3/core-concepts.md",tags:[],version:"0.4.3",frontMatter:{title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},sidebar:"haulerSidebar",previous:{title:"Introduction",permalink:"/hauler-docs/docs/0.4.3/intro"},next:{title:"Airgap Workflow",permalink:"/hauler-docs/docs/0.4.3/airgap-workflow"}},a={},l=[{value:"Haul",id:"haul",level:2},{value:"Collections",id:"collections",level:2},{value:"Community Collections",id:"community-collections",level:3},{value:"RGS Carbide Collections",id:"rgs-carbide-collections",level:3},{value:"Content",id:"content",level:2},{value:"Declarative Content",id:"declarative-content",level:3}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",ul:"ul",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"hauler-diagram",src:t(6178).A+"",width:"1949",height:"988"})}),"\n",(0,o.jsx)(n.h2,{id:"haul",children:"Haul"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauls"})," are Compressed Archive (Tarball) of Hauler Collections and Content."]})}),"\n",(0,o.jsxs)(n.p,{children:["At the heart of Hauler lies the concept of a ",(0,o.jsx)(n.code,{children:"Haul"}),". A ",(0,o.jsx)(n.code,{children:"Haul"})," is a compressed archive, often in the form of a tarball, containing Hauler collections and content. It serves as a container for grouping and transporting various data types, making it a fundamental element in the Hauler ecosystem."]}),"\n",(0,o.jsx)(n.h2,{id:"collections",children:"Collections"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are Grouping of one or more Hauler Contents."]})}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are the building blocks of Hauler. These are groupings of one or more Hauler ",(0,o.jsx)(n.code,{children:"contents"}),". Think of ",(0,o.jsx)(n.code,{children:"collections"})," as organized sets of data that collectively represent something desirable."]}),"\n",(0,o.jsx)(n.h3,{id:"community-collections",children:"Community Collections"}),"\n",(0,o.jsxs)(n.p,{children:["While ",(0,o.jsx)(n.code,{children:"collections"})," (and ",(0,o.jsx)(n.code,{children:"contents"}),") are built into Hauler, our goal is to empower users to define their own ",(0,o.jsx)(n.code,{children:"collections"}),". This way, you can tailor Hauler to your unique requirements and take full control of your artifacts."]}),"\n",(0,o.jsx)(n.h3,{id:"rgs-carbide-collections",children:"RGS Carbide Collections"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauler"})," provides the ability to import ",(0,o.jsx)(n.code,{children:"collections"})," for the Rancher products, making it seamless for RGS Supported Customers to airgap any of the Rancher products or projects. If you haven't heard of Rancher Government Carbide, check it out ",(0,o.jsx)(n.a,{href:"https://ranchergovernment.com/carbide",children:"here"}),"!"]}),"\n",(0,o.jsx)(n.h2,{id:"content",children:"Content"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Contents"})," are Artifacts such as Images, Charts, or Files."]})}),"\n",(0,o.jsxs)(n.p,{children:["In Hauler's terminology, ",(0,o.jsx)(n.code,{children:"content"})," refers to artifacts such as images, charts, or files. These are the fundamental types of resources that Hauler understands and manages. To understand the term better, let's break it down:"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Content"}),": The fundamental type of artifacts that Hauler recognizes (images, charts, and files)."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Artifact"}),": Anything that can be represented as an OCI (Open Container Initiative) artifact.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"OCI Artifacts provide a standardized way to store arbitrary files, making it easier to manage content efficiently."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"declarative-content",children:"Declarative Content"}),"\n",(0,o.jsxs)(n.p,{children:["While manually adding content to ",(0,o.jsx)(n.code,{children:"Hauler"})," is a straightforward way to get started, we recommend a much more sustainable approach. ",(0,o.jsx)(n.code,{children:"Hauler"})," provides a declarative approach for each ",(0,o.jsx)(n.code,{children:"content"})," type, allowing you to define all the ",(0,o.jsx)(n.code,{children:"content"})," within a manifest. This approach ensures a more reproducable workflow for managing the lifecycle of your ",(0,o.jsx)(n.code,{children:"hauls"}),"."]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},6178:(e,n,t)=>{t.d(n,{A:()=>o});const o=t.p+"assets/images/hauler-diagram-53f9182c0d98fe871fb3cf7fe8cd475a.png"},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>s});var o=t(6540);const r={},i=o.createContext(r);function c(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b3134099.ca62be02.js b/assets/js/b3134099.ca62be02.js new file mode 100644 index 000000000..e8b1bd558 --- /dev/null +++ b/assets/js/b3134099.ca62be02.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8656],{6311:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var o=t(4848),r=t(8453);const i={title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},s=void 0,c={id:"core-concepts",title:"Core Concepts",description:"Core Concepts Documentation for Hauler",source:"@site/versioned_docs/version-0.4.3/core-concepts.md",sourceDirName:".",slug:"/core-concepts",permalink:"/docs/0.4.3/core-concepts",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.3/core-concepts.md",tags:[],version:"0.4.3",frontMatter:{title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},sidebar:"haulerSidebar",previous:{title:"Introduction",permalink:"/docs/0.4.3/intro"},next:{title:"Airgap Workflow",permalink:"/docs/0.4.3/airgap-workflow"}},a={},l=[{value:"Haul",id:"haul",level:2},{value:"Collections",id:"collections",level:2},{value:"Community Collections",id:"community-collections",level:3},{value:"RGS Carbide Collections",id:"rgs-carbide-collections",level:3},{value:"Content",id:"content",level:2},{value:"Declarative Content",id:"declarative-content",level:3}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",ul:"ul",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"hauler-diagram",src:t(6178).A+"",width:"1949",height:"988"})}),"\n",(0,o.jsx)(n.h2,{id:"haul",children:"Haul"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauls"})," are Compressed Archive (Tarball) of Hauler Collections and Content."]})}),"\n",(0,o.jsxs)(n.p,{children:["At the heart of Hauler lies the concept of a ",(0,o.jsx)(n.code,{children:"Haul"}),". A ",(0,o.jsx)(n.code,{children:"Haul"})," is a compressed archive, often in the form of a tarball, containing Hauler collections and content. It serves as a container for grouping and transporting various data types, making it a fundamental element in the Hauler ecosystem."]}),"\n",(0,o.jsx)(n.h2,{id:"collections",children:"Collections"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are Grouping of one or more Hauler Contents."]})}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are the building blocks of Hauler. These are groupings of one or more Hauler ",(0,o.jsx)(n.code,{children:"contents"}),". Think of ",(0,o.jsx)(n.code,{children:"collections"})," as organized sets of data that collectively represent something desirable."]}),"\n",(0,o.jsx)(n.h3,{id:"community-collections",children:"Community Collections"}),"\n",(0,o.jsxs)(n.p,{children:["While ",(0,o.jsx)(n.code,{children:"collections"})," (and ",(0,o.jsx)(n.code,{children:"contents"}),") are built into Hauler, our goal is to empower users to define their own ",(0,o.jsx)(n.code,{children:"collections"}),". This way, you can tailor Hauler to your unique requirements and take full control of your artifacts."]}),"\n",(0,o.jsx)(n.h3,{id:"rgs-carbide-collections",children:"RGS Carbide Collections"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauler"})," provides the ability to import ",(0,o.jsx)(n.code,{children:"collections"})," for the Rancher products, making it seamless for RGS Supported Customers to airgap any of the Rancher products or projects. If you haven't heard of Rancher Government Carbide, check it out ",(0,o.jsx)(n.a,{href:"https://ranchergovernment.com/carbide",children:"here"}),"!"]}),"\n",(0,o.jsx)(n.h2,{id:"content",children:"Content"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Contents"})," are Artifacts such as Images, Charts, or Files."]})}),"\n",(0,o.jsxs)(n.p,{children:["In Hauler's terminology, ",(0,o.jsx)(n.code,{children:"content"})," refers to artifacts such as images, charts, or files. These are the fundamental types of resources that Hauler understands and manages. To understand the term better, let's break it down:"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Content"}),": The fundamental type of artifacts that Hauler recognizes (images, charts, and files)."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Artifact"}),": Anything that can be represented as an OCI (Open Container Initiative) artifact.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"OCI Artifacts provide a standardized way to store arbitrary files, making it easier to manage content efficiently."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"declarative-content",children:"Declarative Content"}),"\n",(0,o.jsxs)(n.p,{children:["While manually adding content to ",(0,o.jsx)(n.code,{children:"Hauler"})," is a straightforward way to get started, we recommend a much more sustainable approach. ",(0,o.jsx)(n.code,{children:"Hauler"})," provides a declarative approach for each ",(0,o.jsx)(n.code,{children:"content"})," type, allowing you to define all the ",(0,o.jsx)(n.code,{children:"content"})," within a manifest. This approach ensures a more reproducable workflow for managing the lifecycle of your ",(0,o.jsx)(n.code,{children:"hauls"}),"."]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},6178:(e,n,t)=>{t.d(n,{A:()=>o});const o=t.p+"assets/images/hauler-diagram-53f9182c0d98fe871fb3cf7fe8cd475a.png"},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var o=t(6540);const r={},i=o.createContext(r);function s(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b548b5e0.2f91c5fb.js b/assets/js/b548b5e0.2f91c5fb.js new file mode 100644 index 000000000..3d8957c5d --- /dev/null +++ b/assets/js/b548b5e0.2f91c5fb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5560],{848:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>l});var r=t(4848),s=t(8453);const i={title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},o="Rancher Government Hauler",a={id:"intro",title:"Introduction",description:"Introduction to Rancher Government Hauler",source:"@site/versioned_docs/version-0.4.0/intro.md",sourceDirName:".",slug:"/intro",permalink:"/docs/0.4.0/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.0/intro.md",tags:[],version:"0.4.0",frontMatter:{title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},sidebar:"haulerSidebar",next:{title:"Core Concepts",permalink:"/docs/0.4.0/core-concepts"}},c={},l=[{value:"What's Hauler?",id:"whats-hauler",level:2},{value:"Acknowledgements",id:"acknowledgements",level:2}];function d(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"rancher-government-hauler",children:"Rancher Government Hauler"}),"\n",(0,r.jsx)(n.h1,{id:"airgap-swiss-army-knife",children:"Airgap Swiss Army Knife"}),"\n",(0,r.jsxs)(n.admonition,{type:"caution",children:[(0,r.jsx)(n.p,{children:(0,r.jsxs)(n.strong,{children:["Note: Hauler and it's documentation are in active development and ",(0,r.jsx)(n.em,{children:"not Generally Available (GA)"}),"."]})}),(0,r.jsxs)(n.p,{children:["Most of the core functionality and features are ready for use, but may have breaking changes in future releases. Please help us by submitting any issues via ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler-docs/issues",children:"GitHub Issues"})})," and make sure to review the ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"/docs/known-limits",children:"Known Issues and Limitations"})}),"!"]})]}),"\n",(0,r.jsx)(n.h2,{id:"whats-hauler",children:"What's Hauler?"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Rancher Government Hauler"})," simplifies the airgap experience without requiring users to adopt a specific workflow. ",(0,r.jsx)(n.code,{children:"Hauler"})," simplifies the airgapping process, by representing assets (images, charts, files, etc...) as content and collections to allow users to easily fetch, store, package, and distribute these assets with declarative manifests or through the command line."]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Hauler"})," does this by storing contents and collections as OCI Artifacts and allows users to serve contents and collections with an embedded registry and fileserver. Additionally, ",(0,r.jsx)(n.code,{children:"Hauler"})," has the ability to store and inspect various non-image OCI Artifacts."]}),"\n",(0,r.jsx)(n.h2,{id:"acknowledgements",children:"Acknowledgements"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Hauler"})," wouldn't be possible without the open-source community, but there are a few projects that stand out:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/google/go-containerregistry",children:"go-containerregistry"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/oras-project/oras",children:"oras cli"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/sigstore/cosign",children:"cosign"})}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var r=t(6540);const s={},i=r.createContext(s);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b548b5e0.5691e091.js b/assets/js/b548b5e0.5691e091.js deleted file mode 100644 index a518ebd05..000000000 --- a/assets/js/b548b5e0.5691e091.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5560],{848:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>i,metadata:()=>a,toc:()=>l});var r=t(4848),s=t(8453);const i={title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},o="Rancher Government Hauler",a={id:"intro",title:"Introduction",description:"Introduction to Rancher Government Hauler",source:"@site/versioned_docs/version-0.4.0/intro.md",sourceDirName:".",slug:"/intro",permalink:"/hauler-docs/docs/0.4.0/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.0/intro.md",tags:[],version:"0.4.0",frontMatter:{title:"Introduction",description:"Introduction to Rancher Government Hauler",sidebar_label:"Introduction"},sidebar:"haulerSidebar",next:{title:"Core Concepts",permalink:"/hauler-docs/docs/0.4.0/core-concepts"}},c={},l=[{value:"What's Hauler?",id:"whats-hauler",level:2},{value:"Acknowledgements",id:"acknowledgements",level:2}];function d(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"rancher-government-hauler",children:"Rancher Government Hauler"}),"\n",(0,r.jsx)(n.h1,{id:"airgap-swiss-army-knife",children:"Airgap Swiss Army Knife"}),"\n",(0,r.jsxs)(n.admonition,{type:"caution",children:[(0,r.jsx)(n.p,{children:(0,r.jsxs)(n.strong,{children:["Note: Hauler and it's documentation are in active development and ",(0,r.jsx)(n.em,{children:"not Generally Available (GA)"}),"."]})}),(0,r.jsxs)(n.p,{children:["Most of the core functionality and features are ready for use, but may have breaking changes in future releases. Please help us by submitting any issues via ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"https://github.com/rancherfederal/hauler-docs/issues",children:"GitHub Issues"})})," and make sure to review the ",(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.a,{href:"/docs/known-limits",children:"Known Issues and Limitations"})}),"!"]})]}),"\n",(0,r.jsx)(n.h2,{id:"whats-hauler",children:"What's Hauler?"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Rancher Government Hauler"})," simplifies the airgap experience without requiring users to adopt a specific workflow. ",(0,r.jsx)(n.code,{children:"Hauler"})," simplifies the airgapping process, by representing assets (images, charts, files, etc...) as content and collections to allow users to easily fetch, store, package, and distribute these assets with declarative manifests or through the command line."]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Hauler"})," does this by storing contents and collections as OCI Artifacts and allows users to serve contents and collections with an embedded registry and fileserver. Additionally, ",(0,r.jsx)(n.code,{children:"Hauler"})," has the ability to store and inspect various non-image OCI Artifacts."]}),"\n",(0,r.jsx)(n.h2,{id:"acknowledgements",children:"Acknowledgements"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Hauler"})," wouldn't be possible without the open-source community, but there are a few projects that stand out:"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/google/go-containerregistry",children:"go-containerregistry"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/oras-project/oras",children:"oras cli"})}),"\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"https://github.com/sigstore/cosign",children:"cosign"})}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var r=t(6540);const s={},i=r.createContext(s);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bbe7335f.0fb76cfa.js b/assets/js/bbe7335f.0fb76cfa.js new file mode 100644 index 000000000..b5981f6cf --- /dev/null +++ b/assets/js/bbe7335f.0fb76cfa.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8548],{7135:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>l,default:()=>d,frontMatter:()=>s,metadata:()=>o,toc:()=>h});var a=r(4848),n=r(8453);const s={title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},l=void 0,o={id:"introduction/quickstart",title:"Quickstart",description:"Quickstart Documentation for Hauler",source:"@site/versioned_docs/version-0.4.3/introduction/quickstart.md",sourceDirName:"introduction",slug:"/introduction/quickstart",permalink:"/docs/0.4.3/introduction/quickstart",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.3/introduction/quickstart.md",tags:[],version:"0.4.3",frontMatter:{title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},sidebar:"haulerSidebar",previous:{title:"Airgap Workflow",permalink:"/docs/0.4.3/airgap-workflow"},next:{title:"Installation",permalink:"/docs/0.4.3/introduction/install"}},i={},h=[{value:"Quick Installation",id:"quick-installation",level:2},{value:"Example Use of Hauler",id:"example-use-of-hauler",level:2},{value:"Add Content to the Hauler Store",id:"add-content-to-the-hauler-store",level:3},{value:"Using the Command Line:",id:"using-the-command-line",level:4},{value:"Using a Hauler Manifest:",id:"using-a-hauler-manifest",level:4},{value:"View the Hauler Store",id:"view-the-hauler-store",level:3},{value:"Save the Hauler Store",id:"save-the-hauler-store",level:3},{value:"Load the Airgapped Hauler Store",id:"load-the-airgapped-hauler-store",level:3},{value:"Serve the Hauler Store",id:"serve-the-hauler-store",level:3},{value:"Copy the Hauler Store to a Registry",id:"copy-the-hauler-store-to-a-registry",level:3},{value:"Copy the Hauler Store to a Directory",id:"copy-the-hauler-store-to-a-directory",level:3}];function c(e){const t={code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,n.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.p,{children:"Skipping past most of the documentation? Here's an easy to follow Quick Start Guide:"}),"\n",(0,a.jsx)(t.h2,{id:"quick-installation",children:"Quick Installation"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n"})}),"\n",(0,a.jsx)(t.h2,{id:"example-use-of-hauler",children:"Example Use of Hauler"}),"\n",(0,a.jsx)(t.h3,{id:"add-content-to-the-hauler-store",children:"Add Content to the Hauler Store"}),"\n",(0,a.jsx)(t.h4,{id:"using-the-command-line",children:"Using the Command Line:"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# add a image: neuvector/scanner:latest\nhauler store add image neuvector/scanner:latest --platform linux/amd64\n\n# add a image with supply chain artifacts\nhauler store add image rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.2 --key carbide-key.pub --platform linux/amd64\n\n# add a chart: rancher-stable/rancher (v2.8.1)\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.8.1\n\n# add a file: rke2-install.sh\nhauler store add file https://get.rke2.io --name install.sh\n"})}),"\n",(0,a.jsx)(t.h4,{id:"using-a-hauler-manifest",children:"Using a Hauler Manifest:"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"hauler store sync --files hauler-manfiest.yaml\n"})}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\nspec:\n images:\n - name: neuvector/scanner:latest\n - name: rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.1\n key: carbide-key.pub\n platform: linux/amd64\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.8.1\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n - path: https://get.rke2.io\n name: install.sh\n"})}),"\n",(0,a.jsx)(t.h3,{id:"view-the-hauler-store",children:"View the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# view and verify the content in the local hauler store\nhauler store info\n"})}),"\n",(0,a.jsx)(t.h3,{id:"save-the-hauler-store",children:"Save the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# save and export the content in the local hauler store\nhauler store save --filename haul.tar.zst\n"})}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsxs)(t.strong,{children:["airgap the ",(0,a.jsx)(t.code,{children:"haul.tar.zst"})," to the disconnected environment"]})}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.h3,{id:"load-the-airgapped-hauler-store",children:"Load the Airgapped Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# load and import the airgapped content to the new local hauler store\nhauler store load haul.tar.zst\n"})}),"\n",(0,a.jsx)(t.h3,{id:"serve-the-hauler-store",children:"Serve the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# serve the content as a registry from the hauler store\nhauler store serve registry\n\n# serve the file content as a fileserver from the hauler store\nhauler store serve fileserver\n"})}),"\n",(0,a.jsx)(t.h3,{id:"copy-the-hauler-store-to-a-registry",children:"Copy the Hauler Store to a Registry"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# copy the content to a registry from the hauler store\nhauler store copy registry://harbor.example.com\n"})}),"\n",(0,a.jsx)(t.h3,{id:"copy-the-hauler-store-to-a-directory",children:"Copy the Hauler Store to a Directory"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# copy the content to a directory from the hauler store\nhauler store copy dir://hauler-files\n"})})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(c,{...e})}):c(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>l,x:()=>o});var a=r(6540);const n={},s=a.createContext(n);function l(e){const t=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:l(e.components),a.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bbe7335f.8d1d6ad7.js b/assets/js/bbe7335f.8d1d6ad7.js deleted file mode 100644 index b7874f705..000000000 --- a/assets/js/bbe7335f.8d1d6ad7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8548],{7135:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>l,default:()=>d,frontMatter:()=>s,metadata:()=>o,toc:()=>h});var a=r(4848),n=r(8453);const s={title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},l=void 0,o={id:"introduction/quickstart",title:"Quickstart",description:"Quickstart Documentation for Hauler",source:"@site/versioned_docs/version-0.4.3/introduction/quickstart.md",sourceDirName:"introduction",slug:"/introduction/quickstart",permalink:"/hauler-docs/docs/0.4.3/introduction/quickstart",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.3/introduction/quickstart.md",tags:[],version:"0.4.3",frontMatter:{title:"Quickstart",description:"Quickstart Documentation for Hauler",sidebar_label:"Quickstart"},sidebar:"haulerSidebar",previous:{title:"Airgap Workflow",permalink:"/hauler-docs/docs/0.4.3/airgap-workflow"},next:{title:"Installation",permalink:"/hauler-docs/docs/0.4.3/introduction/install"}},i={},h=[{value:"Quick Installation",id:"quick-installation",level:2},{value:"Example Use of Hauler",id:"example-use-of-hauler",level:2},{value:"Add Content to the Hauler Store",id:"add-content-to-the-hauler-store",level:3},{value:"Using the Command Line:",id:"using-the-command-line",level:4},{value:"Using a Hauler Manifest:",id:"using-a-hauler-manifest",level:4},{value:"View the Hauler Store",id:"view-the-hauler-store",level:3},{value:"Save the Hauler Store",id:"save-the-hauler-store",level:3},{value:"Load the Airgapped Hauler Store",id:"load-the-airgapped-hauler-store",level:3},{value:"Serve the Hauler Store",id:"serve-the-hauler-store",level:3},{value:"Copy the Hauler Store to a Registry",id:"copy-the-hauler-store-to-a-registry",level:3},{value:"Copy the Hauler Store to a Directory",id:"copy-the-hauler-store-to-a-directory",level:3}];function c(e){const t={code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,n.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(t.p,{children:"Skipping past most of the documentation? Here's an easy to follow Quick Start Guide:"}),"\n",(0,a.jsx)(t.h2,{id:"quick-installation",children:"Quick Installation"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n"})}),"\n",(0,a.jsx)(t.h2,{id:"example-use-of-hauler",children:"Example Use of Hauler"}),"\n",(0,a.jsx)(t.h3,{id:"add-content-to-the-hauler-store",children:"Add Content to the Hauler Store"}),"\n",(0,a.jsx)(t.h4,{id:"using-the-command-line",children:"Using the Command Line:"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# add a image: neuvector/scanner:latest\nhauler store add image neuvector/scanner:latest --platform linux/amd64\n\n# add a image with supply chain artifacts\nhauler store add image rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.2 --key carbide-key.pub --platform linux/amd64\n\n# add a chart: rancher-stable/rancher (v2.8.1)\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.8.1\n\n# add a file: rke2-install.sh\nhauler store add file https://get.rke2.io --name install.sh\n"})}),"\n",(0,a.jsx)(t.h4,{id:"using-a-hauler-manifest",children:"Using a Hauler Manifest:"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"hauler store sync --files hauler-manfiest.yaml\n"})}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\nspec:\n images:\n - name: neuvector/scanner:latest\n - name: rgcrprod.azurecr.us/longhornio/longhorn-ui:v1.5.1\n key: carbide-key.pub\n platform: linux/amd64\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.8.1\n---\napiVersion: content.hauler.cattle.io/v1alpha1\nkind: Files\nmetadata:\n name: hauler-content-files-example\nspec:\n files:\n - path: https://get.rke2.io\n name: install.sh\n"})}),"\n",(0,a.jsx)(t.h3,{id:"view-the-hauler-store",children:"View the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# view and verify the content in the local hauler store\nhauler store info\n"})}),"\n",(0,a.jsx)(t.h3,{id:"save-the-hauler-store",children:"Save the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# save and export the content in the local hauler store\nhauler store save --filename haul.tar.zst\n"})}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.p,{children:(0,a.jsxs)(t.strong,{children:["airgap the ",(0,a.jsx)(t.code,{children:"haul.tar.zst"})," to the disconnected environment"]})}),"\n",(0,a.jsx)(t.hr,{}),"\n",(0,a.jsx)(t.h3,{id:"load-the-airgapped-hauler-store",children:"Load the Airgapped Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# load and import the airgapped content to the new local hauler store\nhauler store load haul.tar.zst\n"})}),"\n",(0,a.jsx)(t.h3,{id:"serve-the-hauler-store",children:"Serve the Hauler Store"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# serve the content as a registry from the hauler store\nhauler store serve registry\n\n# serve the file content as a fileserver from the hauler store\nhauler store serve fileserver\n"})}),"\n",(0,a.jsx)(t.h3,{id:"copy-the-hauler-store-to-a-registry",children:"Copy the Hauler Store to a Registry"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# copy the content to a registry from the hauler store\nhauler store copy registry://harbor.example.com\n"})}),"\n",(0,a.jsx)(t.h3,{id:"copy-the-hauler-store-to-a-directory",children:"Copy the Hauler Store to a Directory"}),"\n",(0,a.jsx)(t.pre,{children:(0,a.jsx)(t.code,{className:"language-bash",children:"# copy the content to a directory from the hauler store\nhauler store copy dir://hauler-files\n"})})]})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(c,{...e})}):c(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>l,x:()=>o});var a=r(6540);const n={},s=a.createContext(n);function l(e){const t=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:l(e.components),a.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bc025a59.2f96f528.js b/assets/js/bc025a59.2f96f528.js new file mode 100644 index 000000000..623d25256 --- /dev/null +++ b/assets/js/bc025a59.2f96f528.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1432],{2991:(e,r,a)=>{a.r(r),a.d(r,{assets:()=>h,contentTitle:()=>c,default:()=>d,frontMatter:()=>s,metadata:()=>o,toc:()=>l});var t=a(4848),n=a(8453);const s={title:"Hauler Content - Charts",description:"Hauler Content - Charts Documentation",sidebar_label:"Charts"},c=void 0,o={id:"guides-references/hauler-content/charts",title:"Hauler Content - Charts",description:"Hauler Content - Charts Documentation",source:"@site/versioned_docs/version-1.0.x/guides-references/hauler-content/charts.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/charts",permalink:"/docs/guides-references/hauler-content/charts",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/hauler-content/charts.md",tags:[],version:"1.0.x",frontMatter:{title:"Hauler Content - Charts",description:"Hauler Content - Charts Documentation",sidebar_label:"Charts"},sidebar:"haulerSidebar",previous:{title:"Images",permalink:"/docs/guides-references/hauler-content/images"},next:{title:"Files",permalink:"/docs/guides-references/hauler-content/files"}},h={},l=[{value:"Hauler Command Line for Charts",id:"hauler-command-line-for-charts",level:2},{value:"Example Commands for Charts",id:"example-commands-for-charts",level:2},{value:"Hauler Manifest for Charts",id:"hauler-manifest-for-charts",level:2},{value:"Example Manifest for Charts",id:"example-manifest-for-charts",level:2}];function i(e){const r={code:"code",h2:"h2",pre:"pre",...(0,n.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h2,{id:"hauler-command-line-for-charts",children:"Hauler Command Line for Charts"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-bash",children:"hauler store add chart --repo --version \n"})}),"\n",(0,t.jsx)(r.h2,{id:"example-commands-for-charts",children:"Example Commands for Charts"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-bash",children:"# fetch helm chart\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable\n\n# fetch helm chart with specific version\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.8.2\n"})}),"\n",(0,t.jsx)(r.h2,{id:"hauler-manifest-for-charts",children:"Hauler Manifest for Charts"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",metastring:'title="hauler-chart-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n # fetch helm chart\n - name: \n repoURL: \n version: \n"})}),"\n",(0,t.jsx)(r.h2,{id:"example-manifest-for-charts",children:"Example Manifest for Charts"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",metastring:'title="hauler-chart-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n # fetch helm chart\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n # fetch helm chart with specific version\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.8.2\n"})})]})}function d(e={}){const{wrapper:r}={...(0,n.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(i,{...e})}):i(e)}},8453:(e,r,a)=>{a.d(r,{R:()=>c,x:()=>o});var t=a(6540);const n={},s=t.createContext(n);function c(e){const r=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:c(e.components),t.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bc025a59.4857d172.js b/assets/js/bc025a59.4857d172.js deleted file mode 100644 index 214b3f1f0..000000000 --- a/assets/js/bc025a59.4857d172.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1432],{2991:(e,r,a)=>{a.r(r),a.d(r,{assets:()=>h,contentTitle:()=>c,default:()=>d,frontMatter:()=>s,metadata:()=>o,toc:()=>l});var t=a(4848),n=a(8453);const s={title:"Hauler Content - Charts",description:"Hauler Content - Charts Documentation",sidebar_label:"Charts"},c=void 0,o={id:"guides-references/hauler-content/charts",title:"Hauler Content - Charts",description:"Hauler Content - Charts Documentation",source:"@site/versioned_docs/version-1.0.x/guides-references/hauler-content/charts.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/charts",permalink:"/hauler-docs/docs/guides-references/hauler-content/charts",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/hauler-content/charts.md",tags:[],version:"1.0.x",frontMatter:{title:"Hauler Content - Charts",description:"Hauler Content - Charts Documentation",sidebar_label:"Charts"},sidebar:"haulerSidebar",previous:{title:"Images",permalink:"/hauler-docs/docs/guides-references/hauler-content/images"},next:{title:"Files",permalink:"/hauler-docs/docs/guides-references/hauler-content/files"}},h={},l=[{value:"Hauler Command Line for Charts",id:"hauler-command-line-for-charts",level:2},{value:"Example Commands for Charts",id:"example-commands-for-charts",level:2},{value:"Hauler Manifest for Charts",id:"hauler-manifest-for-charts",level:2},{value:"Example Manifest for Charts",id:"example-manifest-for-charts",level:2}];function i(e){const r={code:"code",h2:"h2",pre:"pre",...(0,n.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h2,{id:"hauler-command-line-for-charts",children:"Hauler Command Line for Charts"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-bash",children:"hauler store add chart --repo --version \n"})}),"\n",(0,t.jsx)(r.h2,{id:"example-commands-for-charts",children:"Example Commands for Charts"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-bash",children:"# fetch helm chart\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable\n\n# fetch helm chart with specific version\nhauler store add chart rancher --repo https://releases.rancher.com/server-charts/stable --version 2.8.2\n"})}),"\n",(0,t.jsx)(r.h2,{id:"hauler-manifest-for-charts",children:"Hauler Manifest for Charts"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",metastring:'title="hauler-chart-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n # fetch helm chart\n - name: \n repoURL: \n version: \n"})}),"\n",(0,t.jsx)(r.h2,{id:"example-manifest-for-charts",children:"Example Manifest for Charts"}),"\n",(0,t.jsx)(r.pre,{children:(0,t.jsx)(r.code,{className:"language-yaml",metastring:'title="hauler-chart-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Charts\nmetadata:\n name: hauler-content-charts-example\nspec:\n charts:\n # fetch helm chart\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n # fetch helm chart with specific version\n - name: rancher\n repoURL: https://releases.rancher.com/server-charts/stable\n version: 2.8.2\n"})})]})}function d(e={}){const{wrapper:r}={...(0,n.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(i,{...e})}):i(e)}},8453:(e,r,a)=>{a.d(r,{R:()=>c,x:()=>o});var t=a(6540);const n={},s=t.createContext(n);function c(e){const r=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function o(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:c(e.components),t.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bda10480.13e006e3.js b/assets/js/bda10480.13e006e3.js new file mode 100644 index 000000000..748efdac0 --- /dev/null +++ b/assets/js/bda10480.13e006e3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5683],{9284:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>o,contentTitle:()=>a,default:()=>u,frontMatter:()=>s,metadata:()=>r,toc:()=>d});var l=i(4848),t=i(8453);const s={title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},a=void 0,r={id:"introduction/uninstall",title:"Uninstall",description:"Uninstall Documentation for Hauler",source:"@site/versioned_docs/version-1.0.x/introduction/uninstall.md",sourceDirName:"introduction",slug:"/introduction/uninstall",permalink:"/docs/introduction/uninstall",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.x/introduction/uninstall.md",tags:[],version:"1.0.x",frontMatter:{title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},sidebar:"haulerSidebar",previous:{title:"Installation",permalink:"/docs/introduction/install"},next:{title:"Overview",permalink:"/docs/guides-references/overview"}},o={},d=[{value:"Uninstallation Steps",id:"uninstallation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin",level:3},{value:"Homebrew",id:"homebrew",level:3},{value:"Windows",id:"windows",level:3},{value:"Manual Uninstallation Steps",id:"manual-uninstallation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin-1",level:3},{value:"Homebrew",id:"homebrew-1",level:3},{value:"Windows",id:"windows-1",level:3}];function c(n){const e={code:"code",h2:"h2",h3:"h3",pre:"pre",...(0,t.R)(),...n.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(e.h2,{id:"uninstallation-steps",children:"Uninstallation Steps"}),"\n",(0,l.jsx)(e.h3,{id:"linuxdarwin",children:"Linux/Darwin"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:"# uninstall hauler\ncurl -sfL https://get.hauler.dev | HAULER_UNINSTALL=true bash\n"})}),"\n",(0,l.jsx)(e.h3,{id:"homebrew",children:"Homebrew"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:"# installs latest release\nbrew uninstall hauler\n"})}),"\n",(0,l.jsx)(e.h3,{id:"windows",children:"Windows"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,l.jsx)(e.h2,{id:"manual-uninstallation-steps",children:"Manual Uninstallation Steps"}),"\n",(0,l.jsx)(e.h3,{id:"linuxdarwin-1",children:"Linux/Darwin"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:'# remove the hauler binary\nsudo rm -f /usr/local/bin/hauler\n\n# remove the working/installation directory\nrm -rf "$HOME/.hauler"\n'})}),"\n",(0,l.jsx)(e.h3,{id:"homebrew-1",children:"Homebrew"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:"# not applicable\n"})}),"\n",(0,l.jsx)(e.h3,{id:"windows-1",children:"Windows"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:"# coming soon\n"})})]})}function u(n={}){const{wrapper:e}={...(0,t.R)(),...n.components};return e?(0,l.jsx)(e,{...n,children:(0,l.jsx)(c,{...n})}):c(n)}},8453:(n,e,i)=>{i.d(e,{R:()=>a,x:()=>r});var l=i(6540);const t={},s=l.createContext(t);function a(n){const e=l.useContext(s);return l.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(t):n.components||t:a(n.components),l.createElement(s.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/bda10480.87bdfe9a.js b/assets/js/bda10480.87bdfe9a.js deleted file mode 100644 index 690826f18..000000000 --- a/assets/js/bda10480.87bdfe9a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5683],{9284:(n,e,i)=>{i.r(e),i.d(e,{assets:()=>o,contentTitle:()=>a,default:()=>u,frontMatter:()=>t,metadata:()=>r,toc:()=>d});var l=i(4848),s=i(8453);const t={title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},a=void 0,r={id:"introduction/uninstall",title:"Uninstall",description:"Uninstall Documentation for Hauler",source:"@site/versioned_docs/version-1.0.x/introduction/uninstall.md",sourceDirName:"introduction",slug:"/introduction/uninstall",permalink:"/hauler-docs/docs/introduction/uninstall",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.x/introduction/uninstall.md",tags:[],version:"1.0.x",frontMatter:{title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},sidebar:"haulerSidebar",previous:{title:"Installation",permalink:"/hauler-docs/docs/introduction/install"},next:{title:"Overview",permalink:"/hauler-docs/docs/guides-references/overview"}},o={},d=[{value:"Uninstallation Steps",id:"uninstallation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin",level:3},{value:"Homebrew",id:"homebrew",level:3},{value:"Windows",id:"windows",level:3},{value:"Manual Uninstallation Steps",id:"manual-uninstallation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin-1",level:3},{value:"Homebrew",id:"homebrew-1",level:3},{value:"Windows",id:"windows-1",level:3}];function c(n){const e={code:"code",h2:"h2",h3:"h3",pre:"pre",...(0,s.R)(),...n.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(e.h2,{id:"uninstallation-steps",children:"Uninstallation Steps"}),"\n",(0,l.jsx)(e.h3,{id:"linuxdarwin",children:"Linux/Darwin"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:"# uninstall hauler\ncurl -sfL https://get.hauler.dev | HAULER_UNINSTALL=true bash\n"})}),"\n",(0,l.jsx)(e.h3,{id:"homebrew",children:"Homebrew"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:"# installs latest release\nbrew uninstall hauler\n"})}),"\n",(0,l.jsx)(e.h3,{id:"windows",children:"Windows"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,l.jsx)(e.h2,{id:"manual-uninstallation-steps",children:"Manual Uninstallation Steps"}),"\n",(0,l.jsx)(e.h3,{id:"linuxdarwin-1",children:"Linux/Darwin"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:'# remove the hauler binary\nsudo rm -f /usr/local/bin/hauler\n\n# remove the working/installation directory\nrm -rf "$HOME/.hauler"\n'})}),"\n",(0,l.jsx)(e.h3,{id:"homebrew-1",children:"Homebrew"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:"# not applicable\n"})}),"\n",(0,l.jsx)(e.h3,{id:"windows-1",children:"Windows"}),"\n",(0,l.jsx)(e.pre,{children:(0,l.jsx)(e.code,{className:"language-bash",children:"# coming soon\n"})})]})}function u(n={}){const{wrapper:e}={...(0,s.R)(),...n.components};return e?(0,l.jsx)(e,{...n,children:(0,l.jsx)(c,{...n})}):c(n)}},8453:(n,e,i)=>{i.d(e,{R:()=>a,x:()=>r});var l=i(6540);const s={},t=l.createContext(s);function a(n){const e=l.useContext(t);return l.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:a(n.components),l.createElement(t.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/bec068c2.27d7503e.js b/assets/js/bec068c2.27d7503e.js deleted file mode 100644 index a35936cff..000000000 --- a/assets/js/bec068c2.27d7503e.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8792],{8540:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>u});var r=n(4848),o=n(8453);const i={title:"Overview of Hauler Content",description:"Hauler Content Documentation",sidebar_label:"Overview"},s=void 0,c={id:"guides-references/hauler-content/overview",title:"Overview of Hauler Content",description:"Hauler Content Documentation",source:"@site/versioned_docs/version-0.4.2/guides-references/hauler-content/overview.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/overview",permalink:"/hauler-docs/docs/0.4.2/guides-references/hauler-content/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.2/guides-references/hauler-content/overview.md",tags:[],version:"0.4.2",frontMatter:{title:"Overview of Hauler Content",description:"Hauler Content Documentation",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/hauler-docs/docs/0.4.2/guides-references/hauler-collections/overview"},next:{title:"Images",permalink:"/hauler-docs/docs/0.4.2/guides-references/hauler-content/images"}},a={},u=[];function l(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,r.jsx)(t.p,{children:"Hauler Content Overview Documentation pending a future release!"})}function d(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>c});var r=n(6540);const o={},i=r.createContext(o);function s(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bec068c2.65d3eae3.js b/assets/js/bec068c2.65d3eae3.js new file mode 100644 index 000000000..e6f8045ab --- /dev/null +++ b/assets/js/bec068c2.65d3eae3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8792],{8540:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>a});var r=n(4848),o=n(8453);const i={title:"Overview of Hauler Content",description:"Hauler Content Documentation",sidebar_label:"Overview"},s=void 0,c={id:"guides-references/hauler-content/overview",title:"Overview of Hauler Content",description:"Hauler Content Documentation",source:"@site/versioned_docs/version-0.4.2/guides-references/hauler-content/overview.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/overview",permalink:"/docs/0.4.2/guides-references/hauler-content/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.2/guides-references/hauler-content/overview.md",tags:[],version:"0.4.2",frontMatter:{title:"Overview of Hauler Content",description:"Hauler Content Documentation",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/docs/0.4.2/guides-references/hauler-collections/overview"},next:{title:"Images",permalink:"/docs/0.4.2/guides-references/hauler-content/images"}},u={},a=[];function l(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,r.jsx)(t.p,{children:"Hauler Content Overview Documentation pending a future release!"})}function d(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>c});var r=n(6540);const o={},i=r.createContext(o);function s(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c1ae016a.47fcf120.js b/assets/js/c1ae016a.47fcf120.js new file mode 100644 index 000000000..a7945c6ff --- /dev/null +++ b/assets/js/c1ae016a.47fcf120.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4007],{9452:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>s,metadata:()=>i,toc:()=>d});var r=n(4848),l=n(8453);const s={title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},a=void 0,i={id:"introduction/install",title:"Installation",description:"Installation Documentation for Hauler",source:"@site/versioned_docs/version-0.4.4/introduction/install.md",sourceDirName:"introduction",slug:"/introduction/install",permalink:"/docs/0.4.4/introduction/install",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.4/introduction/install.md",tags:[],version:"0.4.4",frontMatter:{title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},sidebar:"haulerSidebar",previous:{title:"Quickstart",permalink:"/docs/0.4.4/introduction/quickstart"},next:{title:"Uninstall",permalink:"/docs/0.4.4/introduction/uninstall"}},c={},d=[{value:"Overview",id:"overview",level:2},{value:"Supported Architectures",id:"supported-architectures",level:2},{value:"Installation Steps",id:"installation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin",level:3},{value:"Homebrew",id:"homebrew",level:3},{value:"Windows",id:"windows",level:3},{value:"Manual Installation Steps",id:"manual-installation-steps",level:2}];function o(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h2,{id:"overview",children:"Overview"}),"\n",(0,r.jsxs)(t.p,{children:["Hauler is a purpose built to be a single binary with no specific prerequistes or depedencies. It's installation is very simple and easy to follow. To view the latest release, please view our ",(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"GitHub Release"})," page."]}),"\n",(0,r.jsx)(t.h2,{id:"supported-architectures",children:"Supported Architectures"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Base Platform"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Architecture"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Latest Release"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Linux"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Darwin"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Windows"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]})]})]}),"\n",(0,r.jsx)(t.h2,{id:"installation-steps",children:"Installation Steps"}),"\n",(0,r.jsx)(t.h3,{id:"linuxdarwin",children:"Linux/Darwin"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n\n# install specific release\ncurl -sfL https://get.hauler.dev | HAULER_VERSION=0.4.4 bash\n"})}),"\n",(0,r.jsx)(t.h3,{id:"homebrew",children:"Homebrew"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# installs latest release\nbrew tap rancherfederal/homebrew-tap\nbrew install hauler\n"})}),"\n",(0,r.jsx)(t.h3,{id:"windows",children:"Windows"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,r.jsx)(t.h2,{id:"manual-installation-steps",children:"Manual Installation Steps"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:'# set the hauler version (i.e. "0.4.4")\nexport vHauler=HAULER_VERSION\n\n# set the specific platform (i.e. "linux")\nexport platform=PLATFORM\n\n# set the specific arch (i.e. "amd64")\nexport arch=ARCH\n\ncurl -sOL https://github.com/rancherfederal/hauler/releases/download/v${vHauler}/hauler_${vHauler}_${platform}_${arch}.tar.gz\ntar -xf hauler_${vHauler}_${platform}_${arch}.tar.gz\nsudo mv hauler /usr/bin/hauler\n'})})]})}function h(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>i});var r=n(6540);const l={},s=r.createContext(l);function a(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:a(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c1ae016a.56eff21c.js b/assets/js/c1ae016a.56eff21c.js deleted file mode 100644 index 1afb539e7..000000000 --- a/assets/js/c1ae016a.56eff21c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4007],{9452:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>s,metadata:()=>i,toc:()=>d});var r=n(4848),l=n(8453);const s={title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},a=void 0,i={id:"introduction/install",title:"Installation",description:"Installation Documentation for Hauler",source:"@site/versioned_docs/version-0.4.4/introduction/install.md",sourceDirName:"introduction",slug:"/introduction/install",permalink:"/hauler-docs/docs/0.4.4/introduction/install",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.4/introduction/install.md",tags:[],version:"0.4.4",frontMatter:{title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},sidebar:"haulerSidebar",previous:{title:"Quickstart",permalink:"/hauler-docs/docs/0.4.4/introduction/quickstart"},next:{title:"Uninstall",permalink:"/hauler-docs/docs/0.4.4/introduction/uninstall"}},c={},d=[{value:"Overview",id:"overview",level:2},{value:"Supported Architectures",id:"supported-architectures",level:2},{value:"Installation Steps",id:"installation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin",level:3},{value:"Homebrew",id:"homebrew",level:3},{value:"Windows",id:"windows",level:3},{value:"Manual Installation Steps",id:"manual-installation-steps",level:2}];function o(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h2,{id:"overview",children:"Overview"}),"\n",(0,r.jsxs)(t.p,{children:["Hauler is a purpose built to be a single binary with no specific prerequistes or depedencies. It's installation is very simple and easy to follow. To view the latest release, please view our ",(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"GitHub Release"})," page."]}),"\n",(0,r.jsx)(t.h2,{id:"supported-architectures",children:"Supported Architectures"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Base Platform"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Architecture"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Latest Release"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Linux"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Darwin"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Windows"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]})]})]}),"\n",(0,r.jsx)(t.h2,{id:"installation-steps",children:"Installation Steps"}),"\n",(0,r.jsx)(t.h3,{id:"linuxdarwin",children:"Linux/Darwin"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n\n# install specific release\ncurl -sfL https://get.hauler.dev | HAULER_VERSION=0.4.4 bash\n"})}),"\n",(0,r.jsx)(t.h3,{id:"homebrew",children:"Homebrew"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# installs latest release\nbrew tap rancherfederal/homebrew-tap\nbrew install hauler\n"})}),"\n",(0,r.jsx)(t.h3,{id:"windows",children:"Windows"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,r.jsx)(t.h2,{id:"manual-installation-steps",children:"Manual Installation Steps"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:'# set the hauler version (i.e. "0.4.4")\nexport vHauler=HAULER_VERSION\n\n# set the specific platform (i.e. "linux")\nexport platform=PLATFORM\n\n# set the specific arch (i.e. "amd64")\nexport arch=ARCH\n\ncurl -sOL https://github.com/rancherfederal/hauler/releases/download/v${vHauler}/hauler_${vHauler}_${platform}_${arch}.tar.gz\ntar -xf hauler_${vHauler}_${platform}_${arch}.tar.gz\nsudo mv hauler /usr/bin/hauler\n'})})]})}function h(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>i});var r=n(6540);const l={},s=r.createContext(l);function a(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:a(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c24b511b.08059dac.js b/assets/js/c24b511b.08059dac.js new file mode 100644 index 000000000..9697ae645 --- /dev/null +++ b/assets/js/c24b511b.08059dac.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3413],{3855:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>s,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>c});var a=i(4848),r=i(8453);const t={title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},s=void 0,o={id:"airgap-workflow",title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",source:"@site/versioned_docs/version-1.0.0/airgap-workflow.md",sourceDirName:".",slug:"/airgap-workflow",permalink:"/docs/1.0.0/airgap-workflow",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.0/airgap-workflow.md",tags:[],version:"1.0.0",frontMatter:{title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},sidebar:"haulerSidebar",previous:{title:"Core Concepts",permalink:"/docs/1.0.0/core-concepts"},next:{title:"Quickstart",permalink:"/docs/1.0.0/introduction/quickstart"}},l={},c=[{value:"Workflow Diagram",id:"workflow-diagram",level:2},{value:"What's an Airgap?",id:"whats-an-airgap",level:2},{value:"Example Use Cases",id:"example-use-cases",level:3},{value:"Challenges of an Airgap",id:"challenges-of-an-airgap",level:2}];function d(e){const n={h2:"h2",h3:"h3",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h2,{id:"workflow-diagram",children:"Workflow Diagram"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.img,{alt:"hauler-workflow-diagram",src:i(8010).A+"",width:"2883",height:"1013"})}),"\n",(0,a.jsx)(n.h2,{id:"whats-an-airgap",children:"What's an Airgap?"}),"\n",(0,a.jsx)(n.p,{children:"An airgap is a highly secure environment that is physically isolated from external connectivity (usually the internet), ensuring complete isolation from other environments by preventing unauthorized access or data transfers."}),"\n",(0,a.jsx)(n.h3,{id:"example-use-cases",children:"Example Use Cases"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"Government and Military:"})," These airgaps protect sensitive government and military information and critical defense infrastructure, ensuring that classified data remains secure and inaccessible to unauthorized entities."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"Critical Infrastructure:"})," These airgaps secure power grids, water supply systems, and transportation networks from cyber threats, shielding them from potential disruptions and ensuring their continuous operation."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"Financial Institutions:"})," These airgaps safeguard financial transactions and customer data from cyberattacks, maintaining the trust and integrity of financial systems."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"Research Facilities:"})," These airgaps protect valuable research data, intellectual property, and proprietary information, preserving the integrity and confidentiality of research efforts."]}),"\n"]}),"\n",(0,a.jsx)(n.h2,{id:"challenges-of-an-airgap",children:"Challenges of an Airgap"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"Data Transfers:"})," Transferring data in and out of an airgapped system is complex due to the lack of network connectivity, often necessitating the use of physical media, trusted intermediaries, and meticulous approval processes to ensure data security."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"Usability vs. Security Balance:"})," Balancing security with usability in airgapped environments can be intricate, as the limited convenience poses challenges for user interactions and system operations."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"Maintenance Complexity:"})," Regular system updates, package and dependency updates, and overall maintenance can be challenging in airgapped systems, as the limited network connectivity complicates the process, requiring meticulous planning and execution."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"Costly Implementation:"})," Implementing and maintaining airgapped systems can be costly, demanding specialized workflows, protocols, and security measures to uphold the system's integrity and security."]}),"\n"]})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},8010:(e,n,i)=>{i.d(n,{A:()=>a});const a=i.p+"assets/images/hauler-workflow-diagram-a0761cc99fb86b21c4ca1a7d8a31dfc4.png"},8453:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>o});var a=i(6540);const r={},t=a.createContext(r);function s(e){const n=a.useContext(t);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),a.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c24b511b.eb3adac1.js b/assets/js/c24b511b.eb3adac1.js deleted file mode 100644 index 94e76d1c0..000000000 --- a/assets/js/c24b511b.eb3adac1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3413],{3855:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>l,contentTitle:()=>s,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>c});var i=a(4848),r=a(8453);const t={title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},s=void 0,o={id:"airgap-workflow",title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",source:"@site/versioned_docs/version-1.0.0/airgap-workflow.md",sourceDirName:".",slug:"/airgap-workflow",permalink:"/hauler-docs/docs/1.0.0/airgap-workflow",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.0/airgap-workflow.md",tags:[],version:"1.0.0",frontMatter:{title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},sidebar:"haulerSidebar",previous:{title:"Core Concepts",permalink:"/hauler-docs/docs/1.0.0/core-concepts"},next:{title:"Quickstart",permalink:"/hauler-docs/docs/1.0.0/introduction/quickstart"}},l={},c=[{value:"Workflow Diagram",id:"workflow-diagram",level:2},{value:"What's an Airgap?",id:"whats-an-airgap",level:2},{value:"Example Use Cases",id:"example-use-cases",level:3},{value:"Challenges of an Airgap",id:"challenges-of-an-airgap",level:2}];function d(e){const n={h2:"h2",h3:"h3",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"workflow-diagram",children:"Workflow Diagram"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"hauler-workflow-diagram",src:a(8010).A+"",width:"2883",height:"1013"})}),"\n",(0,i.jsx)(n.h2,{id:"whats-an-airgap",children:"What's an Airgap?"}),"\n",(0,i.jsx)(n.p,{children:"An airgap is a highly secure environment that is physically isolated from external connectivity (usually the internet), ensuring complete isolation from other environments by preventing unauthorized access or data transfers."}),"\n",(0,i.jsx)(n.h3,{id:"example-use-cases",children:"Example Use Cases"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Government and Military:"})," These airgaps protect sensitive government and military information and critical defense infrastructure, ensuring that classified data remains secure and inaccessible to unauthorized entities."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Critical Infrastructure:"})," These airgaps secure power grids, water supply systems, and transportation networks from cyber threats, shielding them from potential disruptions and ensuring their continuous operation."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Financial Institutions:"})," These airgaps safeguard financial transactions and customer data from cyberattacks, maintaining the trust and integrity of financial systems."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Research Facilities:"})," These airgaps protect valuable research data, intellectual property, and proprietary information, preserving the integrity and confidentiality of research efforts."]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"challenges-of-an-airgap",children:"Challenges of an Airgap"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Data Transfers:"})," Transferring data in and out of an airgapped system is complex due to the lack of network connectivity, often necessitating the use of physical media, trusted intermediaries, and meticulous approval processes to ensure data security."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Usability vs. Security Balance:"})," Balancing security with usability in airgapped environments can be intricate, as the limited convenience poses challenges for user interactions and system operations."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Maintenance Complexity:"})," Regular system updates, package and dependency updates, and overall maintenance can be challenging in airgapped systems, as the limited network connectivity complicates the process, requiring meticulous planning and execution."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Costly Implementation:"})," Implementing and maintaining airgapped systems can be costly, demanding specialized workflows, protocols, and security measures to uphold the system's integrity and security."]}),"\n"]})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},8010:(e,n,a)=>{a.d(n,{A:()=>i});const i=a.p+"assets/images/hauler-workflow-diagram-a0761cc99fb86b21c4ca1a7d8a31dfc4.png"},8453:(e,n,a)=>{a.d(n,{R:()=>s,x:()=>o});var i=a(6540);const r={},t=i.createContext(r);function s(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c3e6124d.7c85ef08.js b/assets/js/c3e6124d.7c85ef08.js new file mode 100644 index 000000000..8774c3eb3 --- /dev/null +++ b/assets/js/c3e6124d.7c85ef08.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[941],{9147:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>c,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var s=n(4848),r=n(8453);const o={title:"Feedback",description:"Feedback for Hauler",sidebar_label:"Feedback"},c=void 0,a={id:"feedback",title:"Feedback",description:"Feedback for Hauler",source:"@site/docs/feedback.md",sourceDirName:".",slug:"/feedback",permalink:"/docs/next/feedback",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/docs/feedback.md",tags:[],version:"current",frontMatter:{title:"Feedback",description:"Feedback for Hauler",sidebar_label:"Feedback"},sidebar:"haulerSidebar",previous:{title:"Known Issues/Limits",permalink:"/docs/next/known-limits"}},i={},d=[];function u(e){const t={a:"a",code:"code",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(t.p,{children:["Feedback is ",(0,s.jsx)(t.strong,{children:"critical"})," to us to continue to improve ",(0,s.jsx)(t.code,{children:"Hauler"})," and accelerate your mission."]}),"\n",(0,s.jsxs)(t.p,{children:["For any issues, concerns, or questions, please open an issue: ",(0,s.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/issues",children:"https://github.com/rancherfederal/hauler/issues"})]})]})}function l(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>c,x:()=>a});var s=n(6540);const r={},o=s.createContext(r);function c(e){const t=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),s.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c3e6124d.d8730edf.js b/assets/js/c3e6124d.d8730edf.js deleted file mode 100644 index 77c0a56e1..000000000 --- a/assets/js/c3e6124d.d8730edf.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[941],{9147:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>l,frontMatter:()=>c,metadata:()=>a,toc:()=>d});var r=n(4848),s=n(8453);const c={title:"Feedback",description:"Feedback for Hauler",sidebar_label:"Feedback"},o=void 0,a={id:"feedback",title:"Feedback",description:"Feedback for Hauler",source:"@site/docs/feedback.md",sourceDirName:".",slug:"/feedback",permalink:"/hauler-docs/docs/next/feedback",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/docs/feedback.md",tags:[],version:"current",frontMatter:{title:"Feedback",description:"Feedback for Hauler",sidebar_label:"Feedback"},sidebar:"haulerSidebar",previous:{title:"Known Issues/Limits",permalink:"/hauler-docs/docs/next/known-limits"}},i={},d=[];function u(e){const t={a:"a",code:"code",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsxs)(t.p,{children:["Feedback is ",(0,r.jsx)(t.strong,{children:"critical"})," to us to continue to improve ",(0,r.jsx)(t.code,{children:"Hauler"})," and accelerate your mission."]}),"\n",(0,r.jsxs)(t.p,{children:["For any issues, concerns, or questions, please open an issue: ",(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/issues",children:"https://github.com/rancherfederal/hauler/issues"})]})]})}function l(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>a});var r=n(6540);const s={},c=r.createContext(s);function o(e){const t=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c45a31f6.9b935f82.js b/assets/js/c45a31f6.9b935f82.js deleted file mode 100644 index 39df8a397..000000000 --- a/assets/js/c45a31f6.9b935f82.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2032],{3177:(n,t,e)=>{e.r(t),e.d(t,{assets:()=>a,contentTitle:()=>s,default:()=>d,frontMatter:()=>r,metadata:()=>l,toc:()=>c});var o=e(4848),i=e(8453);const r={title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},s=void 0,l={id:"introduction/uninstall",title:"Uninstall",description:"Uninstall Documentation for Hauler",source:"@site/versioned_docs/version-0.4.0/introduction/uninstall.md",sourceDirName:"introduction",slug:"/introduction/uninstall",permalink:"/hauler-docs/docs/0.4.0/introduction/uninstall",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.0/introduction/uninstall.md",tags:[],version:"0.4.0",frontMatter:{title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},sidebar:"haulerSidebar",previous:{title:"Installation",permalink:"/hauler-docs/docs/0.4.0/introduction/install"},next:{title:"Overview",permalink:"/hauler-docs/docs/0.4.0/guides-references/overview"}},a={},c=[];function u(n){const t={p:"p",...(0,i.R)(),...n.components};return(0,o.jsx)(t.p,{children:"Uninstall Documentation pending a future release!"})}function d(n={}){const{wrapper:t}={...(0,i.R)(),...n.components};return t?(0,o.jsx)(t,{...n,children:(0,o.jsx)(u,{...n})}):u(n)}},8453:(n,t,e)=>{e.d(t,{R:()=>s,x:()=>l});var o=e(6540);const i={},r=o.createContext(i);function s(n){const t=o.useContext(r);return o.useMemo((function(){return"function"==typeof n?n(t):{...t,...n}}),[t,n])}function l(n){let t;return t=n.disableParentContext?"function"==typeof n.components?n.components(i):n.components||i:s(n.components),o.createElement(r.Provider,{value:t},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/c45a31f6.b8d6ce86.js b/assets/js/c45a31f6.b8d6ce86.js new file mode 100644 index 000000000..e3ef5c4b2 --- /dev/null +++ b/assets/js/c45a31f6.b8d6ce86.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2032],{3177:(n,t,e)=>{e.r(t),e.d(t,{assets:()=>a,contentTitle:()=>s,default:()=>d,frontMatter:()=>r,metadata:()=>l,toc:()=>c});var i=e(4848),o=e(8453);const r={title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},s=void 0,l={id:"introduction/uninstall",title:"Uninstall",description:"Uninstall Documentation for Hauler",source:"@site/versioned_docs/version-0.4.0/introduction/uninstall.md",sourceDirName:"introduction",slug:"/introduction/uninstall",permalink:"/docs/0.4.0/introduction/uninstall",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.0/introduction/uninstall.md",tags:[],version:"0.4.0",frontMatter:{title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},sidebar:"haulerSidebar",previous:{title:"Installation",permalink:"/docs/0.4.0/introduction/install"},next:{title:"Overview",permalink:"/docs/0.4.0/guides-references/overview"}},a={},c=[];function u(n){const t={p:"p",...(0,o.R)(),...n.components};return(0,i.jsx)(t.p,{children:"Uninstall Documentation pending a future release!"})}function d(n={}){const{wrapper:t}={...(0,o.R)(),...n.components};return t?(0,i.jsx)(t,{...n,children:(0,i.jsx)(u,{...n})}):u(n)}},8453:(n,t,e)=>{e.d(t,{R:()=>s,x:()=>l});var i=e(6540);const o={},r=i.createContext(o);function s(n){const t=i.useContext(r);return i.useMemo((function(){return"function"==typeof n?n(t):{...t,...n}}),[t,n])}function l(n){let t;return t=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:s(n.components),i.createElement(r.Provider,{value:t},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/c47a16f3.6baa0127.js b/assets/js/c47a16f3.6baa0127.js deleted file mode 100644 index ab7517757..000000000 --- a/assets/js/c47a16f3.6baa0127.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2378],{9188:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>s,contentTitle:()=>o,default:()=>d,frontMatter:()=>t,metadata:()=>l,toc:()=>c});var r=a(4848),i=a(8453);const t={title:"Hauler Content - Images",description:"Hauler Content - Images Documentation",sidebar_label:"Images"},o=void 0,l={id:"guides-references/hauler-content/images",title:"Hauler Content - Images",description:"Hauler Content - Images Documentation",source:"@site/versioned_docs/version-1.0.x/guides-references/hauler-content/images.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/images",permalink:"/hauler-docs/docs/guides-references/hauler-content/images",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/hauler-content/images.md",tags:[],version:"1.0.x",frontMatter:{title:"Hauler Content - Images",description:"Hauler Content - Images Documentation",sidebar_label:"Images"},sidebar:"haulerSidebar",previous:{title:"Community Collections",permalink:"/hauler-docs/docs/guides-references/hauler-collections/community-collections"},next:{title:"Charts",permalink:"/hauler-docs/docs/guides-references/hauler-content/charts"}},s={},c=[{value:"Hauler Command Line for Images",id:"hauler-command-line-for-images",level:2},{value:"Example Commands for Images",id:"example-commands-for-images",level:2},{value:"Hauler Manifest for Images",id:"hauler-manifest-for-images",level:2},{value:"Example Manifest for Images",id:"example-manifest-for-images",level:2}];function m(e){const n={code:"code",h2:"h2",pre:"pre",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"hauler-command-line-for-images",children:"Hauler Command Line for Images"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"hauler store add image --platform --key \n"})}),"\n",(0,r.jsx)(n.h2,{id:"example-commands-for-images",children:"Example Commands for Images"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"# fetch image\nhauler store add image neuvector/scanner\n\n# fetch image with full image reference\nhauler store add image name: docker.io/neuvector/updater:latest\n\n# fetch image with full image reference with digest\nhauler store add image docker.io/neuvector/updater@sha256:0076b356368c9988eec5f3cead771d29a377074b982f22800f4d9c8c3b215a56\n\n# fetch image with full image reference, specific version, specific platform\nhauler store add image docker.io/longhornio/longhorn-ui:v1.6.0 --platform: linux/amd64\n\n# fetch image with full image reference, specific version, specific platform, and signature verification\nhauler store add image docker.io/longhornio/longhorn-manager:v1.6.0 --platform linux/amd64 --key cosign-public-key.pub\n"})}),"\n",(0,r.jsx)(n.h2,{id:"hauler-manifest-for-images",children:"Hauler Manifest for Images"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-image-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\n annotations:\n # global flags for all images in the manifest\n # image flags override global flags\n hauler.dev/key: \n hauler.dev/platform: \n hauler.dev/registry: \nspec:\n images:\n - name: \n key: \n platform: \n"})}),"\n",(0,r.jsx)(n.h2,{id:"example-manifest-for-images",children:"Example Manifest for Images"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-image-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\n annotations:\n # global flags for all images in the manifest\n # image flags override global flags\n hauler.dev/key: \n hauler.dev/platform: \n hauler.dev/registry: \nspec:\n images:\n # fetch image\n - name: neuvector/scanner\n # fetch image with full image reference\n - name: docker.io/neuvector/updater:latest\n # fetch image with full image reference with digest\n - name: docker.io/neuvector/updater@sha256:0076b356368c9988eec5f3cead771d29a377074b982f22800f4d9c8c3b215a56\n # fetch image with full image reference, specific version, specific platform\n - name: docker.io/longhornio/longhorn-ui:v1.6.0\n platform: linux/amd64\n # fetch image with full image reference, specific version, specific platform, and signature verification\n - name: docker.io/longhornio/longhorn-manager:v1.6.0\n key: cosign-public-key.pub\n platform: linux/amd64\n"})})]})}function d(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(m,{...e})}):m(e)}},8453:(e,n,a)=>{a.d(n,{R:()=>o,x:()=>l});var r=a(6540);const i={},t=r.createContext(i);function o(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c47a16f3.d5caacde.js b/assets/js/c47a16f3.d5caacde.js new file mode 100644 index 000000000..8cb9ea2d1 --- /dev/null +++ b/assets/js/c47a16f3.d5caacde.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2378],{9188:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>s,contentTitle:()=>o,default:()=>d,frontMatter:()=>t,metadata:()=>l,toc:()=>c});var r=a(4848),i=a(8453);const t={title:"Hauler Content - Images",description:"Hauler Content - Images Documentation",sidebar_label:"Images"},o=void 0,l={id:"guides-references/hauler-content/images",title:"Hauler Content - Images",description:"Hauler Content - Images Documentation",source:"@site/versioned_docs/version-1.0.x/guides-references/hauler-content/images.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/images",permalink:"/docs/guides-references/hauler-content/images",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/hauler-content/images.md",tags:[],version:"1.0.x",frontMatter:{title:"Hauler Content - Images",description:"Hauler Content - Images Documentation",sidebar_label:"Images"},sidebar:"haulerSidebar",previous:{title:"Community Collections",permalink:"/docs/guides-references/hauler-collections/community-collections"},next:{title:"Charts",permalink:"/docs/guides-references/hauler-content/charts"}},s={},c=[{value:"Hauler Command Line for Images",id:"hauler-command-line-for-images",level:2},{value:"Example Commands for Images",id:"example-commands-for-images",level:2},{value:"Hauler Manifest for Images",id:"hauler-manifest-for-images",level:2},{value:"Example Manifest for Images",id:"example-manifest-for-images",level:2}];function m(e){const n={code:"code",h2:"h2",pre:"pre",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"hauler-command-line-for-images",children:"Hauler Command Line for Images"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"hauler store add image --platform --key \n"})}),"\n",(0,r.jsx)(n.h2,{id:"example-commands-for-images",children:"Example Commands for Images"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"# fetch image\nhauler store add image neuvector/scanner\n\n# fetch image with full image reference\nhauler store add image name: docker.io/neuvector/updater:latest\n\n# fetch image with full image reference with digest\nhauler store add image docker.io/neuvector/updater@sha256:0076b356368c9988eec5f3cead771d29a377074b982f22800f4d9c8c3b215a56\n\n# fetch image with full image reference, specific version, specific platform\nhauler store add image docker.io/longhornio/longhorn-ui:v1.6.0 --platform: linux/amd64\n\n# fetch image with full image reference, specific version, specific platform, and signature verification\nhauler store add image docker.io/longhornio/longhorn-manager:v1.6.0 --platform linux/amd64 --key cosign-public-key.pub\n"})}),"\n",(0,r.jsx)(n.h2,{id:"hauler-manifest-for-images",children:"Hauler Manifest for Images"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-image-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\n annotations:\n # global flags for all images in the manifest\n # image flags override global flags\n hauler.dev/key: \n hauler.dev/platform: \n hauler.dev/registry: \nspec:\n images:\n - name: \n key: \n platform: \n"})}),"\n",(0,r.jsx)(n.h2,{id:"example-manifest-for-images",children:"Example Manifest for Images"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-image-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\n annotations:\n # global flags for all images in the manifest\n # image flags override global flags\n hauler.dev/key: \n hauler.dev/platform: \n hauler.dev/registry: \nspec:\n images:\n # fetch image\n - name: neuvector/scanner\n # fetch image with full image reference\n - name: docker.io/neuvector/updater:latest\n # fetch image with full image reference with digest\n - name: docker.io/neuvector/updater@sha256:0076b356368c9988eec5f3cead771d29a377074b982f22800f4d9c8c3b215a56\n # fetch image with full image reference, specific version, specific platform\n - name: docker.io/longhornio/longhorn-ui:v1.6.0\n platform: linux/amd64\n # fetch image with full image reference, specific version, specific platform, and signature verification\n - name: docker.io/longhornio/longhorn-manager:v1.6.0\n key: cosign-public-key.pub\n platform: linux/amd64\n"})})]})}function d(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(m,{...e})}):m(e)}},8453:(e,n,a)=>{a.d(n,{R:()=>o,x:()=>l});var r=a(6540);const i={},t=r.createContext(i);function o(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c4c39368.13f4c15c.js b/assets/js/c4c39368.13f4c15c.js deleted file mode 100644 index 413484bd0..000000000 --- a/assets/js/c4c39368.13f4c15c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7810],{3151:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var i=n(4848),t=n(8453);const r={title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},o=void 0,a={id:"known-limits",title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",source:"@site/versioned_docs/version-0.4.1/known-limits.md",sourceDirName:".",slug:"/known-limits",permalink:"/hauler-docs/docs/0.4.1/known-limits",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.1/known-limits.md",tags:[],version:"0.4.1",frontMatter:{title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},sidebar:"haulerSidebar",previous:{title:"Hauler Version",permalink:"/hauler-docs/docs/0.4.1/guides-references/command-line/hauler-version"}},l={},c=[{value:"Issues",id:"issues",level:2},{value:"Limitations",id:"limitations",level:2},{value:"Notices",id:"notices",level:2},{value:"Upcoming Deprecated Command(s):",id:"upcoming-deprecated-commands",level:4}];function d(e){const s={a:"a",code:"code",h2:"h2",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h2,{id:"issues",children:"Issues"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Copying SBOMS to AWS Elastic Container Registry (AWS ECR):","\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["When using ",(0,i.jsx)(s.code,{children:"hauler store copy"})," to AWS ECR, the Software Bill of Materials (SBOM) attachement will fail to copy due to changes in the way ",(0,i.jsx)(s.code,{children:"cosign"})," handles attachments. ",(0,i.jsx)(s.strong,{children:"We are investigating a way forward to address this issue."})]}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"https://github.com/sigstore/cosign/blob/main/specs/SBOM_SPEC.md",children:"https://github.com/sigstore/cosign/blob/main/specs/SBOM_SPEC.md"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"https://github.com/sigstore/cosign/issues/2755",children:"https://github.com/sigstore/cosign/issues/2755"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"limitations",children:"Limitations"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Display of Information in the Hauler Store:","\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["When using ",(0,i.jsx)(s.code,{children:"hauler store info"})," with signature verification, you may encounter errors in the presentation of the number layers and size of layers in the store. Hauler is correctly fetching, storing, packaging, and distributing each image, but the presentation and display can error. ",(0,i.jsx)(s.strong,{children:"We are actively working to address and fix this issue."})]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"notices",children:"Notices"}),"\n",(0,i.jsx)(s.h4,{id:"upcoming-deprecated-commands",children:"Upcoming Deprecated Command(s):"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.code,{children:"hauler download"})," (alternatively ",(0,i.jsx)(s.code,{children:"hauler dl"}),") is deprecated and will be removed in a future release."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.code,{children:"hauler serve"})," is deprecated and will be removed in a future release."]}),"\n"]})]})}function u(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>o,x:()=>a});var i=n(6540);const t={},r=i.createContext(t);function o(e){const s=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c4c39368.65420173.js b/assets/js/c4c39368.65420173.js new file mode 100644 index 000000000..a15e7dbcf --- /dev/null +++ b/assets/js/c4c39368.65420173.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7810],{3151:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var i=n(4848),t=n(8453);const r={title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},o=void 0,a={id:"known-limits",title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",source:"@site/versioned_docs/version-0.4.1/known-limits.md",sourceDirName:".",slug:"/known-limits",permalink:"/docs/0.4.1/known-limits",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.1/known-limits.md",tags:[],version:"0.4.1",frontMatter:{title:"Known Issues and Limits",description:"Known Issues and Limitations for Hauler",sidebar_label:"Known Issues/Limits"},sidebar:"haulerSidebar",previous:{title:"Hauler Version",permalink:"/docs/0.4.1/guides-references/command-line/hauler-version"}},l={},d=[{value:"Issues",id:"issues",level:2},{value:"Limitations",id:"limitations",level:2},{value:"Notices",id:"notices",level:2},{value:"Upcoming Deprecated Command(s):",id:"upcoming-deprecated-commands",level:4}];function c(e){const s={a:"a",code:"code",h2:"h2",h4:"h4",li:"li",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.h2,{id:"issues",children:"Issues"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Copying SBOMS to AWS Elastic Container Registry (AWS ECR):","\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["When using ",(0,i.jsx)(s.code,{children:"hauler store copy"})," to AWS ECR, the Software Bill of Materials (SBOM) attachement will fail to copy due to changes in the way ",(0,i.jsx)(s.code,{children:"cosign"})," handles attachments. ",(0,i.jsx)(s.strong,{children:"We are investigating a way forward to address this issue."})]}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"https://github.com/sigstore/cosign/blob/main/specs/SBOM_SPEC.md",children:"https://github.com/sigstore/cosign/blob/main/specs/SBOM_SPEC.md"})}),"\n",(0,i.jsx)(s.li,{children:(0,i.jsx)(s.a,{href:"https://github.com/sigstore/cosign/issues/2755",children:"https://github.com/sigstore/cosign/issues/2755"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"limitations",children:"Limitations"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Display of Information in the Hauler Store:","\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["When using ",(0,i.jsx)(s.code,{children:"hauler store info"})," with signature verification, you may encounter errors in the presentation of the number layers and size of layers in the store. Hauler is correctly fetching, storing, packaging, and distributing each image, but the presentation and display can error. ",(0,i.jsx)(s.strong,{children:"We are actively working to address and fix this issue."})]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"notices",children:"Notices"}),"\n",(0,i.jsx)(s.h4,{id:"upcoming-deprecated-commands",children:"Upcoming Deprecated Command(s):"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.code,{children:"hauler download"})," (alternatively ",(0,i.jsx)(s.code,{children:"hauler dl"}),") is deprecated and will be removed in a future release."]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.code,{children:"hauler serve"})," is deprecated and will be removed in a future release."]}),"\n"]})]})}function u(e={}){const{wrapper:s}={...(0,t.R)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,s,n)=>{n.d(s,{R:()=>o,x:()=>a});var i=n(6540);const t={},r=i.createContext(t);function o(e){const s=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c50bb318.7daa2458.js b/assets/js/c50bb318.7daa2458.js new file mode 100644 index 000000000..1a5cb717a --- /dev/null +++ b/assets/js/c50bb318.7daa2458.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1759],{714:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>c,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var s=n(4848),r=n(8453);const o={title:"Feedback",description:"Feedback for Hauler",sidebar_label:"Feedback"},c=void 0,a={id:"feedback",title:"Feedback",description:"Feedback for Hauler",source:"@site/versioned_docs/version-1.0.0/feedback.md",sourceDirName:".",slug:"/feedback",permalink:"/docs/1.0.0/feedback",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.0/feedback.md",tags:[],version:"1.0.0",frontMatter:{title:"Feedback",description:"Feedback for Hauler",sidebar_label:"Feedback"},sidebar:"haulerSidebar",previous:{title:"Known Issues/Limits",permalink:"/docs/1.0.0/known-limits"}},i={},d=[];function u(e){const t={a:"a",code:"code",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(t.p,{children:["Feedback is ",(0,s.jsx)(t.strong,{children:"critical"})," to us to continue to improve ",(0,s.jsx)(t.code,{children:"Hauler"})," and accelerate your mission."]}),"\n",(0,s.jsxs)(t.p,{children:["For any issues, concerns, or questions, please open an issue: ",(0,s.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/issues",children:"https://github.com/rancherfederal/hauler/issues"})]})]})}function l(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>c,x:()=>a});var s=n(6540);const r={},o=s.createContext(r);function c(e){const t=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),s.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c50bb318.96ded087.js b/assets/js/c50bb318.96ded087.js deleted file mode 100644 index fc8908588..000000000 --- a/assets/js/c50bb318.96ded087.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1759],{714:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>i,contentTitle:()=>c,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var n=s(4848),r=s(8453);const o={title:"Feedback",description:"Feedback for Hauler",sidebar_label:"Feedback"},c=void 0,a={id:"feedback",title:"Feedback",description:"Feedback for Hauler",source:"@site/versioned_docs/version-1.0.0/feedback.md",sourceDirName:".",slug:"/feedback",permalink:"/hauler-docs/docs/1.0.0/feedback",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.0/feedback.md",tags:[],version:"1.0.0",frontMatter:{title:"Feedback",description:"Feedback for Hauler",sidebar_label:"Feedback"},sidebar:"haulerSidebar",previous:{title:"Known Issues/Limits",permalink:"/hauler-docs/docs/1.0.0/known-limits"}},i={},d=[];function u(e){const t={a:"a",code:"code",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(t.p,{children:["Feedback is ",(0,n.jsx)(t.strong,{children:"critical"})," to us to continue to improve ",(0,n.jsx)(t.code,{children:"Hauler"})," and accelerate your mission."]}),"\n",(0,n.jsxs)(t.p,{children:["For any issues, concerns, or questions, please open an issue: ",(0,n.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/issues",children:"https://github.com/rancherfederal/hauler/issues"})]})]})}function l(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>c,x:()=>a});var n=s(6540);const r={},o=n.createContext(r);function c(e){const t=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),n.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c54e2943.9261fdd8.js b/assets/js/c54e2943.9261fdd8.js new file mode 100644 index 000000000..d58b30f29 --- /dev/null +++ b/assets/js/c54e2943.9261fdd8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9182],{6005:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>t,toc:()=>c});var l=o(4848),s=o(8453);const r={title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},i=void 0,t={id:"guides-references/command-line/hauler-completion",title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",source:"@site/versioned_docs/version-0.4.1/guides-references/command-line/hauler-completion.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-completion",permalink:"/docs/0.4.1/guides-references/command-line/hauler-completion",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.1/guides-references/command-line/hauler-completion.md",tags:[],version:"0.4.1",frontMatter:{title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},sidebar:"haulerSidebar",previous:{title:"Hauler Store",permalink:"/docs/0.4.1/guides-references/command-line/hauler-store"},next:{title:"Hauler Version",permalink:"/docs/0.4.1/guides-references/command-line/hauler-version"}},a={},c=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler completion bash:",id:"hauler-completion-bash",level:4},{value:"hauler completion fish:",id:"hauler-completion-fish",level:4},{value:"hauler completion powershell:",id:"hauler-completion-powershell",level:4},{value:"hauler completion zsh:",id:"hauler-completion-zsh",level:4}];function h(e){const n={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"Generate an autocompletion script for hauler for the specified shell."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler completion [command]\n\nAvailable Commands:\n bash Generate the autocompletion script for bash\n fish Generate the autocompletion script for fish\n powershell Generate the autocompletion script for powershell\n zsh Generate the autocompletion script for zsh\n\nFlags:\n -h, --help help for completion\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler completion [command] --help" for more information about a command.\n'})}),"\n",(0,l.jsxs)(n.h4,{id:"hauler-completion-bash",children:[(0,l.jsx)(n.code,{children:"hauler completion bash"}),":"]}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:["Generate the autocompletion script for the bash shell.","\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"Note:"})," This script depends on the 'bash-completion' package."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion bash)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion bash > /etc/bash_completion.d/hauler\n\n#### macOS:\n\n hauler completion bash > $(brew --prefix)/etc/bash_completion.d/hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion bash\n\nFlags:\n -h, --help help for bash\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,l.jsxs)(n.h4,{id:"hauler-completion-fish",children:[(0,l.jsx)(n.code,{children:"hauler completion fish"}),":"]}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"Generate the autocompletion script for the fish shell."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion fish | source\n\nTo load completions for every new session, execute once:\n\n hauler completion fish > ~/.config/fish/completions/hauler.fish\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion fish [flags]\n\nFlags:\n -h, --help help for fish\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,l.jsxs)(n.h4,{id:"hauler-completion-powershell",children:[(0,l.jsx)(n.code,{children:"hauler completion powershell"}),":"]}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"Generate the autocompletion script for powershell."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion powershell | Out-String | Invoke-Expression\n\nTo load completions for every new session, add the output of the above command\nto your powershell profile.\n\nUsage:\n hauler completion powershell [flags]\n\nFlags:\n -h, --help help for powershell\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,l.jsxs)(n.h4,{id:"hauler-completion-zsh",children:[(0,l.jsx)(n.code,{children:"hauler completion zsh"}),":"]}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:["Generate the autocompletion script for the zsh shell.","\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"Note:"})," If shell completion is not already enabled in your environment you will need to enable it."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion zsh)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion zsh > "${fpath[1]}/_hauler"\n\n#### macOS:\n\n hauler completion zsh > $(brew --prefix)/share/zsh/site-functions/_hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion zsh [flags]\n\nFlags:\n -h, --help help for zsh\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n'})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(h,{...e})}):h(e)}},8453:(e,n,o)=>{o.d(n,{R:()=>i,x:()=>t});var l=o(6540);const s={},r=l.createContext(s);function i(e){const n=l.useContext(r);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),l.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c54e2943.f3778b45.js b/assets/js/c54e2943.f3778b45.js deleted file mode 100644 index ccc147c1e..000000000 --- a/assets/js/c54e2943.f3778b45.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9182],{6005:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>d,frontMatter:()=>r,metadata:()=>t,toc:()=>c});var l=o(4848),s=o(8453);const r={title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},i=void 0,t={id:"guides-references/command-line/hauler-completion",title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",source:"@site/versioned_docs/version-0.4.1/guides-references/command-line/hauler-completion.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-completion",permalink:"/hauler-docs/docs/0.4.1/guides-references/command-line/hauler-completion",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.1/guides-references/command-line/hauler-completion.md",tags:[],version:"0.4.1",frontMatter:{title:"Hauler Completion (Command)",description:"Hauler CLI Reference for hauler completion",sidebar_label:"Hauler Completion"},sidebar:"haulerSidebar",previous:{title:"Hauler Store",permalink:"/hauler-docs/docs/0.4.1/guides-references/command-line/hauler-store"},next:{title:"Hauler Version",permalink:"/hauler-docs/docs/0.4.1/guides-references/command-line/hauler-version"}},a={},c=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler completion bash:",id:"hauler-completion-bash",level:4},{value:"hauler completion fish:",id:"hauler-completion-fish",level:4},{value:"hauler completion powershell:",id:"hauler-completion-powershell",level:4},{value:"hauler completion zsh:",id:"hauler-completion-zsh",level:4}];function h(e){const n={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"Generate an autocompletion script for hauler for the specified shell."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler completion [command]\n\nAvailable Commands:\n bash Generate the autocompletion script for bash\n fish Generate the autocompletion script for fish\n powershell Generate the autocompletion script for powershell\n zsh Generate the autocompletion script for zsh\n\nFlags:\n -h, --help help for completion\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler completion [command] --help" for more information about a command.\n'})}),"\n",(0,l.jsxs)(n.h4,{id:"hauler-completion-bash",children:[(0,l.jsx)(n.code,{children:"hauler completion bash"}),":"]}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:["Generate the autocompletion script for the bash shell.","\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"Note:"})," This script depends on the 'bash-completion' package."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion bash)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion bash > /etc/bash_completion.d/hauler\n\n#### macOS:\n\n hauler completion bash > $(brew --prefix)/etc/bash_completion.d/hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion bash\n\nFlags:\n -h, --help help for bash\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,l.jsxs)(n.h4,{id:"hauler-completion-fish",children:[(0,l.jsx)(n.code,{children:"hauler completion fish"}),":"]}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"Generate the autocompletion script for the fish shell."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion fish | source\n\nTo load completions for every new session, execute once:\n\n hauler completion fish > ~/.config/fish/completions/hauler.fish\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion fish [flags]\n\nFlags:\n -h, --help help for fish\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,l.jsxs)(n.h4,{id:"hauler-completion-powershell",children:[(0,l.jsx)(n.code,{children:"hauler completion powershell"}),":"]}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"Generate the autocompletion script for powershell."}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n hauler completion powershell | Out-String | Invoke-Expression\n\nTo load completions for every new session, add the output of the above command\nto your powershell profile.\n\nUsage:\n hauler completion powershell [flags]\n\nFlags:\n -h, --help help for powershell\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})}),"\n",(0,l.jsxs)(n.h4,{id:"hauler-completion-zsh",children:[(0,l.jsx)(n.code,{children:"hauler completion zsh"}),":"]}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:["Generate the autocompletion script for the zsh shell.","\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"Note:"})," If shell completion is not already enabled in your environment you will need to enable it."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-yaml",children:'To load completions in your current shell session:\n\n source <(hauler completion zsh)\n\nTo load completions for every new session, execute once:\n\n#### Linux:\n\n hauler completion zsh > "${fpath[1]}/_hauler"\n\n#### macOS:\n\n hauler completion zsh > $(brew --prefix)/share/zsh/site-functions/_hauler\n\nYou will need to start a new shell for this setup to take effect.\n\nUsage:\n hauler completion zsh [flags]\n\nFlags:\n -h, --help help for zsh\n --no-descriptions disable completion descriptions\n\nGlobal Flags:\n'})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(h,{...e})}):h(e)}},8453:(e,n,o)=>{o.d(n,{R:()=>i,x:()=>t});var l=o(6540);const s={},r=l.createContext(s);function i(e){const n=l.useContext(r);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),l.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c7112151.213b3194.js b/assets/js/c7112151.213b3194.js deleted file mode 100644 index 914a0362a..000000000 --- a/assets/js/c7112151.213b3194.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2646],{370:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>i,contentTitle:()=>c,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var n=s(4848),r=s(8453);const o={title:"Feedback",description:"Feedback for Hauler",sidebar_label:"Feedback"},c=void 0,a={id:"feedback",title:"Feedback",description:"Feedback for Hauler",source:"@site/versioned_docs/version-1.0.x/feedback.md",sourceDirName:".",slug:"/feedback",permalink:"/hauler-docs/docs/feedback",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.x/feedback.md",tags:[],version:"1.0.x",frontMatter:{title:"Feedback",description:"Feedback for Hauler",sidebar_label:"Feedback"},sidebar:"haulerSidebar",previous:{title:"Known Issues/Limits",permalink:"/hauler-docs/docs/known-limits"}},i={},d=[];function u(e){const t={a:"a",code:"code",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(t.p,{children:["Feedback is ",(0,n.jsx)(t.strong,{children:"critical"})," to us to continue to improve ",(0,n.jsx)(t.code,{children:"Hauler"})," and accelerate your mission."]}),"\n",(0,n.jsxs)(t.p,{children:["For any issues, concerns, or questions, please open an issue: ",(0,n.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/issues",children:"https://github.com/rancherfederal/hauler/issues"})]})]})}function l(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>c,x:()=>a});var n=s(6540);const r={},o=n.createContext(r);function c(e){const t=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),n.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c7112151.224d905b.js b/assets/js/c7112151.224d905b.js new file mode 100644 index 000000000..9485b7645 --- /dev/null +++ b/assets/js/c7112151.224d905b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2646],{370:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>i,contentTitle:()=>c,default:()=>l,frontMatter:()=>o,metadata:()=>a,toc:()=>d});var s=n(4848),r=n(8453);const o={title:"Feedback",description:"Feedback for Hauler",sidebar_label:"Feedback"},c=void 0,a={id:"feedback",title:"Feedback",description:"Feedback for Hauler",source:"@site/versioned_docs/version-1.0.x/feedback.md",sourceDirName:".",slug:"/feedback",permalink:"/docs/feedback",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.x/feedback.md",tags:[],version:"1.0.x",frontMatter:{title:"Feedback",description:"Feedback for Hauler",sidebar_label:"Feedback"},sidebar:"haulerSidebar",previous:{title:"Known Issues/Limits",permalink:"/docs/known-limits"}},i={},d=[];function u(e){const t={a:"a",code:"code",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(t.p,{children:["Feedback is ",(0,s.jsx)(t.strong,{children:"critical"})," to us to continue to improve ",(0,s.jsx)(t.code,{children:"Hauler"})," and accelerate your mission."]}),"\n",(0,s.jsxs)(t.p,{children:["For any issues, concerns, or questions, please open an issue: ",(0,s.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/issues",children:"https://github.com/rancherfederal/hauler/issues"})]})]})}function l(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>c,x:()=>a});var s=n(6540);const r={},o=s.createContext(r);function c(e){const t=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),s.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ccad6351.08b90687.js b/assets/js/ccad6351.08b90687.js deleted file mode 100644 index 98867729c..000000000 --- a/assets/js/ccad6351.08b90687.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2541],{6814:(e,r,o)=>{o.r(r),o.d(r,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>s,metadata:()=>c,toc:()=>u});var t=o(4848),n=o(8453);const s={title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",sidebar_label:"Overview"},i=void 0,c={id:"guides-references/hauler-collections/overview",title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",source:"@site/versioned_docs/version-0.4.0/guides-references/hauler-collections/overview.md",sourceDirName:"guides-references/hauler-collections",slug:"/guides-references/hauler-collections/overview",permalink:"/hauler-docs/docs/0.4.0/guides-references/hauler-collections/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.0/guides-references/hauler-collections/overview.md",tags:[],version:"0.4.0",frontMatter:{title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Fetch Cluster Images",permalink:"/hauler-docs/docs/0.4.0/guides-references/cluster-images"},next:{title:"Overview",permalink:"/hauler-docs/docs/0.4.0/guides-references/hauler-content/overview"}},l={},u=[];function a(e){const r={p:"p",...(0,n.R)(),...e.components};return(0,t.jsx)(r.p,{children:"Hauler Collections Overview Documentation pending a future release!"})}function d(e={}){const{wrapper:r}={...(0,n.R)(),...e.components};return r?(0,t.jsx)(r,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},8453:(e,r,o)=>{o.d(r,{R:()=>i,x:()=>c});var t=o(6540);const n={},s=t.createContext(n);function i(e){const r=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),t.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ccad6351.1718a354.js b/assets/js/ccad6351.1718a354.js new file mode 100644 index 000000000..cd8acd4a6 --- /dev/null +++ b/assets/js/ccad6351.1718a354.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2541],{6814:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>u});var o=r(4848),n=r(8453);const i={title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",sidebar_label:"Overview"},s=void 0,c={id:"guides-references/hauler-collections/overview",title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",source:"@site/versioned_docs/version-0.4.0/guides-references/hauler-collections/overview.md",sourceDirName:"guides-references/hauler-collections",slug:"/guides-references/hauler-collections/overview",permalink:"/docs/0.4.0/guides-references/hauler-collections/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.0/guides-references/hauler-collections/overview.md",tags:[],version:"0.4.0",frontMatter:{title:"Overview of Hauler Collections",description:"Hauler Collections Documentation",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Fetch Cluster Images",permalink:"/docs/0.4.0/guides-references/cluster-images"},next:{title:"Overview",permalink:"/docs/0.4.0/guides-references/hauler-content/overview"}},l={},u=[];function a(e){const t={p:"p",...(0,n.R)(),...e.components};return(0,o.jsx)(t.p,{children:"Hauler Collections Overview Documentation pending a future release!"})}function d(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(a,{...e})}):a(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>s,x:()=>c});var o=r(6540);const n={},i=o.createContext(n);function s(e){const t=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:s(e.components),o.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cfe3dcaf.0ae03648.js b/assets/js/cfe3dcaf.0ae03648.js new file mode 100644 index 000000000..757c7390e --- /dev/null +++ b/assets/js/cfe3dcaf.0ae03648.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2890],{4132:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>i,contentTitle:()=>s,default:()=>h,frontMatter:()=>o,metadata:()=>l,toc:()=>c});var n=t(4848),a=t(8453);const o={title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},s=void 0,l={id:"guides-references/command-line/hauler-store",title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",source:"@site/versioned_docs/version-0.4.3/guides-references/command-line/hauler-store.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-store",permalink:"/docs/0.4.3/guides-references/command-line/hauler-store",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.3/guides-references/command-line/hauler-store.md",tags:[],version:"0.4.3",frontMatter:{title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},sidebar:"haulerSidebar",previous:{title:"Hauler",permalink:"/docs/0.4.3/guides-references/command-line/hauler"},next:{title:"Hauler Completion",permalink:"/docs/0.4.3/guides-references/command-line/hauler-completion"}},i={},c=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler store add:",id:"hauler-store-add",level:4},{value:"hauler store add chart:",id:"hauler-store-add-chart",level:4},{value:"hauler store add file:",id:"hauler-store-add-file",level:4},{value:"hauler store add image:",id:"hauler-store-add-image",level:4},{value:"hauler store copy:",id:"hauler-store-copy",level:4},{value:"hauler store extract:",id:"hauler-store-extract",level:4},{value:"hauler store info:",id:"hauler-store-info",level:4},{value:"hauler store load:",id:"hauler-store-load",level:4},{value:"hauler store save:",id:"hauler-store-save",level:4},{value:"hauler store serve:",id:"hauler-store-serve",level:4},{value:"hauler store serve registry:",id:"hauler-store-serve-registry",level:4},{value:"hauler store serve fileserver:",id:"hauler-store-serve-fileserver",level:4},{value:"hauler store sync:",id:"hauler-store-sync",level:4}];function d(e){const r={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Interact with Hauler's embedded content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store [flags]\n hauler store [command]\n\nAliases:\n store, s\n\nAvailable Commands:\n add Add content to store\n copy Copy all store contents to another OCI registry\n extract Extract content from the store to disk\n info Print out information about the store\n load Load a content store from a store archive\n save Save a content store to a store archive\n serve Expose the content of a local store through an OCI compliant server\n sync Sync content to the embedded content store\n\nFlags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -h, --help help for store\n -s, --store string Location to create store at (default "store")\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler store [command] --help" for more information about a command.\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-add",children:[(0,n.jsx)(r.code,{children:"hauler store add"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Add content to store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add [flags]\n hauler store add [command]\n\nAvailable Commands:\n chart Add a local or remote chart to the content store\n file Add a file to the content store\n image Add an image to the content store\n\nFlags:\n -h, --help help for add\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n\nUse "hauler store add [command] --help" for more information about a command.\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-add-chart",children:[(0,n.jsx)(r.code,{children:"hauler store add chart"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Add a local or remote chart to the content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add chart [flags]\n\nExamples:\n\n# add a local chart\nhauler store add chart path/to/chart/directory\n\n# add a local compressed chart\nhauler store add chart path/to/chart.tar.gz\n\n# add a remote chart\nhauler store add chart longhorn --repo "https://charts.longhorn.io"\n\n# add a specific version of a chart\nhauler store add chart rancher --repo "https://releases.rancher.com/server-charts/latest" --version "2.6.2"\n\n\nFlags:\n --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle\n --cert-file string identify HTTPS client using this SSL certificate file\n -h, --help help for chart\n --insecure-skip-tls-verify skip tls certificate checks for the chart download\n --key-file string identify HTTPS client using this SSL key file\n --password string chart repository password where to locate the requested chart\n --repo string chart repository url where to locate the requested chart\n --username string chart repository username where to locate the requested chart\n --verify verify the package before using it\n --version string specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-add-file",children:[(0,n.jsx)(r.code,{children:"hauler store add file"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Add a file to the content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add file [flags]\n\nFlags:\n -h, --help help for file\n -n, --name string (Optional) Name to assign to file in store\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-add-image",children:[(0,n.jsx)(r.code,{children:"hauler store add image"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Add an image to the content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add image [flags]\n\nFlags:\n -h, --help help for image\n -k, --key string (Optional) Path to the key for digital signature verification\n -p, --platform string (Optional) Specific platform to save. i.e. linux/amd64. Defaults to all if flag is omitted.\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-copy",children:[(0,n.jsx)(r.code,{children:"hauler store copy"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Copy all store contents to another OCI registry."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store copy [flags]\n\nFlags:\n -h, --help help for copy\n --insecure Toggle allowing insecure connections when copying to a remote registry\n -p, --password string Password when copying to an authenticated remote registry\n --plain-http Toggle allowing plain http connections when copying to a remote registry\n -u, --username string Username when copying to an authenticated remote registry\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")h\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-extract",children:[(0,n.jsx)(r.code,{children:"hauler store extract"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Extract content from the store to disk."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store extract [flags]\n\nAliases:\n extract, x\n\nFlags:\n -h, --help help for extract\n -o, --output string Directory to save contents to (defaults to current directory)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-info",children:[(0,n.jsx)(r.code,{children:"hauler store info"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Print out information about the store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store info [flags]\n\nAliases:\n info, i, list, ls\n\nFlags:\n -h, --help help for info\n -o, --output string Output format (table, json) (default "table")\n -t, --type string Filter on type (image, chart, file) (default "all")\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-load",children:[(0,n.jsx)(r.code,{children:"hauler store load"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Load a content store from a store archive."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store load [flags]\n\nFlags:\n -h, --help help for load\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-save",children:[(0,n.jsx)(r.code,{children:"hauler store save"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Save a content store to a store archive."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store save [flags]\n\nFlags:\n -f, --filename string Name of archive (default "pkg.tar.zst")\n -h, --help help for save\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-serve",children:[(0,n.jsx)(r.code,{children:"hauler store serve"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Expose the content of a local store through an OCI compliant server."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve [flags]\n\nAvailable Commands:\n fileserver Serve the file server\n registry Serve the embedded registry\n\nFlags:\n -h, --help help for serve\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-serve-registry",children:[(0,n.jsx)(r.code,{children:"hauler store serve registry"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Serve the embedded registry"}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve registry [flags]\n\nFlags:\n -c, --config string Path to a config file, will override all other configs\n --directory string Directory to use for backend. Defaults to $PWD/registry (default "registry")\n -h, --help help for registry\n -p, --port int Port to listen on. (default 5000)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-serve-fileserver",children:[(0,n.jsx)(r.code,{children:"hauler store serve fileserver"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Serve the fileserver"}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve fileserver [flags]\n\nFlags:\n --directory string Directory to use for backend. Defaults to $PWD/store-files (default "store-files")\n -h, --help help for fileserver\n -p, --port int Port to listen on. (default 8080)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-sync",children:[(0,n.jsx)(r.code,{children:"hauler store sync"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Sync content to the embedded content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store sync [flags]\n\nFlags:\n -f, --files strings Path to content files\n -h, --help help for sync\n -k, --key string (Optional) Path to the key for signature verification\n -p, --platform string (Optional) Specific platform to save. i.e. linux/amd64. Defaults to all if flag is omitted.\n --products strings Used for RGS Carbide customers to supply a product and version and Hauler will retrieve the images. i.e. \'--product rancher=v2.7.6\'\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")h\n'})})]})}function h(e={}){const{wrapper:r}={...(0,a.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>s,x:()=>l});var n=t(6540);const a={},o=n.createContext(a);function s(e){const r=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function l(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),n.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cfe3dcaf.9b13ab45.js b/assets/js/cfe3dcaf.9b13ab45.js deleted file mode 100644 index e6107f727..000000000 --- a/assets/js/cfe3dcaf.9b13ab45.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2890],{4132:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>i,contentTitle:()=>s,default:()=>h,frontMatter:()=>o,metadata:()=>l,toc:()=>c});var n=t(4848),a=t(8453);const o={title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},s=void 0,l={id:"guides-references/command-line/hauler-store",title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",source:"@site/versioned_docs/version-0.4.3/guides-references/command-line/hauler-store.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-store",permalink:"/hauler-docs/docs/0.4.3/guides-references/command-line/hauler-store",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.3/guides-references/command-line/hauler-store.md",tags:[],version:"0.4.3",frontMatter:{title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},sidebar:"haulerSidebar",previous:{title:"Hauler",permalink:"/hauler-docs/docs/0.4.3/guides-references/command-line/hauler"},next:{title:"Hauler Completion",permalink:"/hauler-docs/docs/0.4.3/guides-references/command-line/hauler-completion"}},i={},c=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler store add:",id:"hauler-store-add",level:4},{value:"hauler store add chart:",id:"hauler-store-add-chart",level:4},{value:"hauler store add file:",id:"hauler-store-add-file",level:4},{value:"hauler store add image:",id:"hauler-store-add-image",level:4},{value:"hauler store copy:",id:"hauler-store-copy",level:4},{value:"hauler store extract:",id:"hauler-store-extract",level:4},{value:"hauler store info:",id:"hauler-store-info",level:4},{value:"hauler store load:",id:"hauler-store-load",level:4},{value:"hauler store save:",id:"hauler-store-save",level:4},{value:"hauler store serve:",id:"hauler-store-serve",level:4},{value:"hauler store serve registry:",id:"hauler-store-serve-registry",level:4},{value:"hauler store serve fileserver:",id:"hauler-store-serve-fileserver",level:4},{value:"hauler store sync:",id:"hauler-store-sync",level:4}];function d(e){const r={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Interact with Hauler's embedded content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store [flags]\n hauler store [command]\n\nAliases:\n store, s\n\nAvailable Commands:\n add Add content to store\n copy Copy all store contents to another OCI registry\n extract Extract content from the store to disk\n info Print out information about the store\n load Load a content store from a store archive\n save Save a content store to a store archive\n serve Expose the content of a local store through an OCI compliant server\n sync Sync content to the embedded content store\n\nFlags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -h, --help help for store\n -s, --store string Location to create store at (default "store")\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler store [command] --help" for more information about a command.\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-add",children:[(0,n.jsx)(r.code,{children:"hauler store add"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Add content to store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add [flags]\n hauler store add [command]\n\nAvailable Commands:\n chart Add a local or remote chart to the content store\n file Add a file to the content store\n image Add an image to the content store\n\nFlags:\n -h, --help help for add\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n\nUse "hauler store add [command] --help" for more information about a command.\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-add-chart",children:[(0,n.jsx)(r.code,{children:"hauler store add chart"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Add a local or remote chart to the content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add chart [flags]\n\nExamples:\n\n# add a local chart\nhauler store add chart path/to/chart/directory\n\n# add a local compressed chart\nhauler store add chart path/to/chart.tar.gz\n\n# add a remote chart\nhauler store add chart longhorn --repo "https://charts.longhorn.io"\n\n# add a specific version of a chart\nhauler store add chart rancher --repo "https://releases.rancher.com/server-charts/latest" --version "2.6.2"\n\n\nFlags:\n --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle\n --cert-file string identify HTTPS client using this SSL certificate file\n -h, --help help for chart\n --insecure-skip-tls-verify skip tls certificate checks for the chart download\n --key-file string identify HTTPS client using this SSL key file\n --password string chart repository password where to locate the requested chart\n --repo string chart repository url where to locate the requested chart\n --username string chart repository username where to locate the requested chart\n --verify verify the package before using it\n --version string specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-add-file",children:[(0,n.jsx)(r.code,{children:"hauler store add file"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Add a file to the content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add file [flags]\n\nFlags:\n -h, --help help for file\n -n, --name string (Optional) Name to assign to file in store\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-add-image",children:[(0,n.jsx)(r.code,{children:"hauler store add image"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Add an image to the content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add image [flags]\n\nFlags:\n -h, --help help for image\n -k, --key string (Optional) Path to the key for digital signature verification\n -p, --platform string (Optional) Specific platform to save. i.e. linux/amd64. Defaults to all if flag is omitted.\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-copy",children:[(0,n.jsx)(r.code,{children:"hauler store copy"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Copy all store contents to another OCI registry."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store copy [flags]\n\nFlags:\n -h, --help help for copy\n --insecure Toggle allowing insecure connections when copying to a remote registry\n -p, --password string Password when copying to an authenticated remote registry\n --plain-http Toggle allowing plain http connections when copying to a remote registry\n -u, --username string Username when copying to an authenticated remote registry\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")h\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-extract",children:[(0,n.jsx)(r.code,{children:"hauler store extract"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Extract content from the store to disk."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store extract [flags]\n\nAliases:\n extract, x\n\nFlags:\n -h, --help help for extract\n -o, --output string Directory to save contents to (defaults to current directory)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-info",children:[(0,n.jsx)(r.code,{children:"hauler store info"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Print out information about the store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store info [flags]\n\nAliases:\n info, i, list, ls\n\nFlags:\n -h, --help help for info\n -o, --output string Output format (table, json) (default "table")\n -t, --type string Filter on type (image, chart, file) (default "all")\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-load",children:[(0,n.jsx)(r.code,{children:"hauler store load"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Load a content store from a store archive."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store load [flags]\n\nFlags:\n -h, --help help for load\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-save",children:[(0,n.jsx)(r.code,{children:"hauler store save"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Save a content store to a store archive."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store save [flags]\n\nFlags:\n -f, --filename string Name of archive (default "pkg.tar.zst")\n -h, --help help for save\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-serve",children:[(0,n.jsx)(r.code,{children:"hauler store serve"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Expose the content of a local store through an OCI compliant server."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve [flags]\n\nAvailable Commands:\n fileserver Serve the file server\n registry Serve the embedded registry\n\nFlags:\n -h, --help help for serve\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-serve-registry",children:[(0,n.jsx)(r.code,{children:"hauler store serve registry"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Serve the embedded registry"}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve registry [flags]\n\nFlags:\n -c, --config string Path to a config file, will override all other configs\n --directory string Directory to use for backend. Defaults to $PWD/registry (default "registry")\n -h, --help help for registry\n -p, --port int Port to listen on. (default 5000)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-serve-fileserver",children:[(0,n.jsx)(r.code,{children:"hauler store serve fileserver"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Serve the fileserver"}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve fileserver [flags]\n\nFlags:\n --directory string Directory to use for backend. Defaults to $PWD/store-files (default "store-files")\n -h, --help help for fileserver\n -p, --port int Port to listen on. (default 8080)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-sync",children:[(0,n.jsx)(r.code,{children:"hauler store sync"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Sync content to the embedded content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store sync [flags]\n\nFlags:\n -f, --files strings Path to content files\n -h, --help help for sync\n -k, --key string (Optional) Path to the key for signature verification\n -p, --platform string (Optional) Specific platform to save. i.e. linux/amd64. Defaults to all if flag is omitted.\n --products strings Used for RGS Carbide customers to supply a product and version and Hauler will retrieve the images. i.e. \'--product rancher=v2.7.6\'\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")h\n'})})]})}function h(e={}){const{wrapper:r}={...(0,a.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>s,x:()=>l});var n=t(6540);const a={},o=n.createContext(a);function s(e){const r=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function l(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),n.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cfe91dae.210f3321.js b/assets/js/cfe91dae.210f3321.js deleted file mode 100644 index 9be080455..000000000 --- a/assets/js/cfe91dae.210f3321.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[6923],{2372:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>t,metadata:()=>l,toc:()=>d});var a=r(4848),s=r(8453);const t={title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},i=void 0,l={id:"guides-references/cluster-images",title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",source:"@site/versioned_docs/version-0.4.0/guides-references/cluster-images.md",sourceDirName:"guides-references",slug:"/guides-references/cluster-images",permalink:"/hauler-docs/docs/0.4.0/guides-references/cluster-images",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.0/guides-references/cluster-images.md",tags:[],version:"0.4.0",frontMatter:{title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/hauler-docs/docs/0.4.0/guides-references/overview"},next:{title:"Overview",permalink:"/hauler-docs/docs/0.4.0/guides-references/hauler-collections/overview"}},c={},d=[{value:"Example Output",id:"example-output",level:3},{value:"Hauler Manifest using the Images",id:"hauler-manifest-using-the-images",level:3},{value:"Resulting Hauler Manifest",id:"resulting-hauler-manifest",level:3}];function o(e){const n={code:"code",h3:"h3",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsxs)(n.p,{children:["It may be difficult to understand exactly what ",(0,a.jsx)(n.code,{children:"content"})," is actively within your environment. Below is a simple way to generate a list of all images running in your environment, store it as an environment variable, and show the list by echoing the environment variable."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"export IMAGE_LIST=$(kubectl get pods --all-namespaces -o jsonpath=\"{.items[*].spec.containers[*].image}\" |tr -s '[[:space:]]' '\\n' |sort |uniq -c | cut -c 9-)\necho \"$IMAGE_LIST\"\n"})}),"\n",(0,a.jsx)(n.h3,{id:"example-output",children:"Example Output"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:"index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\nindex.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\nindex.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\nrancher/hardened-calico:v3.21.4-build20220228\nrancher/hardened-cluster-autoscaler:v1.8.5-build20211119\nrancher/hardened-coredns:v1.9.1-build20220318\nrancher/hardened-flannel:v0.17.0-build20220317\nrancher/hardened-k8s-metrics-server:v0.5.0-build20211119\nrancher/klipper-helm:v0.7.0-build20220315\nrancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})}),"\n",(0,a.jsx)(n.h3,{id:"hauler-manifest-using-the-images",children:"Hauler Manifest using the Images"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:"IMAGE_LIST_MODIFIED=$(cat \"$IMAGE_LIST\" | sed 's/^/ - name: /')\n# sed, stream editor, appends 2 spaces of indentation denotes\n# an entry in a list, then adds name: to match expected syntax\n"})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images-example\nspec:\n images:\n$IMAGE_LIST_MODIFIED\n"})}),"\n",(0,a.jsx)(n.h3,{id:"resulting-hauler-manifest",children:"Resulting Hauler Manifest"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images-example\nspec:\n images:\n - name: index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\n - name: index.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\n - name: index.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\n - name: rancher/hardened-calico:v3.21.4-build20220228\n - name: rancher/hardened-cluster-autoscaler:v1.8.5-build20211119\n - name: rancher/hardened-coredns:v1.9.1-build20220318\n - name: rancher/hardened-flannel:v0.17.0-build20220317\n - name: rancher/hardened-k8s-metrics-server:v0.5.0-build20211119\n - name: rancher/klipper-helm:v0.7.0-build20220315\n - name: rancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(o,{...e})}):o(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>l});var a=r(6540);const s={},t=a.createContext(s);function i(e){const n=a.useContext(t);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),a.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cfe91dae.cc5ba6bd.js b/assets/js/cfe91dae.cc5ba6bd.js new file mode 100644 index 000000000..1a3536291 --- /dev/null +++ b/assets/js/cfe91dae.cc5ba6bd.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[6923],{2372:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>t,metadata:()=>l,toc:()=>d});var a=r(4848),s=r(8453);const t={title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},i=void 0,l={id:"guides-references/cluster-images",title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",source:"@site/versioned_docs/version-0.4.0/guides-references/cluster-images.md",sourceDirName:"guides-references",slug:"/guides-references/cluster-images",permalink:"/docs/0.4.0/guides-references/cluster-images",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.0/guides-references/cluster-images.md",tags:[],version:"0.4.0",frontMatter:{title:"Fetching Cluster Images",description:"Fetching Images on a Cluster Documentation",sidebar_label:"Fetch Cluster Images"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/docs/0.4.0/guides-references/overview"},next:{title:"Overview",permalink:"/docs/0.4.0/guides-references/hauler-collections/overview"}},c={},d=[{value:"Example Output",id:"example-output",level:3},{value:"Hauler Manifest using the Images",id:"hauler-manifest-using-the-images",level:3},{value:"Resulting Hauler Manifest",id:"resulting-hauler-manifest",level:3}];function o(e){const n={code:"code",h3:"h3",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsxs)(n.p,{children:["It may be difficult to understand exactly what ",(0,a.jsx)(n.code,{children:"content"})," is actively within your environment. Below is a simple way to generate a list of all images running in your environment, store it as an environment variable, and show the list by echoing the environment variable."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"export IMAGE_LIST=$(kubectl get pods --all-namespaces -o jsonpath=\"{.items[*].spec.containers[*].image}\" |tr -s '[[:space:]]' '\\n' |sort |uniq -c | cut -c 9-)\necho \"$IMAGE_LIST\"\n"})}),"\n",(0,a.jsx)(n.h3,{id:"example-output",children:"Example Output"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:"index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\nindex.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\nindex.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\nrancher/hardened-calico:v3.21.4-build20220228\nrancher/hardened-cluster-autoscaler:v1.8.5-build20211119\nrancher/hardened-coredns:v1.9.1-build20220318\nrancher/hardened-flannel:v0.17.0-build20220317\nrancher/hardened-k8s-metrics-server:v0.5.0-build20211119\nrancher/klipper-helm:v0.7.0-build20220315\nrancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})}),"\n",(0,a.jsx)(n.h3,{id:"hauler-manifest-using-the-images",children:"Hauler Manifest using the Images"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:"IMAGE_LIST_MODIFIED=$(cat \"$IMAGE_LIST\" | sed 's/^/ - name: /')\n# sed, stream editor, appends 2 spaces of indentation denotes\n# an entry in a list, then adds name: to match expected syntax\n"})}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images-example\nspec:\n images:\n$IMAGE_LIST_MODIFIED\n"})}),"\n",(0,a.jsx)(n.h3,{id:"resulting-hauler-manifest",children:"Resulting Hauler Manifest"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-manfiest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-cluster-images-example\nspec:\n images:\n - name: index.docker.io/rancher/hardened-etcd:v3.5.1-k3s1-build20220112\n - name: index.docker.io/rancher/hardened-kubernetes:v1.23.5-rke2r1-build20220316\n - name: index.docker.io/rancher/rke2-cloud-provider:v0.0.3-build20211118\n - name: rancher/hardened-calico:v3.21.4-build20220228\n - name: rancher/hardened-cluster-autoscaler:v1.8.5-build20211119\n - name: rancher/hardened-coredns:v1.9.1-build20220318\n - name: rancher/hardened-flannel:v0.17.0-build20220317\n - name: rancher/hardened-k8s-metrics-server:v0.5.0-build20211119\n - name: rancher/klipper-helm:v0.7.0-build20220315\n - name: rancher/nginx-ingress-controller:nginx-1.0.2-hardened4\n"})})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(o,{...e})}):o(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>l});var a=r(6540);const s={},t=a.createContext(s);function i(e){const n=a.useContext(t);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),a.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d08f4848.72ceade8.js b/assets/js/d08f4848.72ceade8.js deleted file mode 100644 index e70805d6d..000000000 --- a/assets/js/d08f4848.72ceade8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7741],{3353:(e,r,o)=>{o.r(r),o.d(r,{assets:()=>c,contentTitle:()=>t,default:()=>u,frontMatter:()=>s,metadata:()=>i,toc:()=>l});var n=o(4848),a=o(8453);const s={title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",sidebar_label:"RGS Carbide Customers"},t=void 0,i={id:"guides-references/carbide-customers",title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",source:"@site/versioned_docs/version-0.4.2/guides-references/carbide-customers.md",sourceDirName:"guides-references",slug:"/guides-references/carbide-customers",permalink:"/hauler-docs/docs/0.4.2/guides-references/carbide-customers",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.2/guides-references/carbide-customers.md",tags:[],version:"0.4.2",frontMatter:{title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",sidebar_label:"RGS Carbide Customers"},sidebar:"haulerSidebar",previous:{title:"Fetch Cluster Images",permalink:"/hauler-docs/docs/0.4.2/guides-references/cluster-images"},next:{title:"Overview",permalink:"/hauler-docs/docs/0.4.2/guides-references/hauler-collections/overview"}},c={},l=[{value:"Example Workflow for Carbide",id:"example-workflow-for-carbide",level:3},{value:"Example Workflow for RKE2",id:"example-workflow-for-rke2",level:3},{value:"Example Workflow for K3S",id:"example-workflow-for-k3s",level:3},{value:"Example Workflow for Rancher",id:"example-workflow-for-rancher",level:3},{value:"Example Workflow for Cert-Manager",id:"example-workflow-for-cert-manager",level:3},{value:"Example Workflow for Longhorn",id:"example-workflow-for-longhorn",level:3},{value:"Example Workflow for NeuVector",id:"example-workflow-for-neuvector",level:3}];function d(e){const r={a:"a",code:"code",h3:"h3",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(r.p,{children:["For all supported customers of Rancher Government Solutions, under the umbrella of Rancher Government Carbide, there is addon functionality within ",(0,n.jsx)(r.code,{children:"Hauler"}),"."]}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"Hauler"})," has the the ability to reference pre-defined ",(0,n.jsx)(r.code,{children:"Hauler"})," manifests from the Carbide Secured Registry (CSR). ",(0,n.jsx)(r.code,{children:"Hauler"})," is built to allow users to fetch, store, package, and distribute content and collections, but most users may be unsure of what to fetch, store, package, and distribue and that is where our supported customers are able to leverage these pre-defined manifests for all of the Rancher products. Below are some of the available ",(0,n.jsx)(r.code,{children:"product"})," flags."]}),"\n",(0,n.jsxs)(r.p,{children:["RGS Carbide Setup Documentation: ",(0,n.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/intro",children:"https://rancherfederal.github.io/carbide-docs/docs/intro"})]}),"\n",(0,n.jsxs)(r.p,{children:["RGS Carbide Public Key: ",(0,n.jsx)(r.a,{href:"https://raw.githubusercontent.com/rancherfederal/carbide-releases/main/carbide-key.pub",children:"https://raw.githubusercontent.com/rancherfederal/carbide-releases/main/carbide-key.pub"})]}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-carbide",children:"Example Workflow for Carbide"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products carbide=v0.1.1 --key carbide-key.pub\n\n# without signature verification\nhauler store sync --products carbie=v0.1.1\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-rke2",children:"Example Workflow for RKE2"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products rke2=v1.26.11+rke2r1 --key carbide-key.pub\n\n# without signature verification\nhauler store sync --products rke2=v1.26.11+rke2r1\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-k3s",children:"Example Workflow for K3S"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products k3s=v1.26.11-k3s2 --key carbide-key.pub\n\n# without signature verification\nhauler store sync --products k3s=v1.26.11-k3s2\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-rancher",children:"Example Workflow for Rancher"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products rancher=v2.7.9 --key carbide-key.pub\n\n# without signature verification\nhauler store sync --products rancher=v2.7.9\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-cert-manager",children:"Example Workflow for Cert-Manager"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products cert-manager=v1.13.3 --key carbide-key.pub\n\n# without signature verification\nhauler store sync --products cert-manager=v1.13.3\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-longhorn",children:"Example Workflow for Longhorn"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products longhorn=v1.5.3 --key carbide-key.pub\n\n# without signature verification\nhauler store sync --products longhorn=v1.5.3\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-neuvector",children:"Example Workflow for NeuVector"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products neuvector=v2.6.6 --key carbide-key.pub\n\n# without signature verification\nhauler store sync --products neuvector=v2.6.6\n"})})]})}function u(e={}){const{wrapper:r}={...(0,a.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,r,o)=>{o.d(r,{R:()=>t,x:()=>i});var n=o(6540);const a={},s=n.createContext(a);function t(e){const r=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:t(e.components),n.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d08f4848.c7091269.js b/assets/js/d08f4848.c7091269.js new file mode 100644 index 000000000..0dfb77c07 --- /dev/null +++ b/assets/js/d08f4848.c7091269.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7741],{3353:(e,r,o)=>{o.r(r),o.d(r,{assets:()=>c,contentTitle:()=>t,default:()=>u,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var n=o(4848),s=o(8453);const a={title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",sidebar_label:"RGS Carbide Customers"},t=void 0,i={id:"guides-references/carbide-customers",title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",source:"@site/versioned_docs/version-0.4.2/guides-references/carbide-customers.md",sourceDirName:"guides-references",slug:"/guides-references/carbide-customers",permalink:"/docs/0.4.2/guides-references/carbide-customers",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.2/guides-references/carbide-customers.md",tags:[],version:"0.4.2",frontMatter:{title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",sidebar_label:"RGS Carbide Customers"},sidebar:"haulerSidebar",previous:{title:"Fetch Cluster Images",permalink:"/docs/0.4.2/guides-references/cluster-images"},next:{title:"Overview",permalink:"/docs/0.4.2/guides-references/hauler-collections/overview"}},c={},l=[{value:"Example Workflow for Carbide",id:"example-workflow-for-carbide",level:3},{value:"Example Workflow for RKE2",id:"example-workflow-for-rke2",level:3},{value:"Example Workflow for K3S",id:"example-workflow-for-k3s",level:3},{value:"Example Workflow for Rancher",id:"example-workflow-for-rancher",level:3},{value:"Example Workflow for Cert-Manager",id:"example-workflow-for-cert-manager",level:3},{value:"Example Workflow for Longhorn",id:"example-workflow-for-longhorn",level:3},{value:"Example Workflow for NeuVector",id:"example-workflow-for-neuvector",level:3}];function d(e){const r={a:"a",code:"code",h3:"h3",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(r.p,{children:["For all supported customers of Rancher Government Solutions, under the umbrella of Rancher Government Carbide, there is addon functionality within ",(0,n.jsx)(r.code,{children:"Hauler"}),"."]}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"Hauler"})," has the the ability to reference pre-defined ",(0,n.jsx)(r.code,{children:"Hauler"})," manifests from the Carbide Secured Registry (CSR). ",(0,n.jsx)(r.code,{children:"Hauler"})," is built to allow users to fetch, store, package, and distribute content and collections, but most users may be unsure of what to fetch, store, package, and distribue and that is where our supported customers are able to leverage these pre-defined manifests for all of the Rancher products. Below are some of the available ",(0,n.jsx)(r.code,{children:"product"})," flags."]}),"\n",(0,n.jsxs)(r.p,{children:["RGS Carbide Setup Documentation: ",(0,n.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/intro",children:"https://rancherfederal.github.io/carbide-docs/docs/intro"})]}),"\n",(0,n.jsxs)(r.p,{children:["RGS Carbide Public Key: ",(0,n.jsx)(r.a,{href:"https://raw.githubusercontent.com/rancherfederal/carbide-releases/main/carbide-key.pub",children:"https://raw.githubusercontent.com/rancherfederal/carbide-releases/main/carbide-key.pub"})]}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-carbide",children:"Example Workflow for Carbide"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products carbide=v0.1.1 --key carbide-key.pub\n\n# without signature verification\nhauler store sync --products carbie=v0.1.1\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-rke2",children:"Example Workflow for RKE2"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products rke2=v1.26.11+rke2r1 --key carbide-key.pub\n\n# without signature verification\nhauler store sync --products rke2=v1.26.11+rke2r1\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-k3s",children:"Example Workflow for K3S"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products k3s=v1.26.11-k3s2 --key carbide-key.pub\n\n# without signature verification\nhauler store sync --products k3s=v1.26.11-k3s2\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-rancher",children:"Example Workflow for Rancher"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products rancher=v2.7.9 --key carbide-key.pub\n\n# without signature verification\nhauler store sync --products rancher=v2.7.9\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-cert-manager",children:"Example Workflow for Cert-Manager"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products cert-manager=v1.13.3 --key carbide-key.pub\n\n# without signature verification\nhauler store sync --products cert-manager=v1.13.3\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-longhorn",children:"Example Workflow for Longhorn"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products longhorn=v1.5.3 --key carbide-key.pub\n\n# without signature verification\nhauler store sync --products longhorn=v1.5.3\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-neuvector",children:"Example Workflow for NeuVector"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products neuvector=v2.6.6 --key carbide-key.pub\n\n# without signature verification\nhauler store sync --products neuvector=v2.6.6\n"})})]})}function u(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,r,o)=>{o.d(r,{R:()=>t,x:()=>i});var n=o(6540);const s={},a=n.createContext(s);function t(e){const r=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:t(e.components),n.createElement(a.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d25cb22b.419a2cd7.js b/assets/js/d25cb22b.419a2cd7.js new file mode 100644 index 000000000..0c018dbe5 --- /dev/null +++ b/assets/js/d25cb22b.419a2cd7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2713],{3206:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var n=r(4848),i=r(8453);const s={title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},l=void 0,c={id:"guides-references/overview",title:"Overview",description:"Reference Guides Overview Documentation for Hauler",source:"@site/versioned_docs/version-0.4.2/guides-references/overview.md",sourceDirName:"guides-references",slug:"/guides-references/overview",permalink:"/docs/0.4.2/guides-references/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.2/guides-references/overview.md",tags:[],version:"0.4.2",frontMatter:{title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Uninstall",permalink:"/docs/0.4.2/introduction/uninstall"},next:{title:"Fetch Cluster Images",permalink:"/docs/0.4.2/guides-references/cluster-images"}},o={},d=[{value:"Hauler Guides & Reference Documentation",id:"hauler-guides--reference-documentation",level:2}];function a(e){const t={a:"a",h2:"h2",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Additional Overview Documentation pending a future release!"}),"\n",(0,n.jsx)(t.h2,{id:"hauler-guides--reference-documentation",children:"Hauler Guides & Reference Documentation"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Guide or Reference Documentation"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"cluster-images",children:"Cluster Images"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Create a Hauler Store from Images on a Cluster"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-collections/overview",children:"Hauler Collections"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of Hauler Collections"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-content/overview",children:"Hauler Content"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of Hauler Content"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"command-line/hauler",children:"Hauler Command Line"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of the Hauler Command Line Interface"})]})]})]})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>l,x:()=>c});var n=r(6540);const i={},s=n.createContext(i);function l(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d25cb22b.6489a757.js b/assets/js/d25cb22b.6489a757.js deleted file mode 100644 index 97744bc0a..000000000 --- a/assets/js/d25cb22b.6489a757.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2713],{3206:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var n=r(4848),i=r(8453);const s={title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},l=void 0,c={id:"guides-references/overview",title:"Overview",description:"Reference Guides Overview Documentation for Hauler",source:"@site/versioned_docs/version-0.4.2/guides-references/overview.md",sourceDirName:"guides-references",slug:"/guides-references/overview",permalink:"/hauler-docs/docs/0.4.2/guides-references/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.2/guides-references/overview.md",tags:[],version:"0.4.2",frontMatter:{title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Uninstall",permalink:"/hauler-docs/docs/0.4.2/introduction/uninstall"},next:{title:"Fetch Cluster Images",permalink:"/hauler-docs/docs/0.4.2/guides-references/cluster-images"}},o={},d=[{value:"Hauler Guides & Reference Documentation",id:"hauler-guides--reference-documentation",level:2}];function a(e){const t={a:"a",h2:"h2",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Additional Overview Documentation pending a future release!"}),"\n",(0,n.jsx)(t.h2,{id:"hauler-guides--reference-documentation",children:"Hauler Guides & Reference Documentation"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Guide or Reference Documentation"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"cluster-images",children:"Cluster Images"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Create a Hauler Store from Images on a Cluster"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-collections/overview",children:"Hauler Collections"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of Hauler Collections"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-content/overview",children:"Hauler Content"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of Hauler Content"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"command-line/hauler",children:"Hauler Command Line"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of the Hauler Command Line Interface"})]})]})]})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>l,x:()=>c});var n=r(6540);const i={},s=n.createContext(i);function l(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d346e559.052c11bc.js b/assets/js/d346e559.052c11bc.js deleted file mode 100644 index 50e5d36a0..000000000 --- a/assets/js/d346e559.052c11bc.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7010],{6274:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>t,contentTitle:()=>l,default:()=>u,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var o=r(4848),s=r(8453);const i={title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},l=void 0,a={id:"guides-references/command-line/hauler-version",title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",source:"@site/versioned_docs/version-0.4.2/guides-references/command-line/hauler-version.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-version",permalink:"/hauler-docs/docs/0.4.2/guides-references/command-line/hauler-version",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.2/guides-references/command-line/hauler-version.md",tags:[],version:"0.4.2",frontMatter:{title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},sidebar:"haulerSidebar",previous:{title:"Hauler Completion",permalink:"/hauler-docs/docs/0.4.2/guides-references/command-line/hauler-completion"},next:{title:"Known Issues/Limits",permalink:"/hauler-docs/docs/0.4.2/known-limits"}},t={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Print Hauler's current version."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler version [flags]\n\nAliases:\n version, v\n\nFlags:\n -h, --help help for version\n --json toggle output in JSON\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>a});var o=r(6540);const s={},i=o.createContext(s);function l(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d346e559.772ced2c.js b/assets/js/d346e559.772ced2c.js new file mode 100644 index 000000000..ab6e68bbb --- /dev/null +++ b/assets/js/d346e559.772ced2c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7010],{6274:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>t,toc:()=>c});var o=r(4848),s=r(8453);const i={title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},l=void 0,t={id:"guides-references/command-line/hauler-version",title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",source:"@site/versioned_docs/version-0.4.2/guides-references/command-line/hauler-version.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-version",permalink:"/docs/0.4.2/guides-references/command-line/hauler-version",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.2/guides-references/command-line/hauler-version.md",tags:[],version:"0.4.2",frontMatter:{title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},sidebar:"haulerSidebar",previous:{title:"Hauler Completion",permalink:"/docs/0.4.2/guides-references/command-line/hauler-completion"},next:{title:"Known Issues/Limits",permalink:"/docs/0.4.2/known-limits"}},a={},c=[{value:"Command Overview",id:"command-overview",level:3}];function u(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Print Hauler's current version."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler version [flags]\n\nAliases:\n version, v\n\nFlags:\n -h, --help help for version\n --json toggle output in JSON\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>t});var o=r(6540);const s={},i=o.createContext(s);function l(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d8cfcbbf.4005bfeb.js b/assets/js/d8cfcbbf.4005bfeb.js new file mode 100644 index 000000000..74b080962 --- /dev/null +++ b/assets/js/d8cfcbbf.4005bfeb.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8663],{5374:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>s,metadata:()=>i,toc:()=>d});var r=n(4848),l=n(8453);const s={title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},a=void 0,i={id:"introduction/install",title:"Installation",description:"Installation Documentation for Hauler",source:"@site/versioned_docs/version-0.4.2/introduction/install.md",sourceDirName:"introduction",slug:"/introduction/install",permalink:"/docs/0.4.2/introduction/install",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.2/introduction/install.md",tags:[],version:"0.4.2",frontMatter:{title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},sidebar:"haulerSidebar",previous:{title:"Quickstart",permalink:"/docs/0.4.2/introduction/quickstart"},next:{title:"Uninstall",permalink:"/docs/0.4.2/introduction/uninstall"}},c={},d=[{value:"Overview",id:"overview",level:2},{value:"Supported Architectures",id:"supported-architectures",level:2},{value:"Installation Steps",id:"installation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin",level:3},{value:"Homebrew",id:"homebrew",level:3},{value:"Windows",id:"windows",level:3},{value:"Manual Installation Steps",id:"manual-installation-steps",level:2}];function o(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h2,{id:"overview",children:"Overview"}),"\n",(0,r.jsxs)(t.p,{children:["Hauler is a purpose built to be a single binary with no specific prerequistes or depedencies. It's installation is very simple and easy to follow. To view the latest release, please view our ",(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"GitHub Release"})," page."]}),"\n",(0,r.jsx)(t.h2,{id:"supported-architectures",children:"Supported Architectures"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Base Platform"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Architecture"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Latest Release"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Linux"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Darwin"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Windows"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]})]})]}),"\n",(0,r.jsx)(t.h2,{id:"installation-steps",children:"Installation Steps"}),"\n",(0,r.jsx)(t.h3,{id:"linuxdarwin",children:"Linux/Darwin"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n\n# install specific release\ncurl -sfL https://get.hauler.dev | HAULER_VERSION=0.4.2 bash\n"})}),"\n",(0,r.jsx)(t.h3,{id:"homebrew",children:"Homebrew"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# installs latest release\nbrew tap rancherfederal/homebrew-tap\nbrew install hauler\n"})}),"\n",(0,r.jsx)(t.h3,{id:"windows",children:"Windows"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,r.jsx)(t.h2,{id:"manual-installation-steps",children:"Manual Installation Steps"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:'# set the hauler version (i.e. "0.4.2")\nexport vHauler=HAULER_VERSION\n\n# set the specific platform (i.e. "linux")\nexport platform=PLATFORM\n\n# set the specific arch (i.e. "amd64")\nexport arch=ARCH\n\ncurl -sOL https://github.com/rancherfederal/hauler/releases/download/v${vHauler}/hauler_${vHauler}_${platform}_${arch}.tar.gz\ntar -xf hauler_${vHauler}_${platform}_${arch}.tar.gz\nsudo mv hauler /usr/bin/hauler\n'})})]})}function h(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>i});var r=n(6540);const l={},s=r.createContext(l);function a(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:a(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d8cfcbbf.4afb5332.js b/assets/js/d8cfcbbf.4afb5332.js deleted file mode 100644 index 93ab14b9f..000000000 --- a/assets/js/d8cfcbbf.4afb5332.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8663],{5374:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>s,metadata:()=>i,toc:()=>d});var r=n(4848),l=n(8453);const s={title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},a=void 0,i={id:"introduction/install",title:"Installation",description:"Installation Documentation for Hauler",source:"@site/versioned_docs/version-0.4.2/introduction/install.md",sourceDirName:"introduction",slug:"/introduction/install",permalink:"/hauler-docs/docs/0.4.2/introduction/install",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.2/introduction/install.md",tags:[],version:"0.4.2",frontMatter:{title:"Installation",description:"Installation Documentation for Hauler",sidebar_label:"Installation"},sidebar:"haulerSidebar",previous:{title:"Quickstart",permalink:"/hauler-docs/docs/0.4.2/introduction/quickstart"},next:{title:"Uninstall",permalink:"/hauler-docs/docs/0.4.2/introduction/uninstall"}},c={},d=[{value:"Overview",id:"overview",level:2},{value:"Supported Architectures",id:"supported-architectures",level:2},{value:"Installation Steps",id:"installation-steps",level:2},{value:"Linux/Darwin",id:"linuxdarwin",level:3},{value:"Homebrew",id:"homebrew",level:3},{value:"Windows",id:"windows",level:3},{value:"Manual Installation Steps",id:"manual-installation-steps",level:2}];function o(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h2,{id:"overview",children:"Overview"}),"\n",(0,r.jsxs)(t.p,{children:["Hauler is a purpose built to be a single binary with no specific prerequistes or depedencies. It's installation is very simple and easy to follow. To view the latest release, please view our ",(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"GitHub Release"})," page."]}),"\n",(0,r.jsx)(t.h2,{id:"supported-architectures",children:"Supported Architectures"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Base Platform"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Architecture"}),(0,r.jsx)(t.th,{style:{textAlign:"center"},children:"Latest Release"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Linux"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Darwin"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"center"},children:"Windows"}),(0,r.jsxs)(t.td,{style:{textAlign:"center"},children:[(0,r.jsx)(t.code,{children:"amd64"})," and ",(0,r.jsx)(t.code,{children:"arm64"})]}),(0,r.jsx)(t.td,{style:{textAlign:"center"},children:(0,r.jsx)(t.a,{href:"https://github.com/rancherfederal/hauler/releases",children:"https://github.com/rancherfederal/hauler/releases"})})]})]})]}),"\n",(0,r.jsx)(t.h2,{id:"installation-steps",children:"Installation Steps"}),"\n",(0,r.jsx)(t.h3,{id:"linuxdarwin",children:"Linux/Darwin"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# install latest release\ncurl -sfL https://get.hauler.dev | bash\n\n# install specific release\ncurl -sfL https://get.hauler.dev | HAULER_VERSION=0.4.2 bash\n"})}),"\n",(0,r.jsx)(t.h3,{id:"homebrew",children:"Homebrew"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# installs latest release\nbrew tap rancherfederal/homebrew-tap\nbrew install hauler\n"})}),"\n",(0,r.jsx)(t.h3,{id:"windows",children:"Windows"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"# coming soon\n"})}),"\n",(0,r.jsx)(t.h2,{id:"manual-installation-steps",children:"Manual Installation Steps"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:'# set the hauler version (i.e. "0.4.2")\nexport vHauler=HAULER_VERSION\n\n# set the specific platform (i.e. "linux")\nexport platform=PLATFORM\n\n# set the specific arch (i.e. "amd64")\nexport arch=ARCH\n\ncurl -sOL https://github.com/rancherfederal/hauler/releases/download/v${vHauler}/hauler_${vHauler}_${platform}_${arch}.tar.gz\ntar -xf hauler_${vHauler}_${platform}_${arch}.tar.gz\nsudo mv hauler /usr/bin/hauler\n'})})]})}function h(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>i});var r=n(6540);const l={},s=r.createContext(l);function a(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:a(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/dbfc2905.bbd2f490.js b/assets/js/dbfc2905.bbd2f490.js new file mode 100644 index 000000000..0c9dd9100 --- /dev/null +++ b/assets/js/dbfc2905.bbd2f490.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9510],{3519:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>t,toc:()=>c});var o=r(4848),s=r(8453);const i={title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},l=void 0,t={id:"guides-references/command-line/hauler-version",title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",source:"@site/versioned_docs/version-0.4.1/guides-references/command-line/hauler-version.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-version",permalink:"/docs/0.4.1/guides-references/command-line/hauler-version",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.1/guides-references/command-line/hauler-version.md",tags:[],version:"0.4.1",frontMatter:{title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},sidebar:"haulerSidebar",previous:{title:"Hauler Completion",permalink:"/docs/0.4.1/guides-references/command-line/hauler-completion"},next:{title:"Known Issues/Limits",permalink:"/docs/0.4.1/known-limits"}},a={},c=[{value:"Command Overview",id:"command-overview",level:3}];function u(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Print Hauler's current version."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler version [flags]\n\nAliases:\n version, v\n\nFlags:\n -h, --help help for version\n --json toggle output in JSON\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>t});var o=r(6540);const s={},i=o.createContext(s);function l(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/dbfc2905.f84e7263.js b/assets/js/dbfc2905.f84e7263.js deleted file mode 100644 index 482be7bbc..000000000 --- a/assets/js/dbfc2905.f84e7263.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9510],{3519:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>t,contentTitle:()=>l,default:()=>u,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var o=r(4848),s=r(8453);const i={title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},l=void 0,a={id:"guides-references/command-line/hauler-version",title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",source:"@site/versioned_docs/version-0.4.1/guides-references/command-line/hauler-version.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-version",permalink:"/hauler-docs/docs/0.4.1/guides-references/command-line/hauler-version",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.1/guides-references/command-line/hauler-version.md",tags:[],version:"0.4.1",frontMatter:{title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},sidebar:"haulerSidebar",previous:{title:"Hauler Completion",permalink:"/hauler-docs/docs/0.4.1/guides-references/command-line/hauler-completion"},next:{title:"Known Issues/Limits",permalink:"/hauler-docs/docs/0.4.1/known-limits"}},t={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Print Hauler's current version."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler version [flags]\n\nAliases:\n version, v\n\nFlags:\n -h, --help help for version\n --json toggle output in JSON\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>a});var o=r(6540);const s={},i=o.createContext(s);function l(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e0511d92.0ae49e04.js b/assets/js/e0511d92.0ae49e04.js new file mode 100644 index 000000000..fb18b4a9c --- /dev/null +++ b/assets/js/e0511d92.0ae49e04.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8464],{380:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>u,frontMatter:()=>s,metadata:()=>o,toc:()=>c});var r=t(4848),i=t(8453);const s={title:"Hauler Registry",description:"Hauler Registry Documentation",sidebar_label:"Hauler Registry"},a=void 0,o={id:"guides-references/utilities/registry",title:"Hauler Registry",description:"Hauler Registry Documentation",source:"@site/versioned_docs/version-1.0.x/guides-references/utilities/registry.md",sourceDirName:"guides-references/utilities",slug:"/guides-references/utilities/registry",permalink:"/docs/guides-references/utilities/registry",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/utilities/registry.md",tags:[],version:"1.0.x",frontMatter:{title:"Hauler Registry",description:"Hauler Registry Documentation",sidebar_label:"Hauler Registry"},sidebar:"haulerSidebar",previous:{title:"RGS Carbide Customers",permalink:"/docs/guides-references/carbide-customers"},next:{title:"Hauler Fileserver",permalink:"/docs/guides-references/utilities/fileserver"}},l={},c=[{value:"Overview",id:"overview",level:2},{value:"Example Commands for the Hauler Registry",id:"example-commands-for-the-hauler-registry",level:2},{value:"Example Config for the Hauler Registry",id:"example-config-for-the-hauler-registry",level:2}];function d(e){const n={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"overview",children:"Overview"}),"\n",(0,r.jsx)(n.p,{children:"Hauler Registry docs are pending a future release!"}),"\n",(0,r.jsx)(n.h2,{id:"example-commands-for-the-hauler-registry",children:"Example Commands for the Hauler Registry"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"# serve registry\nhauler store serve registry\n\n# serve registry on specific port\nhauler store serve registry --port \n\n# serve registry on specific port with custom config\nhauler store serve registry --port --config \n"})}),"\n",(0,r.jsx)(n.h2,{id:"example-config-for-the-hauler-registry",children:"Example Config for the Hauler Registry"}),"\n",(0,r.jsx)(n.p,{children:"These are all configuration options for the registry. Some options in the list are mutually exclusive. Read the detailed reference information about each option before finalizing your configuration."}),"\n",(0,r.jsxs)(n.p,{children:["You can learn more here --\x3e ",(0,r.jsx)(n.a,{href:"https://distribution.github.io/distribution/about/configuration",children:"https://distribution.github.io/distribution/about/configuration"})]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:'version: 0.1\nlog:\n accesslog:\n disabled: true\n level: debug\n formatter: text\n fields:\n service: registry\n environment: staging\n hooks:\n - type: mail\n disabled: true\n levels:\n - panic\n options:\n smtp:\n addr: mail.example.com:25\n username: mailuser\n password: password\n insecure: true\n from: sender@example.com\n to:\n - errors@example.com\nloglevel: debug # deprecated: use "log"\nstorage:\n filesystem:\n rootdirectory: /var/lib/registry\n maxthreads: 100\n azure:\n accountname: accountname\n accountkey: base64encodedaccountkey\n container: containername\n rootdirectory: /az/object/name/prefix\n credentials:\n type: client_secret\n clientid: client_id_string\n tenantid: tenant_id_string\n secret: secret_string\n copy_status_poll_max_retry: 10\n copy_status_poll_delay: 100ms\n gcs:\n bucket: bucketname\n keyfile: /path/to/keyfile\n credentials:\n type: service_account\n project_id: project_id_string\n private_key_id: private_key_id_string\n private_key: private_key_string\n client_email: client@example.com\n client_id: client_id_string\n auth_uri: http://example.com/auth_uri\n token_uri: http://example.com/token_uri\n auth_provider_x509_cert_url: http://example.com/provider_cert_url\n client_x509_cert_url: http://example.com/client_cert_url\n rootdirectory: /gcs/object/name/prefix\n chunksize: 5242880\n s3:\n accesskey: awsaccesskey\n secretkey: awssecretkey\n region: us-west-1\n regionendpoint: http://myobjects.local\n forcepathstyle: true\n accelerate: false\n bucket: bucketname\n encrypt: true\n keyid: mykeyid\n secure: true\n v4auth: true\n chunksize: 5242880\n multipartcopychunksize: 33554432\n multipartcopymaxconcurrency: 100\n multipartcopythresholdsize: 33554432\n rootdirectory: /s3/object/name/prefix\n usedualstack: false\n loglevel: debug\n inmemory: # This driver takes no parameters\n tag:\n concurrencylimit: 8\n delete:\n enabled: false\n redirect:\n disable: false\n cache:\n blobdescriptor: redis\n blobdescriptorsize: 10000\n maintenance:\n uploadpurging:\n enabled: true\n age: 168h\n interval: 24h\n dryrun: false\n readonly:\n enabled: false\nauth:\n silly:\n realm: silly-realm\n service: silly-service\n token:\n autoredirect: true\n realm: token-realm\n service: token-service\n issuer: registry-token-issuer\n rootcertbundle: /root/certs/bundle\n htpasswd:\n realm: basic-realm\n path: /path/to/htpasswd\nmiddleware:\n registry:\n - name: ARegistryMiddleware\n options:\n foo: bar\n repository:\n - name: ARepositoryMiddleware\n options:\n foo: bar\n storage:\n - name: cloudfront\n options:\n baseurl: https://my.cloudfronted.domain.com/\n privatekey: /path/to/pem\n keypairid: cloudfrontkeypairid\n duration: 3000s\n ipfilteredby: awsregion\n awsregion: us-east-1, use-east-2\n updatefrequency: 12h\n iprangesurl: https://ip-ranges.amazonaws.com/ip-ranges.json\n storage:\n - name: redirect\n options:\n baseurl: https://example.com/\nhttp:\n addr: localhost:5000\n prefix: /my/nested/registry/\n host: https://myregistryaddress.org:5000\n secret: asecretforlocaldevelopment\n relativeurls: false\n draintimeout: 60s\n tls:\n certificate: /path/to/x509/public\n key: /path/to/x509/private\n clientcas:\n - /path/to/ca.pem\n - /path/to/another/ca.pem\n letsencrypt:\n cachefile: /path/to/cache-file\n email: emailused@letsencrypt.com\n hosts: [myregistryaddress.org]\n directoryurl: https://acme-v02.api.letsencrypt.org/directory\n debug:\n addr: localhost:5001\n prometheus:\n enabled: true\n path: /metrics\n headers:\n X-Content-Type-Options: [nosniff]\n http2:\n disabled: false\n h2c:\n enabled: false\nnotifications:\n events:\n includereferences: true\n endpoints:\n - name: alistener\n disabled: false\n url: https://my.listener.com/event\n headers: \n timeout: 1s\n threshold: 10\n backoff: 1s\n ignoredmediatypes:\n - application/octet-stream\n ignore:\n mediatypes:\n - application/octet-stream\n actions:\n - pull\nredis:\n addr: localhost:6379\n password: asecret\n db: 0\n dialtimeout: 10ms\n readtimeout: 10ms\n writetimeout: 10ms\n pool:\n maxidle: 16\n maxactive: 64\n idletimeout: 300s\n tls:\n enabled: false\nhealth:\n storagedriver:\n enabled: true\n interval: 10s\n threshold: 3\n file:\n - file: /path/to/checked/file\n interval: 10s\n http:\n - uri: http://server.to.check/must/return/200\n headers:\n Authorization: [Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==]\n statuscode: 200\n timeout: 3s\n interval: 10s\n threshold: 3\n tcp:\n - addr: redis-server.domain.com:6379\n timeout: 3s\n interval: 10s\n threshold: 3\nproxy:\n remoteurl: https://registry-1.docker.io\n username: [username]\n password: [password]\n ttl: 168h\nvalidation:\n manifests:\n urls:\n allow:\n - ^https?://([^/]+\\.)*example\\.com/\n deny:\n - ^https?://www\\.example\\.com/\n'})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>o});var r=t(6540);const i={},s=r.createContext(i);function a(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e0511d92.14b017fb.js b/assets/js/e0511d92.14b017fb.js deleted file mode 100644 index 7e4161ad7..000000000 --- a/assets/js/e0511d92.14b017fb.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[8464],{380:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>u,frontMatter:()=>s,metadata:()=>o,toc:()=>c});var r=t(4848),i=t(8453);const s={title:"Hauler Registry",description:"Hauler Registry Documentation",sidebar_label:"Hauler Registry"},a=void 0,o={id:"guides-references/utilities/registry",title:"Hauler Registry",description:"Hauler Registry Documentation",source:"@site/versioned_docs/version-1.0.x/guides-references/utilities/registry.md",sourceDirName:"guides-references/utilities",slug:"/guides-references/utilities/registry",permalink:"/hauler-docs/docs/guides-references/utilities/registry",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.x/guides-references/utilities/registry.md",tags:[],version:"1.0.x",frontMatter:{title:"Hauler Registry",description:"Hauler Registry Documentation",sidebar_label:"Hauler Registry"},sidebar:"haulerSidebar",previous:{title:"RGS Carbide Customers",permalink:"/hauler-docs/docs/guides-references/carbide-customers"},next:{title:"Hauler Fileserver",permalink:"/hauler-docs/docs/guides-references/utilities/fileserver"}},l={},c=[{value:"Overview",id:"overview",level:2},{value:"Example Commands for the Hauler Registry",id:"example-commands-for-the-hauler-registry",level:2},{value:"Example Config for the Hauler Registry",id:"example-config-for-the-hauler-registry",level:2}];function d(e){const n={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"overview",children:"Overview"}),"\n",(0,r.jsx)(n.p,{children:"Hauler Registry docs are pending a future release!"}),"\n",(0,r.jsx)(n.h2,{id:"example-commands-for-the-hauler-registry",children:"Example Commands for the Hauler Registry"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"# serve registry\nhauler store serve registry\n\n# serve registry on specific port\nhauler store serve registry --port \n\n# serve registry on specific port with custom config\nhauler store serve registry --port --config \n"})}),"\n",(0,r.jsx)(n.h2,{id:"example-config-for-the-hauler-registry",children:"Example Config for the Hauler Registry"}),"\n",(0,r.jsx)(n.p,{children:"These are all configuration options for the registry. Some options in the list are mutually exclusive. Read the detailed reference information about each option before finalizing your configuration."}),"\n",(0,r.jsxs)(n.p,{children:["You can learn more here --\x3e ",(0,r.jsx)(n.a,{href:"https://distribution.github.io/distribution/about/configuration",children:"https://distribution.github.io/distribution/about/configuration"})]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:'version: 0.1\nlog:\n accesslog:\n disabled: true\n level: debug\n formatter: text\n fields:\n service: registry\n environment: staging\n hooks:\n - type: mail\n disabled: true\n levels:\n - panic\n options:\n smtp:\n addr: mail.example.com:25\n username: mailuser\n password: password\n insecure: true\n from: sender@example.com\n to:\n - errors@example.com\nloglevel: debug # deprecated: use "log"\nstorage:\n filesystem:\n rootdirectory: /var/lib/registry\n maxthreads: 100\n azure:\n accountname: accountname\n accountkey: base64encodedaccountkey\n container: containername\n rootdirectory: /az/object/name/prefix\n credentials:\n type: client_secret\n clientid: client_id_string\n tenantid: tenant_id_string\n secret: secret_string\n copy_status_poll_max_retry: 10\n copy_status_poll_delay: 100ms\n gcs:\n bucket: bucketname\n keyfile: /path/to/keyfile\n credentials:\n type: service_account\n project_id: project_id_string\n private_key_id: private_key_id_string\n private_key: private_key_string\n client_email: client@example.com\n client_id: client_id_string\n auth_uri: http://example.com/auth_uri\n token_uri: http://example.com/token_uri\n auth_provider_x509_cert_url: http://example.com/provider_cert_url\n client_x509_cert_url: http://example.com/client_cert_url\n rootdirectory: /gcs/object/name/prefix\n chunksize: 5242880\n s3:\n accesskey: awsaccesskey\n secretkey: awssecretkey\n region: us-west-1\n regionendpoint: http://myobjects.local\n forcepathstyle: true\n accelerate: false\n bucket: bucketname\n encrypt: true\n keyid: mykeyid\n secure: true\n v4auth: true\n chunksize: 5242880\n multipartcopychunksize: 33554432\n multipartcopymaxconcurrency: 100\n multipartcopythresholdsize: 33554432\n rootdirectory: /s3/object/name/prefix\n usedualstack: false\n loglevel: debug\n inmemory: # This driver takes no parameters\n tag:\n concurrencylimit: 8\n delete:\n enabled: false\n redirect:\n disable: false\n cache:\n blobdescriptor: redis\n blobdescriptorsize: 10000\n maintenance:\n uploadpurging:\n enabled: true\n age: 168h\n interval: 24h\n dryrun: false\n readonly:\n enabled: false\nauth:\n silly:\n realm: silly-realm\n service: silly-service\n token:\n autoredirect: true\n realm: token-realm\n service: token-service\n issuer: registry-token-issuer\n rootcertbundle: /root/certs/bundle\n htpasswd:\n realm: basic-realm\n path: /path/to/htpasswd\nmiddleware:\n registry:\n - name: ARegistryMiddleware\n options:\n foo: bar\n repository:\n - name: ARepositoryMiddleware\n options:\n foo: bar\n storage:\n - name: cloudfront\n options:\n baseurl: https://my.cloudfronted.domain.com/\n privatekey: /path/to/pem\n keypairid: cloudfrontkeypairid\n duration: 3000s\n ipfilteredby: awsregion\n awsregion: us-east-1, use-east-2\n updatefrequency: 12h\n iprangesurl: https://ip-ranges.amazonaws.com/ip-ranges.json\n storage:\n - name: redirect\n options:\n baseurl: https://example.com/\nhttp:\n addr: localhost:5000\n prefix: /my/nested/registry/\n host: https://myregistryaddress.org:5000\n secret: asecretforlocaldevelopment\n relativeurls: false\n draintimeout: 60s\n tls:\n certificate: /path/to/x509/public\n key: /path/to/x509/private\n clientcas:\n - /path/to/ca.pem\n - /path/to/another/ca.pem\n letsencrypt:\n cachefile: /path/to/cache-file\n email: emailused@letsencrypt.com\n hosts: [myregistryaddress.org]\n directoryurl: https://acme-v02.api.letsencrypt.org/directory\n debug:\n addr: localhost:5001\n prometheus:\n enabled: true\n path: /metrics\n headers:\n X-Content-Type-Options: [nosniff]\n http2:\n disabled: false\n h2c:\n enabled: false\nnotifications:\n events:\n includereferences: true\n endpoints:\n - name: alistener\n disabled: false\n url: https://my.listener.com/event\n headers: \n timeout: 1s\n threshold: 10\n backoff: 1s\n ignoredmediatypes:\n - application/octet-stream\n ignore:\n mediatypes:\n - application/octet-stream\n actions:\n - pull\nredis:\n addr: localhost:6379\n password: asecret\n db: 0\n dialtimeout: 10ms\n readtimeout: 10ms\n writetimeout: 10ms\n pool:\n maxidle: 16\n maxactive: 64\n idletimeout: 300s\n tls:\n enabled: false\nhealth:\n storagedriver:\n enabled: true\n interval: 10s\n threshold: 3\n file:\n - file: /path/to/checked/file\n interval: 10s\n http:\n - uri: http://server.to.check/must/return/200\n headers:\n Authorization: [Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==]\n statuscode: 200\n timeout: 3s\n interval: 10s\n threshold: 3\n tcp:\n - addr: redis-server.domain.com:6379\n timeout: 3s\n interval: 10s\n threshold: 3\nproxy:\n remoteurl: https://registry-1.docker.io\n username: [username]\n password: [password]\n ttl: 168h\nvalidation:\n manifests:\n urls:\n allow:\n - ^https?://([^/]+\\.)*example\\.com/\n deny:\n - ^https?://www\\.example\\.com/\n'})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>o});var r=t(6540);const i={},s=r.createContext(i);function a(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e25e5fe1.282f4bf6.js b/assets/js/e25e5fe1.282f4bf6.js new file mode 100644 index 000000000..4acef2f99 --- /dev/null +++ b/assets/js/e25e5fe1.282f4bf6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9847],{6636:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var n=r(4848),i=r(8453);const s={title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},l=void 0,c={id:"guides-references/overview",title:"Overview",description:"Reference Guides Overview Documentation for Hauler",source:"@site/versioned_docs/version-0.4.0/guides-references/overview.md",sourceDirName:"guides-references",slug:"/guides-references/overview",permalink:"/docs/0.4.0/guides-references/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.0/guides-references/overview.md",tags:[],version:"0.4.0",frontMatter:{title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Uninstall",permalink:"/docs/0.4.0/introduction/uninstall"},next:{title:"Fetch Cluster Images",permalink:"/docs/0.4.0/guides-references/cluster-images"}},o={},d=[{value:"Hauler Guides & Reference Documentation",id:"hauler-guides--reference-documentation",level:2}];function a(e){const t={a:"a",h2:"h2",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Additional Overview Documentation pending a future release!"}),"\n",(0,n.jsx)(t.h2,{id:"hauler-guides--reference-documentation",children:"Hauler Guides & Reference Documentation"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Guide or Reference Documentation"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"cluster-images",children:"Cluster Images"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Create a Hauler Store from Images on a Cluster"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-collections/overview",children:"Hauler Collections"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of Hauler Collections"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-content/overview",children:"Hauler Content"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of Hauler Content"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"command-line/hauler",children:"Hauler Command Line"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of the Hauler Command Line Interface"})]})]})]})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>l,x:()=>c});var n=r(6540);const i={},s=n.createContext(i);function l(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e25e5fe1.b42e90ba.js b/assets/js/e25e5fe1.b42e90ba.js deleted file mode 100644 index f38a332fa..000000000 --- a/assets/js/e25e5fe1.b42e90ba.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9847],{6636:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var n=r(4848),i=r(8453);const s={title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},l=void 0,c={id:"guides-references/overview",title:"Overview",description:"Reference Guides Overview Documentation for Hauler",source:"@site/versioned_docs/version-0.4.0/guides-references/overview.md",sourceDirName:"guides-references",slug:"/guides-references/overview",permalink:"/hauler-docs/docs/0.4.0/guides-references/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.0/guides-references/overview.md",tags:[],version:"0.4.0",frontMatter:{title:"Overview",description:"Reference Guides Overview Documentation for Hauler",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Uninstall",permalink:"/hauler-docs/docs/0.4.0/introduction/uninstall"},next:{title:"Fetch Cluster Images",permalink:"/hauler-docs/docs/0.4.0/guides-references/cluster-images"}},o={},d=[{value:"Hauler Guides & Reference Documentation",id:"hauler-guides--reference-documentation",level:2}];function a(e){const t={a:"a",h2:"h2",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Additional Overview Documentation pending a future release!"}),"\n",(0,n.jsx)(t.h2,{id:"hauler-guides--reference-documentation",children:"Hauler Guides & Reference Documentation"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Guide or Reference Documentation"}),(0,n.jsx)(t.th,{style:{textAlign:"center"},children:"Description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"cluster-images",children:"Cluster Images"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Create a Hauler Store from Images on a Cluster"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-collections/overview",children:"Hauler Collections"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of Hauler Collections"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"hauler-content/overview",children:"Hauler Content"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of Hauler Content"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"center"},children:(0,n.jsx)(t.a,{href:"command-line/hauler",children:"Hauler Command Line"})}),(0,n.jsx)(t.td,{style:{textAlign:"center"},children:"Detailed Overview of the Hauler Command Line Interface"})]})]})]})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>l,x:()=>c});var n=r(6540);const i={},s=n.createContext(i);function l(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e265a717.05a4528a.js b/assets/js/e265a717.05a4528a.js deleted file mode 100644 index c5a0c9fda..000000000 --- a/assets/js/e265a717.05a4528a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9021],{2608:(r,e,o)=>{o.r(e),o.d(e,{assets:()=>c,contentTitle:()=>n,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var t=o(4848),a=o(8453);const i={title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},n=void 0,s={id:"airgap-workflow",title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",source:"@site/versioned_docs/version-0.4.0/airgap-workflow.md",sourceDirName:".",slug:"/airgap-workflow",permalink:"/hauler-docs/docs/0.4.0/airgap-workflow",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.0/airgap-workflow.md",tags:[],version:"0.4.0",frontMatter:{title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},sidebar:"haulerSidebar",previous:{title:"Core Concepts",permalink:"/hauler-docs/docs/0.4.0/core-concepts"},next:{title:"Quickstart",permalink:"/hauler-docs/docs/0.4.0/introduction/quickstart"}},c={},l=[{value:"Workflow Diagram",id:"workflow-diagram",level:2}];function d(r){const e={h2:"h2",img:"img",p:"p",...(0,a.R)(),...r.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h2,{id:"workflow-diagram",children:"Workflow Diagram"}),"\n",(0,t.jsx)(e.p,{children:(0,t.jsx)(e.img,{alt:"hauler-workflow-diagram",src:o(8010).A+"",width:"2883",height:"1013"})}),"\n",(0,t.jsx)(e.p,{children:"Airgap Workflow Documentation pending a future release!"})]})}function u(r={}){const{wrapper:e}={...(0,a.R)(),...r.components};return e?(0,t.jsx)(e,{...r,children:(0,t.jsx)(d,{...r})}):d(r)}},8010:(r,e,o)=>{o.d(e,{A:()=>t});const t=o.p+"assets/images/hauler-workflow-diagram-a0761cc99fb86b21c4ca1a7d8a31dfc4.png"},8453:(r,e,o)=>{o.d(e,{R:()=>n,x:()=>s});var t=o(6540);const a={},i=t.createContext(a);function n(r){const e=t.useContext(i);return t.useMemo((function(){return"function"==typeof r?r(e):{...e,...r}}),[e,r])}function s(r){let e;return e=r.disableParentContext?"function"==typeof r.components?r.components(a):r.components||a:n(r.components),t.createElement(i.Provider,{value:e},r.children)}}}]); \ No newline at end of file diff --git a/assets/js/e265a717.1dc5dc4d.js b/assets/js/e265a717.1dc5dc4d.js new file mode 100644 index 000000000..39e5ffe1b --- /dev/null +++ b/assets/js/e265a717.1dc5dc4d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9021],{2608:(o,r,e)=>{e.r(r),e.d(r,{assets:()=>l,contentTitle:()=>n,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>c});var t=e(4848),a=e(8453);const i={title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},n=void 0,s={id:"airgap-workflow",title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",source:"@site/versioned_docs/version-0.4.0/airgap-workflow.md",sourceDirName:".",slug:"/airgap-workflow",permalink:"/docs/0.4.0/airgap-workflow",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.0/airgap-workflow.md",tags:[],version:"0.4.0",frontMatter:{title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},sidebar:"haulerSidebar",previous:{title:"Core Concepts",permalink:"/docs/0.4.0/core-concepts"},next:{title:"Quickstart",permalink:"/docs/0.4.0/introduction/quickstart"}},l={},c=[{value:"Workflow Diagram",id:"workflow-diagram",level:2}];function d(o){const r={h2:"h2",img:"img",p:"p",...(0,a.R)(),...o.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(r.h2,{id:"workflow-diagram",children:"Workflow Diagram"}),"\n",(0,t.jsx)(r.p,{children:(0,t.jsx)(r.img,{alt:"hauler-workflow-diagram",src:e(8010).A+"",width:"2883",height:"1013"})}),"\n",(0,t.jsx)(r.p,{children:"Airgap Workflow Documentation pending a future release!"})]})}function u(o={}){const{wrapper:r}={...(0,a.R)(),...o.components};return r?(0,t.jsx)(r,{...o,children:(0,t.jsx)(d,{...o})}):d(o)}},8010:(o,r,e)=>{e.d(r,{A:()=>t});const t=e.p+"assets/images/hauler-workflow-diagram-a0761cc99fb86b21c4ca1a7d8a31dfc4.png"},8453:(o,r,e)=>{e.d(r,{R:()=>n,x:()=>s});var t=e(6540);const a={},i=t.createContext(a);function n(o){const r=t.useContext(i);return t.useMemo((function(){return"function"==typeof o?o(r):{...r,...o}}),[r,o])}function s(o){let r;return r=o.disableParentContext?"function"==typeof o.components?o.components(a):o.components||a:n(o.components),t.createElement(i.Provider,{value:r},o.children)}}}]); \ No newline at end of file diff --git a/assets/js/e35f73ee.60e21eaf.js b/assets/js/e35f73ee.60e21eaf.js deleted file mode 100644 index bebe74183..000000000 --- a/assets/js/e35f73ee.60e21eaf.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3482],{5914:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>o,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>l});var r=t(4848),a=t(8453);const s={title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',sidebar_label:"Images"},o=void 0,c={id:"guides-references/hauler-content/images",title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',source:"@site/versioned_docs/version-0.4.3/guides-references/hauler-content/images.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/images",permalink:"/hauler-docs/docs/0.4.3/guides-references/hauler-content/images",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.3/guides-references/hauler-content/images.md",tags:[],version:"0.4.3",frontMatter:{title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',sidebar_label:"Images"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/hauler-docs/docs/0.4.3/guides-references/hauler-content/overview"},next:{title:"Charts",permalink:"/hauler-docs/docs/0.4.3/guides-references/hauler-content/charts"}},i={},l=[];function d(e){const n={code:"code",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.p,{children:"Any OCI compatible image can be fetched remotely:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'# "shorthand" image references\nhauler store add image rancher/rancher:v2.8.1\n\n# fully qualified image references\nhauler store add image ghcr.io/fluxcd/flux-cli@sha256:02aa820c3a9c57d67208afcfc4bce9661658c17d15940aea369da259d2b976dd\n\n# adds an arch/platform specific version of a multi-arch image to the haul/store. by default, hauler will pull and save all archs/platforms contained in the image manifest. \nhauler store add image rancher/rancher:v2.8.1 --platform linux/amd64\n'})})]})}function u(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>c});var r=t(6540);const a={},s=r.createContext(a);function o(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:o(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e35f73ee.9120c18a.js b/assets/js/e35f73ee.9120c18a.js new file mode 100644 index 000000000..901818fb9 --- /dev/null +++ b/assets/js/e35f73ee.9120c18a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3482],{5914:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>o,default:()=>u,frontMatter:()=>s,metadata:()=>c,toc:()=>l});var r=t(4848),a=t(8453);const s={title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',sidebar_label:"Images"},o=void 0,c={id:"guides-references/hauler-content/images",title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',source:"@site/versioned_docs/version-0.4.3/guides-references/hauler-content/images.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/images",permalink:"/docs/0.4.3/guides-references/hauler-content/images",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.3/guides-references/hauler-content/images.md",tags:[],version:"0.4.3",frontMatter:{title:"Images (Content Type)",description:'Hauler "Images" Content Documentation',sidebar_label:"Images"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/docs/0.4.3/guides-references/hauler-content/overview"},next:{title:"Charts",permalink:"/docs/0.4.3/guides-references/hauler-content/charts"}},i={},l=[];function d(e){const n={code:"code",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.p,{children:"Any OCI compatible image can be fetched remotely:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'# "shorthand" image references\nhauler store add image rancher/rancher:v2.8.1\n\n# fully qualified image references\nhauler store add image ghcr.io/fluxcd/flux-cli@sha256:02aa820c3a9c57d67208afcfc4bce9661658c17d15940aea369da259d2b976dd\n\n# adds an arch/platform specific version of a multi-arch image to the haul/store. by default, hauler will pull and save all archs/platforms contained in the image manifest. \nhauler store add image rancher/rancher:v2.8.1 --platform linux/amd64\n'})})]})}function u(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>c});var r=t(6540);const a={},s=r.createContext(a);function o(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:o(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e59d17bf.0b478939.js b/assets/js/e59d17bf.0b478939.js new file mode 100644 index 000000000..956bc13d2 --- /dev/null +++ b/assets/js/e59d17bf.0b478939.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1246],{1948:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>s,contentTitle:()=>o,default:()=>d,frontMatter:()=>t,metadata:()=>l,toc:()=>c});var r=a(4848),i=a(8453);const t={title:"Hauler Content - Images",description:"Hauler Content - Images Documentation",sidebar_label:"Images"},o=void 0,l={id:"guides-references/hauler-content/images",title:"Hauler Content - Images",description:"Hauler Content - Images Documentation",source:"@site/versioned_docs/version-1.0.0/guides-references/hauler-content/images.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/images",permalink:"/docs/1.0.0/guides-references/hauler-content/images",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.0/guides-references/hauler-content/images.md",tags:[],version:"1.0.0",frontMatter:{title:"Hauler Content - Images",description:"Hauler Content - Images Documentation",sidebar_label:"Images"},sidebar:"haulerSidebar",previous:{title:"Community Collections",permalink:"/docs/1.0.0/guides-references/hauler-collections/community-collections"},next:{title:"Charts",permalink:"/docs/1.0.0/guides-references/hauler-content/charts"}},s={},c=[{value:"Hauler Command Line for Images",id:"hauler-command-line-for-images",level:2},{value:"Example Commands for Images",id:"example-commands-for-images",level:2},{value:"Hauler Manifest for Images",id:"hauler-manifest-for-images",level:2},{value:"Example Manifest for Images",id:"example-manifest-for-images",level:2}];function m(e){const n={code:"code",h2:"h2",pre:"pre",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"hauler-command-line-for-images",children:"Hauler Command Line for Images"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"hauler store add image --platform --key \n"})}),"\n",(0,r.jsx)(n.h2,{id:"example-commands-for-images",children:"Example Commands for Images"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"# fetch image\nhauler store add image neuvector/scanner\n\n# fetch image with full image reference\nhauler store add image name: docker.io/neuvector/updater:latest\n\n# fetch image with full image reference with digest\nhauler store add image docker.io/neuvector/updater@sha256:0076b356368c9988eec5f3cead771d29a377074b982f22800f4d9c8c3b215a56\n\n# fetch image with full image reference, specific version, specific platform\nhauler store add image docker.io/longhornio/longhorn-ui:v1.6.0 --platform: linux/amd64\n\n# fetch image with full image reference, specific version, specific platform, and signature verification\nhauler store add image docker.io/longhornio/longhorn-manager:v1.6.0 --platform linux/amd64 --key cosign-public-key.pub\n"})}),"\n",(0,r.jsx)(n.h2,{id:"hauler-manifest-for-images",children:"Hauler Manifest for Images"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-image-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\n annotations:\n # global flags for all images in the manifest\n # image flags override global flags\n hauler.dev/key: \n hauler.dev/platform: \n hauler.dev/registry: \nspec:\n images:\n - name: \n key: \n platform: \n"})}),"\n",(0,r.jsx)(n.h2,{id:"example-manifest-for-images",children:"Example Manifest for Images"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-image-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\n annotations:\n # global flags for all images in the manifest\n # image flags override global flags\n hauler.dev/key: \n hauler.dev/platform: \n hauler.dev/registry: \nspec:\n images:\n # fetch image\n - name: neuvector/scanner\n # fetch image with full image reference\n - name: docker.io/neuvector/updater:latest\n # fetch image with full image reference with digest\n - name: docker.io/neuvector/updater@sha256:0076b356368c9988eec5f3cead771d29a377074b982f22800f4d9c8c3b215a56\n # fetch image with full image reference, specific version, specific platform\n - name: docker.io/longhornio/longhorn-ui:v1.6.0\n platform: linux/amd64\n # fetch image with full image reference, specific version, specific platform, and signature verification\n - name: docker.io/longhornio/longhorn-manager:v1.6.0\n key: cosign-public-key.pub\n platform: linux/amd64\n"})})]})}function d(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(m,{...e})}):m(e)}},8453:(e,n,a)=>{a.d(n,{R:()=>o,x:()=>l});var r=a(6540);const i={},t=r.createContext(i);function o(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e59d17bf.ca375a6a.js b/assets/js/e59d17bf.ca375a6a.js deleted file mode 100644 index 2b7f7feb5..000000000 --- a/assets/js/e59d17bf.ca375a6a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1246],{1948:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>s,contentTitle:()=>o,default:()=>d,frontMatter:()=>t,metadata:()=>l,toc:()=>c});var r=a(4848),i=a(8453);const t={title:"Hauler Content - Images",description:"Hauler Content - Images Documentation",sidebar_label:"Images"},o=void 0,l={id:"guides-references/hauler-content/images",title:"Hauler Content - Images",description:"Hauler Content - Images Documentation",source:"@site/versioned_docs/version-1.0.0/guides-references/hauler-content/images.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/images",permalink:"/hauler-docs/docs/1.0.0/guides-references/hauler-content/images",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.0/guides-references/hauler-content/images.md",tags:[],version:"1.0.0",frontMatter:{title:"Hauler Content - Images",description:"Hauler Content - Images Documentation",sidebar_label:"Images"},sidebar:"haulerSidebar",previous:{title:"Community Collections",permalink:"/hauler-docs/docs/1.0.0/guides-references/hauler-collections/community-collections"},next:{title:"Charts",permalink:"/hauler-docs/docs/1.0.0/guides-references/hauler-content/charts"}},s={},c=[{value:"Hauler Command Line for Images",id:"hauler-command-line-for-images",level:2},{value:"Example Commands for Images",id:"example-commands-for-images",level:2},{value:"Hauler Manifest for Images",id:"hauler-manifest-for-images",level:2},{value:"Example Manifest for Images",id:"example-manifest-for-images",level:2}];function m(e){const n={code:"code",h2:"h2",pre:"pre",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"hauler-command-line-for-images",children:"Hauler Command Line for Images"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"hauler store add image --platform --key \n"})}),"\n",(0,r.jsx)(n.h2,{id:"example-commands-for-images",children:"Example Commands for Images"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"# fetch image\nhauler store add image neuvector/scanner\n\n# fetch image with full image reference\nhauler store add image name: docker.io/neuvector/updater:latest\n\n# fetch image with full image reference with digest\nhauler store add image docker.io/neuvector/updater@sha256:0076b356368c9988eec5f3cead771d29a377074b982f22800f4d9c8c3b215a56\n\n# fetch image with full image reference, specific version, specific platform\nhauler store add image docker.io/longhornio/longhorn-ui:v1.6.0 --platform: linux/amd64\n\n# fetch image with full image reference, specific version, specific platform, and signature verification\nhauler store add image docker.io/longhornio/longhorn-manager:v1.6.0 --platform linux/amd64 --key cosign-public-key.pub\n"})}),"\n",(0,r.jsx)(n.h2,{id:"hauler-manifest-for-images",children:"Hauler Manifest for Images"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-image-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\n annotations:\n # global flags for all images in the manifest\n # image flags override global flags\n hauler.dev/key: \n hauler.dev/platform: \n hauler.dev/registry: \nspec:\n images:\n - name: \n key: \n platform: \n"})}),"\n",(0,r.jsx)(n.h2,{id:"example-manifest-for-images",children:"Example Manifest for Images"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-image-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\n annotations:\n # global flags for all images in the manifest\n # image flags override global flags\n hauler.dev/key: \n hauler.dev/platform: \n hauler.dev/registry: \nspec:\n images:\n # fetch image\n - name: neuvector/scanner\n # fetch image with full image reference\n - name: docker.io/neuvector/updater:latest\n # fetch image with full image reference with digest\n - name: docker.io/neuvector/updater@sha256:0076b356368c9988eec5f3cead771d29a377074b982f22800f4d9c8c3b215a56\n # fetch image with full image reference, specific version, specific platform\n - name: docker.io/longhornio/longhorn-ui:v1.6.0\n platform: linux/amd64\n # fetch image with full image reference, specific version, specific platform, and signature verification\n - name: docker.io/longhornio/longhorn-manager:v1.6.0\n key: cosign-public-key.pub\n platform: linux/amd64\n"})})]})}function d(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(m,{...e})}):m(e)}},8453:(e,n,a)=>{a.d(n,{R:()=>o,x:()=>l});var r=a(6540);const i={},t=r.createContext(i);function o(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e5e2c0f7.5f5d296b.js b/assets/js/e5e2c0f7.5f5d296b.js new file mode 100644 index 000000000..1cf3f6d1e --- /dev/null +++ b/assets/js/e5e2c0f7.5f5d296b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3084],{2817:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>a});var r=n(4848),o=n(8453);const i={title:"Overview of Hauler Content",description:"Hauler Content Documentation",sidebar_label:"Overview"},s=void 0,c={id:"guides-references/hauler-content/overview",title:"Overview of Hauler Content",description:"Hauler Content Documentation",source:"@site/versioned_docs/version-0.4.1/guides-references/hauler-content/overview.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/overview",permalink:"/docs/0.4.1/guides-references/hauler-content/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.1/guides-references/hauler-content/overview.md",tags:[],version:"0.4.1",frontMatter:{title:"Overview of Hauler Content",description:"Hauler Content Documentation",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/docs/0.4.1/guides-references/hauler-collections/overview"},next:{title:"Images",permalink:"/docs/0.4.1/guides-references/hauler-content/images"}},u={},a=[];function l(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,r.jsx)(t.p,{children:"Hauler Content Overview Documentation pending a future release!"})}function d(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>c});var r=n(6540);const o={},i=r.createContext(o);function s(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e5e2c0f7.84e9114a.js b/assets/js/e5e2c0f7.84e9114a.js deleted file mode 100644 index ffffa3680..000000000 --- a/assets/js/e5e2c0f7.84e9114a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3084],{2817:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>c,toc:()=>u});var r=n(4848),o=n(8453);const i={title:"Overview of Hauler Content",description:"Hauler Content Documentation",sidebar_label:"Overview"},s=void 0,c={id:"guides-references/hauler-content/overview",title:"Overview of Hauler Content",description:"Hauler Content Documentation",source:"@site/versioned_docs/version-0.4.1/guides-references/hauler-content/overview.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/overview",permalink:"/hauler-docs/docs/0.4.1/guides-references/hauler-content/overview",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.1/guides-references/hauler-content/overview.md",tags:[],version:"0.4.1",frontMatter:{title:"Overview of Hauler Content",description:"Hauler Content Documentation",sidebar_label:"Overview"},sidebar:"haulerSidebar",previous:{title:"Overview",permalink:"/hauler-docs/docs/0.4.1/guides-references/hauler-collections/overview"},next:{title:"Images",permalink:"/hauler-docs/docs/0.4.1/guides-references/hauler-content/images"}},a={},u=[];function l(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,r.jsx)(t.p,{children:"Hauler Content Overview Documentation pending a future release!"})}function d(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>c});var r=n(6540);const o={},i=r.createContext(o);function s(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e9373bc2.4e43efd2.js b/assets/js/e9373bc2.4e43efd2.js deleted file mode 100644 index 64aaed59b..000000000 --- a/assets/js/e9373bc2.4e43efd2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7339],{7321:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>h,frontMatter:()=>a,metadata:()=>l,toc:()=>i});var r=t(4848),o=t(8453);const a={title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},s=void 0,l={id:"guides-references/command-line/hauler-store",title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",source:"@site/versioned_docs/version-0.4.0/guides-references/command-line/hauler-store.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-store",permalink:"/hauler-docs/docs/0.4.0/guides-references/command-line/hauler-store",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.0/guides-references/command-line/hauler-store.md",tags:[],version:"0.4.0",frontMatter:{title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},sidebar:"haulerSidebar",previous:{title:"Hauler",permalink:"/hauler-docs/docs/0.4.0/guides-references/command-line/hauler"},next:{title:"Hauler Completion",permalink:"/hauler-docs/docs/0.4.0/guides-references/command-line/hauler-completion"}},c={},i=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler store add:",id:"hauler-store-add",level:4},{value:"hauler store copy:",id:"hauler-store-copy",level:4},{value:"hauler store extract:",id:"hauler-store-extract",level:4},{value:"hauler store info:",id:"hauler-store-info",level:4},{value:"hauler store load:",id:"hauler-store-load",level:4},{value:"hauler store save:",id:"hauler-store-save",level:4},{value:"hauler store serve:",id:"hauler-store-serve",level:4},{value:"hauler store sync:",id:"hauler-store-sync",level:4}];function d(e){const n={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",ul:"ul",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Interact with Hauler's embedded content store."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store [flags]\n hauler store [command]\n\nAliases:\n store, s\n\nAvailable Commands:\n add Add content to store\n copy Copy all store contents to another OCI registry\n extract Extract content from the store to disk\n info Print out information about the store\n load Load a content store from a store archive\n save Save a content store to a store archive\n serve Expose the content of a local store through an OCI compliant server\n sync Sync content to the embedded content store\n\nFlags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -h, --help help for store\n -s, --store string Location to create store at (default "store")\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler store [command] --help" for more information about a command.\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-add",children:[(0,r.jsx)(n.code,{children:"hauler store add"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Add content to store."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store add [flags]\n hauler store add [command]\n\nAvailable Commands:\n chart Add a local or remote chart to the content store\n file Add a file to the content store\n image Add an image to the content store\n\nFlags:\n -h, --help help for add\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n\nUse "hauler store add [command] --help" for more information about a command.\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-copy",children:[(0,r.jsx)(n.code,{children:"hauler store copy"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Copy all store contents to another OCI registry."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store copy [flags]\n\nFlags:\n -h, --help help for copy\n --insecure Toggle allowing insecure connections when copying to a remote registry\n -p, --password string Password when copying to an authenticated remote registry\n --plain-http Toggle allowing plain http connections when copying to a remote registry\n -u, --username string Username when copying to an authenticated remote registry\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-extract",children:[(0,r.jsx)(n.code,{children:"hauler store extract"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Extract content from the store to disk."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store extract [flags]\n\nAliases:\n extract, x\n\nFlags:\n -h, --help help for extract\n -o, --output string Directory to save contents to (defaults to current directory)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-info",children:[(0,r.jsx)(n.code,{children:"hauler store info"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Print out information about the store."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store info [flags]\n\nAliases:\n info, i, list, ls\n\nFlags:\n -h, --help help for info\n -o, --output string Output format (table, json) (default "table")\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-load",children:[(0,r.jsx)(n.code,{children:"hauler store load"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Load a content store from a store archive."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store load [flags]\n\nFlags:\n -h, --help help for load\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-save",children:[(0,r.jsx)(n.code,{children:"hauler store save"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Save a content store to a store archive."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store save [flags]\n\nFlags:\n -f, --filename string Name of archive (default "pkg.tar.zst")\n -h, --help help for save\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-serve",children:[(0,r.jsx)(n.code,{children:"hauler store serve"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Expose the content of a local store through an OCI compliant server."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store serve [flags]\n\nFlags:\n -c, --config string Path to a config file, will override all other configs\n -d, --daemon Toggle serving as a daemon\n --directory string Directory to use for registry backend (defaults to \'$PWD/registry\') (default "registry")\n -h, --help help for serve\n -p, --port int Port to listen on (default 5000)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-sync",children:[(0,r.jsx)(n.code,{children:"hauler store sync"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Sync content to the embedded content store."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store sync [flags]\n\nFlags:\n -f, --files strings Path to content files\n -h, --help help for sync\n -k, --key string (Optional) Path to the key for signature verification\n --products strings Used for RGS Carbide customers to supply a product and version and Hauler will retrieve the images. i.e. \'--product rancher=v2.7.6\'\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>l});var r=t(6540);const o={},a=r.createContext(o);function s(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e9373bc2.58375a55.js b/assets/js/e9373bc2.58375a55.js new file mode 100644 index 000000000..6588a999b --- /dev/null +++ b/assets/js/e9373bc2.58375a55.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7339],{7321:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>h,frontMatter:()=>a,metadata:()=>l,toc:()=>i});var r=t(4848),o=t(8453);const a={title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},s=void 0,l={id:"guides-references/command-line/hauler-store",title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",source:"@site/versioned_docs/version-0.4.0/guides-references/command-line/hauler-store.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-store",permalink:"/docs/0.4.0/guides-references/command-line/hauler-store",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.0/guides-references/command-line/hauler-store.md",tags:[],version:"0.4.0",frontMatter:{title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},sidebar:"haulerSidebar",previous:{title:"Hauler",permalink:"/docs/0.4.0/guides-references/command-line/hauler"},next:{title:"Hauler Completion",permalink:"/docs/0.4.0/guides-references/command-line/hauler-completion"}},c={},i=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler store add:",id:"hauler-store-add",level:4},{value:"hauler store copy:",id:"hauler-store-copy",level:4},{value:"hauler store extract:",id:"hauler-store-extract",level:4},{value:"hauler store info:",id:"hauler-store-info",level:4},{value:"hauler store load:",id:"hauler-store-load",level:4},{value:"hauler store save:",id:"hauler-store-save",level:4},{value:"hauler store serve:",id:"hauler-store-serve",level:4},{value:"hauler store sync:",id:"hauler-store-sync",level:4}];function d(e){const n={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",ul:"ul",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Interact with Hauler's embedded content store."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store [flags]\n hauler store [command]\n\nAliases:\n store, s\n\nAvailable Commands:\n add Add content to store\n copy Copy all store contents to another OCI registry\n extract Extract content from the store to disk\n info Print out information about the store\n load Load a content store from a store archive\n save Save a content store to a store archive\n serve Expose the content of a local store through an OCI compliant server\n sync Sync content to the embedded content store\n\nFlags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -h, --help help for store\n -s, --store string Location to create store at (default "store")\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler store [command] --help" for more information about a command.\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-add",children:[(0,r.jsx)(n.code,{children:"hauler store add"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Add content to store."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store add [flags]\n hauler store add [command]\n\nAvailable Commands:\n chart Add a local or remote chart to the content store\n file Add a file to the content store\n image Add an image to the content store\n\nFlags:\n -h, --help help for add\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n\nUse "hauler store add [command] --help" for more information about a command.\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-copy",children:[(0,r.jsx)(n.code,{children:"hauler store copy"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Copy all store contents to another OCI registry."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store copy [flags]\n\nFlags:\n -h, --help help for copy\n --insecure Toggle allowing insecure connections when copying to a remote registry\n -p, --password string Password when copying to an authenticated remote registry\n --plain-http Toggle allowing plain http connections when copying to a remote registry\n -u, --username string Username when copying to an authenticated remote registry\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-extract",children:[(0,r.jsx)(n.code,{children:"hauler store extract"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Extract content from the store to disk."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store extract [flags]\n\nAliases:\n extract, x\n\nFlags:\n -h, --help help for extract\n -o, --output string Directory to save contents to (defaults to current directory)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-info",children:[(0,r.jsx)(n.code,{children:"hauler store info"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Print out information about the store."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store info [flags]\n\nAliases:\n info, i, list, ls\n\nFlags:\n -h, --help help for info\n -o, --output string Output format (table, json) (default "table")\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-load",children:[(0,r.jsx)(n.code,{children:"hauler store load"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Load a content store from a store archive."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store load [flags]\n\nFlags:\n -h, --help help for load\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-save",children:[(0,r.jsx)(n.code,{children:"hauler store save"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Save a content store to a store archive."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store save [flags]\n\nFlags:\n -f, --filename string Name of archive (default "pkg.tar.zst")\n -h, --help help for save\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-serve",children:[(0,r.jsx)(n.code,{children:"hauler store serve"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Expose the content of a local store through an OCI compliant server."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store serve [flags]\n\nFlags:\n -c, --config string Path to a config file, will override all other configs\n -d, --daemon Toggle serving as a daemon\n --directory string Directory to use for registry backend (defaults to \'$PWD/registry\') (default "registry")\n -h, --help help for serve\n -p, --port int Port to listen on (default 5000)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,r.jsxs)(n.h4,{id:"hauler-store-sync",children:[(0,r.jsx)(n.code,{children:"hauler store sync"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Sync content to the embedded content store."}),"\n"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler store sync [flags]\n\nFlags:\n -f, --files strings Path to content files\n -h, --help help for sync\n -k, --key string (Optional) Path to the key for signature verification\n --products strings Used for RGS Carbide customers to supply a product and version and Hauler will retrieve the images. i.e. \'--product rancher=v2.7.6\'\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>l});var r=t(6540);const o={},a=r.createContext(o);function s(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e9c31bdf.137cbee1.js b/assets/js/e9c31bdf.137cbee1.js deleted file mode 100644 index 01d05327d..000000000 --- a/assets/js/e9c31bdf.137cbee1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[608],{624:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>t,contentTitle:()=>l,default:()=>u,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var o=r(4848),s=r(8453);const i={title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},l=void 0,a={id:"guides-references/command-line/hauler-version",title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",source:"@site/versioned_docs/version-0.4.4/guides-references/command-line/hauler-version.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-version",permalink:"/hauler-docs/docs/0.4.4/guides-references/command-line/hauler-version",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.4/guides-references/command-line/hauler-version.md",tags:[],version:"0.4.4",frontMatter:{title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},sidebar:"haulerSidebar",previous:{title:"Hauler Completion",permalink:"/hauler-docs/docs/0.4.4/guides-references/command-line/hauler-completion"},next:{title:"Known Issues/Limits",permalink:"/hauler-docs/docs/0.4.4/known-limits"}},t={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Print Hauler's current version."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler version [flags]\n\nAliases:\n version, v\n\nFlags:\n -h, --help help for version\n --json toggle output in JSON\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>a});var o=r(6540);const s={},i=o.createContext(s);function l(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e9c31bdf.4742e6c5.js b/assets/js/e9c31bdf.4742e6c5.js new file mode 100644 index 000000000..c6edf47dc --- /dev/null +++ b/assets/js/e9c31bdf.4742e6c5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[608],{624:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>t,toc:()=>c});var o=r(4848),s=r(8453);const i={title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},l=void 0,t={id:"guides-references/command-line/hauler-version",title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",source:"@site/versioned_docs/version-0.4.4/guides-references/command-line/hauler-version.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-version",permalink:"/docs/0.4.4/guides-references/command-line/hauler-version",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.4/guides-references/command-line/hauler-version.md",tags:[],version:"0.4.4",frontMatter:{title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},sidebar:"haulerSidebar",previous:{title:"Hauler Completion",permalink:"/docs/0.4.4/guides-references/command-line/hauler-completion"},next:{title:"Known Issues/Limits",permalink:"/docs/0.4.4/known-limits"}},a={},c=[{value:"Command Overview",id:"command-overview",level:3}];function u(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Print Hauler's current version."}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler version [flags]\n\nAliases:\n version, v\n\nFlags:\n -h, --help help for version\n --json toggle output in JSON\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})})]})}function d(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(u,{...e})}):u(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>t});var o=r(6540);const s={},i=o.createContext(s);function l(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e9c8eb9f.93b0fa24.js b/assets/js/e9c8eb9f.93b0fa24.js deleted file mode 100644 index be66901ed..000000000 --- a/assets/js/e9c8eb9f.93b0fa24.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4812],{2986:(n,t,e)=>{e.r(t),e.d(t,{assets:()=>a,contentTitle:()=>s,default:()=>d,frontMatter:()=>r,metadata:()=>l,toc:()=>c});var o=e(4848),i=e(8453);const r={title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},s=void 0,l={id:"introduction/uninstall",title:"Uninstall",description:"Uninstall Documentation for Hauler",source:"@site/versioned_docs/version-0.4.3/introduction/uninstall.md",sourceDirName:"introduction",slug:"/introduction/uninstall",permalink:"/hauler-docs/docs/0.4.3/introduction/uninstall",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.3/introduction/uninstall.md",tags:[],version:"0.4.3",frontMatter:{title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},sidebar:"haulerSidebar",previous:{title:"Installation",permalink:"/hauler-docs/docs/0.4.3/introduction/install"},next:{title:"Overview",permalink:"/hauler-docs/docs/0.4.3/guides-references/overview"}},a={},c=[];function u(n){const t={p:"p",...(0,i.R)(),...n.components};return(0,o.jsx)(t.p,{children:"Uninstall Documentation pending a future release!"})}function d(n={}){const{wrapper:t}={...(0,i.R)(),...n.components};return t?(0,o.jsx)(t,{...n,children:(0,o.jsx)(u,{...n})}):u(n)}},8453:(n,t,e)=>{e.d(t,{R:()=>s,x:()=>l});var o=e(6540);const i={},r=o.createContext(i);function s(n){const t=o.useContext(r);return o.useMemo((function(){return"function"==typeof n?n(t):{...t,...n}}),[t,n])}function l(n){let t;return t=n.disableParentContext?"function"==typeof n.components?n.components(i):n.components||i:s(n.components),o.createElement(r.Provider,{value:t},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/e9c8eb9f.d59894a0.js b/assets/js/e9c8eb9f.d59894a0.js new file mode 100644 index 000000000..719f94254 --- /dev/null +++ b/assets/js/e9c8eb9f.d59894a0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4812],{2986:(n,t,e)=>{e.r(t),e.d(t,{assets:()=>a,contentTitle:()=>s,default:()=>d,frontMatter:()=>r,metadata:()=>l,toc:()=>c});var i=e(4848),o=e(8453);const r={title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},s=void 0,l={id:"introduction/uninstall",title:"Uninstall",description:"Uninstall Documentation for Hauler",source:"@site/versioned_docs/version-0.4.3/introduction/uninstall.md",sourceDirName:"introduction",slug:"/introduction/uninstall",permalink:"/docs/0.4.3/introduction/uninstall",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.3/introduction/uninstall.md",tags:[],version:"0.4.3",frontMatter:{title:"Uninstall",description:"Uninstall Documentation for Hauler",sidebar_label:"Uninstall"},sidebar:"haulerSidebar",previous:{title:"Installation",permalink:"/docs/0.4.3/introduction/install"},next:{title:"Overview",permalink:"/docs/0.4.3/guides-references/overview"}},a={},c=[];function u(n){const t={p:"p",...(0,o.R)(),...n.components};return(0,i.jsx)(t.p,{children:"Uninstall Documentation pending a future release!"})}function d(n={}){const{wrapper:t}={...(0,o.R)(),...n.components};return t?(0,i.jsx)(t,{...n,children:(0,i.jsx)(u,{...n})}):u(n)}},8453:(n,t,e)=>{e.d(t,{R:()=>s,x:()=>l});var i=e(6540);const o={},r=i.createContext(o);function s(n){const t=i.useContext(r);return i.useMemo((function(){return"function"==typeof n?n(t):{...t,...n}}),[t,n])}function l(n){let t;return t=n.disableParentContext?"function"==typeof n.components?n.components(o):n.components||o:s(n.components),i.createElement(r.Provider,{value:t},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/eb3f7e0d.18a7457a.js b/assets/js/eb3f7e0d.18a7457a.js new file mode 100644 index 000000000..1753b7f23 --- /dev/null +++ b/assets/js/eb3f7e0d.18a7457a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4373],{9109:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>t,contentTitle:()=>s,default:()=>u,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var o=r(4848),l=r(8453);const i={title:"Hauler Login (Command)",description:"Hauler CLI Reference for hauler login",sidebar_label:"Hauler Login"},s=void 0,a={id:"guides-references/command-line/hauler-login",title:"Hauler Login (Command)",description:"Hauler CLI Reference for hauler login",source:"@site/docs/guides-references/command-line/hauler-login.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-login",permalink:"/docs/next/guides-references/command-line/hauler-login",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/docs/guides-references/command-line/hauler-login.md",tags:[],version:"current",frontMatter:{title:"Hauler Login (Command)",description:"Hauler CLI Reference for hauler login",sidebar_label:"Hauler Login"}},t={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,l.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Log in to a registry"}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler login [flags]\n\nExamples:\n\n# login to registry.example.com\nhauler login registry.example.com -u bob -p haulin\n\nFlags:\n -h, --help help for login\n -p, --password string Password\n --password-stdin Take the password from stdin\n -u, --username string Username\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})})]})}function u(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>a});var o=r(6540);const l={},i=o.createContext(l);function s(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/eb3f7e0d.94a88687.js b/assets/js/eb3f7e0d.94a88687.js deleted file mode 100644 index 6eb72ba12..000000000 --- a/assets/js/eb3f7e0d.94a88687.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[4373],{9109:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>t,contentTitle:()=>s,default:()=>u,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var o=r(4848),l=r(8453);const i={title:"Hauler Login (Command)",description:"Hauler CLI Reference for hauler login",sidebar_label:"Hauler Login"},s=void 0,a={id:"guides-references/command-line/hauler-login",title:"Hauler Login (Command)",description:"Hauler CLI Reference for hauler login",source:"@site/docs/guides-references/command-line/hauler-login.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-login",permalink:"/hauler-docs/docs/next/guides-references/command-line/hauler-login",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/docs/guides-references/command-line/hauler-login.md",tags:[],version:"current",frontMatter:{title:"Hauler Login (Command)",description:"Hauler CLI Reference for hauler login",sidebar_label:"Hauler Login"}},t={},c=[{value:"Command Overview",id:"command-overview",level:3}];function d(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,l.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"Log in to a registry"}),"\n"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-yaml",children:'Usage:\n hauler login [flags]\n\nExamples:\n\n# login to registry.example.com\nhauler login registry.example.com -u bob -p haulin\n\nFlags:\n -h, --help help for login\n -p, --password string Password\n --password-stdin Take the password from stdin\n -u, --username string Username\n\nGlobal Flags:\n -l, --log-level string (default "info")\n'})})]})}function u(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>a});var o=r(6540);const l={},i=o.createContext(l);function s(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f10ad690.07d55c74.js b/assets/js/f10ad690.07d55c74.js deleted file mode 100644 index 85684494a..000000000 --- a/assets/js/f10ad690.07d55c74.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1992],{7140:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>m,frontMatter:()=>s,metadata:()=>r,toc:()=>u});var o=n(4848),c=n(8453);const s={title:"Hauler Community Collections",description:"Hauler Community Collections Documentation",sidebar_label:"Community Collections"},i=void 0,r={id:"guides-references/hauler-collections/community-collections",title:"Hauler Community Collections",description:"Hauler Community Collections Documentation",source:"@site/docs/guides-references/hauler-collections/community-collections.md",sourceDirName:"guides-references/hauler-collections",slug:"/guides-references/hauler-collections/community-collections",permalink:"/hauler-docs/docs/next/guides-references/hauler-collections/community-collections",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/docs/guides-references/hauler-collections/community-collections.md",tags:[],version:"current",frontMatter:{title:"Hauler Community Collections",description:"Hauler Community Collections Documentation",sidebar_label:"Community Collections"},sidebar:"haulerSidebar",previous:{title:"Hauler Manifests",permalink:"/hauler-docs/docs/next/guides-references/manifests"},next:{title:"Images",permalink:"/hauler-docs/docs/next/guides-references/hauler-content/images"}},l={},u=[];function a(e){const t={p:"p",...(0,c.R)(),...e.components};return(0,o.jsx)(t.p,{children:"Hauler Community Collections are pending a future release!"})}function m(e={}){const{wrapper:t}={...(0,c.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(a,{...e})}):a(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>r});var o=n(6540);const c={},s=o.createContext(c);function i(e){const t=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),o.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f10ad690.41f99b6f.js b/assets/js/f10ad690.41f99b6f.js new file mode 100644 index 000000000..a6e80f3c8 --- /dev/null +++ b/assets/js/f10ad690.41f99b6f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[1992],{7140:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>s,default:()=>m,frontMatter:()=>c,metadata:()=>l,toc:()=>u});var o=n(4848),i=n(8453);const c={title:"Hauler Community Collections",description:"Hauler Community Collections Documentation",sidebar_label:"Community Collections"},s=void 0,l={id:"guides-references/hauler-collections/community-collections",title:"Hauler Community Collections",description:"Hauler Community Collections Documentation",source:"@site/docs/guides-references/hauler-collections/community-collections.md",sourceDirName:"guides-references/hauler-collections",slug:"/guides-references/hauler-collections/community-collections",permalink:"/docs/next/guides-references/hauler-collections/community-collections",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/docs/guides-references/hauler-collections/community-collections.md",tags:[],version:"current",frontMatter:{title:"Hauler Community Collections",description:"Hauler Community Collections Documentation",sidebar_label:"Community Collections"},sidebar:"haulerSidebar",previous:{title:"Hauler Manifests",permalink:"/docs/next/guides-references/manifests"},next:{title:"Images",permalink:"/docs/next/guides-references/hauler-content/images"}},r={},u=[];function a(e){const t={p:"p",...(0,i.R)(),...e.components};return(0,o.jsx)(t.p,{children:"Hauler Community Collections are pending a future release!"})}function m(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(a,{...e})}):a(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>s,x:()=>l});var o=n(6540);const i={},c=o.createContext(i);function s(e){const t=o.useContext(c);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),o.createElement(c.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f663b962.39732e56.js b/assets/js/f663b962.39732e56.js deleted file mode 100644 index 6fa9adca4..000000000 --- a/assets/js/f663b962.39732e56.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2961],{9029:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var r=t(4848),s=t(8453);const i={title:"Hauler Registry",description:"Hauler Registry Documentation",sidebar_label:"Hauler Registry"},a=void 0,o={id:"guides-references/utilities/registry",title:"Hauler Registry",description:"Hauler Registry Documentation",source:"@site/docs/guides-references/utilities/registry.md",sourceDirName:"guides-references/utilities",slug:"/guides-references/utilities/registry",permalink:"/hauler-docs/docs/next/guides-references/utilities/registry",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/docs/guides-references/utilities/registry.md",tags:[],version:"current",frontMatter:{title:"Hauler Registry",description:"Hauler Registry Documentation",sidebar_label:"Hauler Registry"},sidebar:"haulerSidebar",previous:{title:"RGS Carbide Customers",permalink:"/hauler-docs/docs/next/guides-references/carbide-customers"},next:{title:"Hauler Fileserver",permalink:"/hauler-docs/docs/next/guides-references/utilities/fileserver"}},l={},c=[{value:"Overview",id:"overview",level:2},{value:"Example Commands for the Hauler Registry",id:"example-commands-for-the-hauler-registry",level:2},{value:"Example Config for the Hauler Registry",id:"example-config-for-the-hauler-registry",level:2}];function d(e){const n={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"overview",children:"Overview"}),"\n",(0,r.jsx)(n.p,{children:"Hauler Registry docs are pending a future release!"}),"\n",(0,r.jsx)(n.h2,{id:"example-commands-for-the-hauler-registry",children:"Example Commands for the Hauler Registry"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"# serve registry\nhauler store serve registry\n\n# serve registry on specific port\nhauler store serve registry --port \n\n# serve registry on specific port with custom config\nhauler store serve registry --port --config \n\n# serve registry in writeable mode\nhauler store serve registry --readonly=false\n"})}),"\n",(0,r.jsx)(n.h2,{id:"example-config-for-the-hauler-registry",children:"Example Config for the Hauler Registry"}),"\n",(0,r.jsx)(n.p,{children:"These are all configuration options for the registry. Some options in the list are mutually exclusive. Read the detailed reference information about each option before finalizing your configuration."}),"\n",(0,r.jsxs)(n.p,{children:["You can learn more here --\x3e ",(0,r.jsx)(n.a,{href:"https://distribution.github.io/distribution/about/configuration",children:"https://distribution.github.io/distribution/about/configuration"})]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:'version: 0.1\nlog:\n accesslog:\n disabled: true\n level: debug\n formatter: text\n fields:\n service: registry\n environment: staging\n hooks:\n - type: mail\n disabled: true\n levels:\n - panic\n options:\n smtp:\n addr: mail.example.com:25\n username: mailuser\n password: password\n insecure: true\n from: sender@example.com\n to:\n - errors@example.com\nloglevel: debug # deprecated: use "log"\nstorage:\n filesystem:\n rootdirectory: /var/lib/registry\n maxthreads: 100\n azure:\n accountname: accountname\n accountkey: base64encodedaccountkey\n container: containername\n rootdirectory: /az/object/name/prefix\n credentials:\n type: client_secret\n clientid: client_id_string\n tenantid: tenant_id_string\n secret: secret_string\n copy_status_poll_max_retry: 10\n copy_status_poll_delay: 100ms\n gcs:\n bucket: bucketname\n keyfile: /path/to/keyfile\n credentials:\n type: service_account\n project_id: project_id_string\n private_key_id: private_key_id_string\n private_key: private_key_string\n client_email: client@example.com\n client_id: client_id_string\n auth_uri: http://example.com/auth_uri\n token_uri: http://example.com/token_uri\n auth_provider_x509_cert_url: http://example.com/provider_cert_url\n client_x509_cert_url: http://example.com/client_cert_url\n rootdirectory: /gcs/object/name/prefix\n chunksize: 5242880\n s3:\n accesskey: awsaccesskey\n secretkey: awssecretkey\n region: us-west-1\n regionendpoint: http://myobjects.local\n forcepathstyle: true\n accelerate: false\n bucket: bucketname\n encrypt: true\n keyid: mykeyid\n secure: true\n v4auth: true\n chunksize: 5242880\n multipartcopychunksize: 33554432\n multipartcopymaxconcurrency: 100\n multipartcopythresholdsize: 33554432\n rootdirectory: /s3/object/name/prefix\n usedualstack: false\n loglevel: debug\n inmemory: # This driver takes no parameters\n tag:\n concurrencylimit: 8\n delete:\n enabled: false\n redirect:\n disable: false\n cache:\n blobdescriptor: redis\n blobdescriptorsize: 10000\n maintenance:\n uploadpurging:\n enabled: true\n age: 168h\n interval: 24h\n dryrun: false\n readonly:\n enabled: false\nauth:\n silly:\n realm: silly-realm\n service: silly-service\n token:\n autoredirect: true\n realm: token-realm\n service: token-service\n issuer: registry-token-issuer\n rootcertbundle: /root/certs/bundle\n htpasswd:\n realm: basic-realm\n path: /path/to/htpasswd\nmiddleware:\n registry:\n - name: ARegistryMiddleware\n options:\n foo: bar\n repository:\n - name: ARepositoryMiddleware\n options:\n foo: bar\n storage:\n - name: cloudfront\n options:\n baseurl: https://my.cloudfronted.domain.com/\n privatekey: /path/to/pem\n keypairid: cloudfrontkeypairid\n duration: 3000s\n ipfilteredby: awsregion\n awsregion: us-east-1, use-east-2\n updatefrequency: 12h\n iprangesurl: https://ip-ranges.amazonaws.com/ip-ranges.json\n storage:\n - name: redirect\n options:\n baseurl: https://example.com/\nhttp:\n addr: localhost:5000\n prefix: /my/nested/registry/\n host: https://myregistryaddress.org:5000\n secret: asecretforlocaldevelopment\n relativeurls: false\n draintimeout: 60s\n tls:\n certificate: /path/to/x509/public\n key: /path/to/x509/private\n clientcas:\n - /path/to/ca.pem\n - /path/to/another/ca.pem\n letsencrypt:\n cachefile: /path/to/cache-file\n email: emailused@letsencrypt.com\n hosts: [myregistryaddress.org]\n directoryurl: https://acme-v02.api.letsencrypt.org/directory\n debug:\n addr: localhost:5001\n prometheus:\n enabled: true\n path: /metrics\n headers:\n X-Content-Type-Options: [nosniff]\n http2:\n disabled: false\n h2c:\n enabled: false\nnotifications:\n events:\n includereferences: true\n endpoints:\n - name: alistener\n disabled: false\n url: https://my.listener.com/event\n headers: \n timeout: 1s\n threshold: 10\n backoff: 1s\n ignoredmediatypes:\n - application/octet-stream\n ignore:\n mediatypes:\n - application/octet-stream\n actions:\n - pull\nredis:\n addr: localhost:6379\n password: asecret\n db: 0\n dialtimeout: 10ms\n readtimeout: 10ms\n writetimeout: 10ms\n pool:\n maxidle: 16\n maxactive: 64\n idletimeout: 300s\n tls:\n enabled: false\nhealth:\n storagedriver:\n enabled: true\n interval: 10s\n threshold: 3\n file:\n - file: /path/to/checked/file\n interval: 10s\n http:\n - uri: http://server.to.check/must/return/200\n headers:\n Authorization: [Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==]\n statuscode: 200\n timeout: 3s\n interval: 10s\n threshold: 3\n tcp:\n - addr: redis-server.domain.com:6379\n timeout: 3s\n interval: 10s\n threshold: 3\nproxy:\n remoteurl: https://registry-1.docker.io\n username: [username]\n password: [password]\n ttl: 168h\nvalidation:\n manifests:\n urls:\n allow:\n - ^https?://([^/]+\\.)*example\\.com/\n deny:\n - ^https?://www\\.example\\.com/\n'})})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>o});var r=t(6540);const s={},i=r.createContext(s);function a(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f663b962.9a2853ee.js b/assets/js/f663b962.9a2853ee.js new file mode 100644 index 000000000..5f24e6508 --- /dev/null +++ b/assets/js/f663b962.9a2853ee.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[2961],{9029:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>u,frontMatter:()=>s,metadata:()=>o,toc:()=>c});var r=t(4848),i=t(8453);const s={title:"Hauler Registry",description:"Hauler Registry Documentation",sidebar_label:"Hauler Registry"},a=void 0,o={id:"guides-references/utilities/registry",title:"Hauler Registry",description:"Hauler Registry Documentation",source:"@site/docs/guides-references/utilities/registry.md",sourceDirName:"guides-references/utilities",slug:"/guides-references/utilities/registry",permalink:"/docs/next/guides-references/utilities/registry",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/docs/guides-references/utilities/registry.md",tags:[],version:"current",frontMatter:{title:"Hauler Registry",description:"Hauler Registry Documentation",sidebar_label:"Hauler Registry"},sidebar:"haulerSidebar",previous:{title:"RGS Carbide Customers",permalink:"/docs/next/guides-references/carbide-customers"},next:{title:"Hauler Fileserver",permalink:"/docs/next/guides-references/utilities/fileserver"}},l={},c=[{value:"Overview",id:"overview",level:2},{value:"Example Commands for the Hauler Registry",id:"example-commands-for-the-hauler-registry",level:2},{value:"Example Config for the Hauler Registry",id:"example-config-for-the-hauler-registry",level:2}];function d(e){const n={a:"a",code:"code",h2:"h2",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"overview",children:"Overview"}),"\n",(0,r.jsx)(n.p,{children:"Hauler Registry docs are pending a future release!"}),"\n",(0,r.jsx)(n.h2,{id:"example-commands-for-the-hauler-registry",children:"Example Commands for the Hauler Registry"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"# serve registry\nhauler store serve registry\n\n# serve registry on specific port\nhauler store serve registry --port \n\n# serve registry on specific port with custom config\nhauler store serve registry --port --config \n\n# serve registry in writeable mode\nhauler store serve registry --readonly=false\n"})}),"\n",(0,r.jsx)(n.h2,{id:"example-config-for-the-hauler-registry",children:"Example Config for the Hauler Registry"}),"\n",(0,r.jsx)(n.p,{children:"These are all configuration options for the registry. Some options in the list are mutually exclusive. Read the detailed reference information about each option before finalizing your configuration."}),"\n",(0,r.jsxs)(n.p,{children:["You can learn more here --\x3e ",(0,r.jsx)(n.a,{href:"https://distribution.github.io/distribution/about/configuration",children:"https://distribution.github.io/distribution/about/configuration"})]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:'version: 0.1\nlog:\n accesslog:\n disabled: true\n level: debug\n formatter: text\n fields:\n service: registry\n environment: staging\n hooks:\n - type: mail\n disabled: true\n levels:\n - panic\n options:\n smtp:\n addr: mail.example.com:25\n username: mailuser\n password: password\n insecure: true\n from: sender@example.com\n to:\n - errors@example.com\nloglevel: debug # deprecated: use "log"\nstorage:\n filesystem:\n rootdirectory: /var/lib/registry\n maxthreads: 100\n azure:\n accountname: accountname\n accountkey: base64encodedaccountkey\n container: containername\n rootdirectory: /az/object/name/prefix\n credentials:\n type: client_secret\n clientid: client_id_string\n tenantid: tenant_id_string\n secret: secret_string\n copy_status_poll_max_retry: 10\n copy_status_poll_delay: 100ms\n gcs:\n bucket: bucketname\n keyfile: /path/to/keyfile\n credentials:\n type: service_account\n project_id: project_id_string\n private_key_id: private_key_id_string\n private_key: private_key_string\n client_email: client@example.com\n client_id: client_id_string\n auth_uri: http://example.com/auth_uri\n token_uri: http://example.com/token_uri\n auth_provider_x509_cert_url: http://example.com/provider_cert_url\n client_x509_cert_url: http://example.com/client_cert_url\n rootdirectory: /gcs/object/name/prefix\n chunksize: 5242880\n s3:\n accesskey: awsaccesskey\n secretkey: awssecretkey\n region: us-west-1\n regionendpoint: http://myobjects.local\n forcepathstyle: true\n accelerate: false\n bucket: bucketname\n encrypt: true\n keyid: mykeyid\n secure: true\n v4auth: true\n chunksize: 5242880\n multipartcopychunksize: 33554432\n multipartcopymaxconcurrency: 100\n multipartcopythresholdsize: 33554432\n rootdirectory: /s3/object/name/prefix\n usedualstack: false\n loglevel: debug\n inmemory: # This driver takes no parameters\n tag:\n concurrencylimit: 8\n delete:\n enabled: false\n redirect:\n disable: false\n cache:\n blobdescriptor: redis\n blobdescriptorsize: 10000\n maintenance:\n uploadpurging:\n enabled: true\n age: 168h\n interval: 24h\n dryrun: false\n readonly:\n enabled: false\nauth:\n silly:\n realm: silly-realm\n service: silly-service\n token:\n autoredirect: true\n realm: token-realm\n service: token-service\n issuer: registry-token-issuer\n rootcertbundle: /root/certs/bundle\n htpasswd:\n realm: basic-realm\n path: /path/to/htpasswd\nmiddleware:\n registry:\n - name: ARegistryMiddleware\n options:\n foo: bar\n repository:\n - name: ARepositoryMiddleware\n options:\n foo: bar\n storage:\n - name: cloudfront\n options:\n baseurl: https://my.cloudfronted.domain.com/\n privatekey: /path/to/pem\n keypairid: cloudfrontkeypairid\n duration: 3000s\n ipfilteredby: awsregion\n awsregion: us-east-1, use-east-2\n updatefrequency: 12h\n iprangesurl: https://ip-ranges.amazonaws.com/ip-ranges.json\n storage:\n - name: redirect\n options:\n baseurl: https://example.com/\nhttp:\n addr: localhost:5000\n prefix: /my/nested/registry/\n host: https://myregistryaddress.org:5000\n secret: asecretforlocaldevelopment\n relativeurls: false\n draintimeout: 60s\n tls:\n certificate: /path/to/x509/public\n key: /path/to/x509/private\n clientcas:\n - /path/to/ca.pem\n - /path/to/another/ca.pem\n letsencrypt:\n cachefile: /path/to/cache-file\n email: emailused@letsencrypt.com\n hosts: [myregistryaddress.org]\n directoryurl: https://acme-v02.api.letsencrypt.org/directory\n debug:\n addr: localhost:5001\n prometheus:\n enabled: true\n path: /metrics\n headers:\n X-Content-Type-Options: [nosniff]\n http2:\n disabled: false\n h2c:\n enabled: false\nnotifications:\n events:\n includereferences: true\n endpoints:\n - name: alistener\n disabled: false\n url: https://my.listener.com/event\n headers: \n timeout: 1s\n threshold: 10\n backoff: 1s\n ignoredmediatypes:\n - application/octet-stream\n ignore:\n mediatypes:\n - application/octet-stream\n actions:\n - pull\nredis:\n addr: localhost:6379\n password: asecret\n db: 0\n dialtimeout: 10ms\n readtimeout: 10ms\n writetimeout: 10ms\n pool:\n maxidle: 16\n maxactive: 64\n idletimeout: 300s\n tls:\n enabled: false\nhealth:\n storagedriver:\n enabled: true\n interval: 10s\n threshold: 3\n file:\n - file: /path/to/checked/file\n interval: 10s\n http:\n - uri: http://server.to.check/must/return/200\n headers:\n Authorization: [Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==]\n statuscode: 200\n timeout: 3s\n interval: 10s\n threshold: 3\n tcp:\n - addr: redis-server.domain.com:6379\n timeout: 3s\n interval: 10s\n threshold: 3\nproxy:\n remoteurl: https://registry-1.docker.io\n username: [username]\n password: [password]\n ttl: 168h\nvalidation:\n manifests:\n urls:\n allow:\n - ^https?://([^/]+\\.)*example\\.com/\n deny:\n - ^https?://www\\.example\\.com/\n'})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>o});var r=t(6540);const i={},s=r.createContext(i);function a(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f674df19.4f44f044.js b/assets/js/f674df19.4f44f044.js new file mode 100644 index 000000000..4661e05c2 --- /dev/null +++ b/assets/js/f674df19.4f44f044.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5058],{6453:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>i,contentTitle:()=>s,default:()=>h,frontMatter:()=>o,metadata:()=>l,toc:()=>c});var n=t(4848),a=t(8453);const o={title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},s=void 0,l={id:"guides-references/command-line/hauler-store",title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",source:"@site/versioned_docs/version-0.4.4/guides-references/command-line/hauler-store.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-store",permalink:"/docs/0.4.4/guides-references/command-line/hauler-store",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.4/guides-references/command-line/hauler-store.md",tags:[],version:"0.4.4",frontMatter:{title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},sidebar:"haulerSidebar",previous:{title:"Hauler",permalink:"/docs/0.4.4/guides-references/command-line/hauler"},next:{title:"Hauler Completion",permalink:"/docs/0.4.4/guides-references/command-line/hauler-completion"}},i={},c=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler store add:",id:"hauler-store-add",level:4},{value:"hauler store add chart:",id:"hauler-store-add-chart",level:4},{value:"hauler store add file:",id:"hauler-store-add-file",level:4},{value:"hauler store add image:",id:"hauler-store-add-image",level:4},{value:"hauler store copy:",id:"hauler-store-copy",level:4},{value:"hauler store extract:",id:"hauler-store-extract",level:4},{value:"hauler store info:",id:"hauler-store-info",level:4},{value:"hauler store load:",id:"hauler-store-load",level:4},{value:"hauler store save:",id:"hauler-store-save",level:4},{value:"hauler store serve:",id:"hauler-store-serve",level:4},{value:"hauler store serve registry:",id:"hauler-store-serve-registry",level:4},{value:"hauler store serve fileserver:",id:"hauler-store-serve-fileserver",level:4},{value:"hauler store sync:",id:"hauler-store-sync",level:4}];function d(e){const r={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Interact with Hauler's embedded content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store [flags]\n hauler store [command]\n\nAliases:\n store, s\n\nAvailable Commands:\n add Add content to store\n copy Copy all store contents to another OCI registry\n extract Extract content from the store to disk\n info Print out information about the store\n load Load a content store from a store archive\n save Save a content store to a store archive\n serve Expose the content of a local store through an OCI compliant server\n sync Sync content to the embedded content store\n\nFlags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -h, --help help for store\n -s, --store string Location to create store at (default "store")\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler store [command] --help" for more information about a command.\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-add",children:[(0,n.jsx)(r.code,{children:"hauler store add"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Add content to store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add [flags]\n hauler store add [command]\n\nAvailable Commands:\n chart Add a local or remote chart to the content store\n file Add a file to the content store\n image Add an image to the content store\n\nFlags:\n -h, --help help for add\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n\nUse "hauler store add [command] --help" for more information about a command.\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-add-chart",children:[(0,n.jsx)(r.code,{children:"hauler store add chart"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Add a local or remote chart to the content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add chart [flags]\n\nExamples:\n\n# add a local chart\nhauler store add chart path/to/chart/directory\n\n# add a local compressed chart\nhauler store add chart path/to/chart.tar.gz\n\n# add a remote chart\nhauler store add chart longhorn --repo "https://charts.longhorn.io"\n\n# add a specific version of a chart\nhauler store add chart rancher --repo "https://releases.rancher.com/server-charts/latest" --version "2.6.2"\n\n\nFlags:\n --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle\n --cert-file string identify HTTPS client using this SSL certificate file\n -h, --help help for chart\n --insecure-skip-tls-verify skip tls certificate checks for the chart download\n --key-file string identify HTTPS client using this SSL key file\n --password string chart repository password where to locate the requested chart\n --repo string chart repository url where to locate the requested chart\n --username string chart repository username where to locate the requested chart\n --verify verify the package before using it\n --version string specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-add-file",children:[(0,n.jsx)(r.code,{children:"hauler store add file"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Add a file to the content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add file [flags]\n\nFlags:\n -h, --help help for file\n -n, --name string (Optional) Name to assign to file in store\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-add-image",children:[(0,n.jsx)(r.code,{children:"hauler store add image"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Add an image to the content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add image [flags]\n\nFlags:\n -h, --help help for image\n -k, --key string (Optional) Path to the key for digital signature verification\n -p, --platform string (Optional) Specific platform to save. i.e. linux/amd64. Defaults to all if flag is omitted.\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-copy",children:[(0,n.jsx)(r.code,{children:"hauler store copy"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Copy all store contents to another OCI registry."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store copy [flags]\n\nFlags:\n -h, --help help for copy\n --insecure Toggle allowing insecure connections when copying to a remote registry\n -p, --password string Password when copying to an authenticated remote registry\n --plain-http Toggle allowing plain http connections when copying to a remote registry\n -u, --username string Username when copying to an authenticated remote registry\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")h\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-extract",children:[(0,n.jsx)(r.code,{children:"hauler store extract"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Extract content from the store to disk."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store extract [flags]\n\nAliases:\n extract, x\n\nFlags:\n -h, --help help for extract\n -o, --output string Directory to save contents to (defaults to current directory)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-info",children:[(0,n.jsx)(r.code,{children:"hauler store info"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Print out information about the store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store info [flags]\n\nAliases:\n info, i, list, ls\n\nFlags:\n -h, --help help for info\n -o, --output string Output format (table, json) (default "table")\n -t, --type string Filter on type (image, chart, file) (default "all")\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-load",children:[(0,n.jsx)(r.code,{children:"hauler store load"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Load a content store from a store archive."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store load [flags]\n\nFlags:\n -h, --help help for load\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-save",children:[(0,n.jsx)(r.code,{children:"hauler store save"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Save a content store to a store archive."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store save [flags]\n\nFlags:\n -f, --filename string Name of archive (default "pkg.tar.zst")\n -h, --help help for save\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-serve",children:[(0,n.jsx)(r.code,{children:"hauler store serve"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Expose the content of a local store through an OCI compliant server."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve [flags]\n\nAvailable Commands:\n fileserver Serve the file server\n registry Serve the embedded registry\n\nFlags:\n -h, --help help for serve\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-serve-registry",children:[(0,n.jsx)(r.code,{children:"hauler store serve registry"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Serve the embedded registry"}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve registry [flags]\n\nFlags:\n -c, --config string Path to a config file, will override all other configs\n --directory string Directory to use for backend. Defaults to $PWD/registry (default "registry")\n -h, --help help for registry\n -p, --port int Port to listen on. (default 5000)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-serve-fileserver",children:[(0,n.jsx)(r.code,{children:"hauler store serve fileserver"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Serve the fileserver"}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve fileserver [flags]\n\nFlags:\n --directory string Directory to use for backend. Defaults to $PWD/store-files (default "store-files")\n -h, --help help for fileserver\n -p, --port int Port to listen on. (default 8080)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-sync",children:[(0,n.jsx)(r.code,{children:"hauler store sync"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Sync content to the embedded content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store sync [flags]\n\nFlags:\n -f, --files strings Path to content files\n -h, --help help for sync\n -k, --key string (Optional) Path to the key for signature verification\n -p, --platform string (Optional) Specific platform to save. i.e. linux/amd64. Defaults to all if flag is omitted.\n --products strings Used for RGS Carbide customers to supply a product and version and Hauler will retrieve the images. i.e. \'--product rancher=v2.7.6\'\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")h\n'})})]})}function h(e={}){const{wrapper:r}={...(0,a.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>s,x:()=>l});var n=t(6540);const a={},o=n.createContext(a);function s(e){const r=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function l(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),n.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f674df19.cf4a2f11.js b/assets/js/f674df19.cf4a2f11.js deleted file mode 100644 index 475ed0d8f..000000000 --- a/assets/js/f674df19.cf4a2f11.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5058],{6453:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>i,contentTitle:()=>s,default:()=>h,frontMatter:()=>o,metadata:()=>l,toc:()=>c});var n=t(4848),a=t(8453);const o={title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},s=void 0,l={id:"guides-references/command-line/hauler-store",title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",source:"@site/versioned_docs/version-0.4.4/guides-references/command-line/hauler-store.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-store",permalink:"/hauler-docs/docs/0.4.4/guides-references/command-line/hauler-store",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.4/guides-references/command-line/hauler-store.md",tags:[],version:"0.4.4",frontMatter:{title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},sidebar:"haulerSidebar",previous:{title:"Hauler",permalink:"/hauler-docs/docs/0.4.4/guides-references/command-line/hauler"},next:{title:"Hauler Completion",permalink:"/hauler-docs/docs/0.4.4/guides-references/command-line/hauler-completion"}},i={},c=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler store add:",id:"hauler-store-add",level:4},{value:"hauler store add chart:",id:"hauler-store-add-chart",level:4},{value:"hauler store add file:",id:"hauler-store-add-file",level:4},{value:"hauler store add image:",id:"hauler-store-add-image",level:4},{value:"hauler store copy:",id:"hauler-store-copy",level:4},{value:"hauler store extract:",id:"hauler-store-extract",level:4},{value:"hauler store info:",id:"hauler-store-info",level:4},{value:"hauler store load:",id:"hauler-store-load",level:4},{value:"hauler store save:",id:"hauler-store-save",level:4},{value:"hauler store serve:",id:"hauler-store-serve",level:4},{value:"hauler store serve registry:",id:"hauler-store-serve-registry",level:4},{value:"hauler store serve fileserver:",id:"hauler-store-serve-fileserver",level:4},{value:"hauler store sync:",id:"hauler-store-sync",level:4}];function d(e){const r={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Interact with Hauler's embedded content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store [flags]\n hauler store [command]\n\nAliases:\n store, s\n\nAvailable Commands:\n add Add content to store\n copy Copy all store contents to another OCI registry\n extract Extract content from the store to disk\n info Print out information about the store\n load Load a content store from a store archive\n save Save a content store to a store archive\n serve Expose the content of a local store through an OCI compliant server\n sync Sync content to the embedded content store\n\nFlags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -h, --help help for store\n -s, --store string Location to create store at (default "store")\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler store [command] --help" for more information about a command.\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-add",children:[(0,n.jsx)(r.code,{children:"hauler store add"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Add content to store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add [flags]\n hauler store add [command]\n\nAvailable Commands:\n chart Add a local or remote chart to the content store\n file Add a file to the content store\n image Add an image to the content store\n\nFlags:\n -h, --help help for add\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n\nUse "hauler store add [command] --help" for more information about a command.\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-add-chart",children:[(0,n.jsx)(r.code,{children:"hauler store add chart"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Add a local or remote chart to the content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add chart [flags]\n\nExamples:\n\n# add a local chart\nhauler store add chart path/to/chart/directory\n\n# add a local compressed chart\nhauler store add chart path/to/chart.tar.gz\n\n# add a remote chart\nhauler store add chart longhorn --repo "https://charts.longhorn.io"\n\n# add a specific version of a chart\nhauler store add chart rancher --repo "https://releases.rancher.com/server-charts/latest" --version "2.6.2"\n\n\nFlags:\n --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle\n --cert-file string identify HTTPS client using this SSL certificate file\n -h, --help help for chart\n --insecure-skip-tls-verify skip tls certificate checks for the chart download\n --key-file string identify HTTPS client using this SSL key file\n --password string chart repository password where to locate the requested chart\n --repo string chart repository url where to locate the requested chart\n --username string chart repository username where to locate the requested chart\n --verify verify the package before using it\n --version string specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-add-file",children:[(0,n.jsx)(r.code,{children:"hauler store add file"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Add a file to the content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add file [flags]\n\nFlags:\n -h, --help help for file\n -n, --name string (Optional) Name to assign to file in store\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-add-image",children:[(0,n.jsx)(r.code,{children:"hauler store add image"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Add an image to the content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add image [flags]\n\nFlags:\n -h, --help help for image\n -k, --key string (Optional) Path to the key for digital signature verification\n -p, --platform string (Optional) Specific platform to save. i.e. linux/amd64. Defaults to all if flag is omitted.\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-copy",children:[(0,n.jsx)(r.code,{children:"hauler store copy"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Copy all store contents to another OCI registry."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store copy [flags]\n\nFlags:\n -h, --help help for copy\n --insecure Toggle allowing insecure connections when copying to a remote registry\n -p, --password string Password when copying to an authenticated remote registry\n --plain-http Toggle allowing plain http connections when copying to a remote registry\n -u, --username string Username when copying to an authenticated remote registry\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")h\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-extract",children:[(0,n.jsx)(r.code,{children:"hauler store extract"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Extract content from the store to disk."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store extract [flags]\n\nAliases:\n extract, x\n\nFlags:\n -h, --help help for extract\n -o, --output string Directory to save contents to (defaults to current directory)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-info",children:[(0,n.jsx)(r.code,{children:"hauler store info"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Print out information about the store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store info [flags]\n\nAliases:\n info, i, list, ls\n\nFlags:\n -h, --help help for info\n -o, --output string Output format (table, json) (default "table")\n -t, --type string Filter on type (image, chart, file) (default "all")\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-load",children:[(0,n.jsx)(r.code,{children:"hauler store load"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Load a content store from a store archive."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store load [flags]\n\nFlags:\n -h, --help help for load\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-save",children:[(0,n.jsx)(r.code,{children:"hauler store save"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Save a content store to a store archive."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store save [flags]\n\nFlags:\n -f, --filename string Name of archive (default "pkg.tar.zst")\n -h, --help help for save\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-serve",children:[(0,n.jsx)(r.code,{children:"hauler store serve"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Expose the content of a local store through an OCI compliant server."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve [flags]\n\nAvailable Commands:\n fileserver Serve the file server\n registry Serve the embedded registry\n\nFlags:\n -h, --help help for serve\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-serve-registry",children:[(0,n.jsx)(r.code,{children:"hauler store serve registry"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Serve the embedded registry"}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve registry [flags]\n\nFlags:\n -c, --config string Path to a config file, will override all other configs\n --directory string Directory to use for backend. Defaults to $PWD/registry (default "registry")\n -h, --help help for registry\n -p, --port int Port to listen on. (default 5000)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-serve-fileserver",children:[(0,n.jsx)(r.code,{children:"hauler store serve fileserver"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Serve the fileserver"}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve fileserver [flags]\n\nFlags:\n --directory string Directory to use for backend. Defaults to $PWD/store-files (default "store-files")\n -h, --help help for fileserver\n -p, --port int Port to listen on. (default 8080)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-sync",children:[(0,n.jsx)(r.code,{children:"hauler store sync"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Sync content to the embedded content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store sync [flags]\n\nFlags:\n -f, --files strings Path to content files\n -h, --help help for sync\n -k, --key string (Optional) Path to the key for signature verification\n -p, --platform string (Optional) Specific platform to save. i.e. linux/amd64. Defaults to all if flag is omitted.\n --products strings Used for RGS Carbide customers to supply a product and version and Hauler will retrieve the images. i.e. \'--product rancher=v2.7.6\'\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")h\n'})})]})}function h(e={}){const{wrapper:r}={...(0,a.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>s,x:()=>l});var n=t(6540);const a={},o=n.createContext(a);function s(e){const r=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function l(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),n.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f7b007a5.69fb52af.js b/assets/js/f7b007a5.69fb52af.js deleted file mode 100644 index b229bef70..000000000 --- a/assets/js/f7b007a5.69fb52af.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5849],{3959:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>l,contentTitle:()=>s,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>c});var i=a(4848),r=a(8453);const t={title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},s=void 0,o={id:"airgap-workflow",title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",source:"@site/versioned_docs/version-1.0.x/airgap-workflow.md",sourceDirName:".",slug:"/airgap-workflow",permalink:"/hauler-docs/docs/airgap-workflow",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.x/airgap-workflow.md",tags:[],version:"1.0.x",frontMatter:{title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},sidebar:"haulerSidebar",previous:{title:"Core Concepts",permalink:"/hauler-docs/docs/core-concepts"},next:{title:"Quickstart",permalink:"/hauler-docs/docs/introduction/quickstart"}},l={},c=[{value:"Workflow Diagram",id:"workflow-diagram",level:2},{value:"What's an Airgap?",id:"whats-an-airgap",level:2},{value:"Example Use Cases",id:"example-use-cases",level:3},{value:"Challenges of an Airgap",id:"challenges-of-an-airgap",level:2}];function d(e){const n={h2:"h2",h3:"h3",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"workflow-diagram",children:"Workflow Diagram"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"hauler-workflow-diagram",src:a(8010).A+"",width:"2883",height:"1013"})}),"\n",(0,i.jsx)(n.h2,{id:"whats-an-airgap",children:"What's an Airgap?"}),"\n",(0,i.jsx)(n.p,{children:"An airgap is a highly secure environment that is physically isolated from external connectivity (usually the internet), ensuring complete isolation from other environments by preventing unauthorized access or data transfers."}),"\n",(0,i.jsx)(n.h3,{id:"example-use-cases",children:"Example Use Cases"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Government and Military:"})," These airgaps protect sensitive government and military information and critical defense infrastructure, ensuring that classified data remains secure and inaccessible to unauthorized entities."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Critical Infrastructure:"})," These airgaps secure power grids, water supply systems, and transportation networks from cyber threats, shielding them from potential disruptions and ensuring their continuous operation."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Financial Institutions:"})," These airgaps safeguard financial transactions and customer data from cyberattacks, maintaining the trust and integrity of financial systems."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Research Facilities:"})," These airgaps protect valuable research data, intellectual property, and proprietary information, preserving the integrity and confidentiality of research efforts."]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"challenges-of-an-airgap",children:"Challenges of an Airgap"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Data Transfers:"})," Transferring data in and out of an airgapped system is complex due to the lack of network connectivity, often necessitating the use of physical media, trusted intermediaries, and meticulous approval processes to ensure data security."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Usability vs. Security Balance:"})," Balancing security with usability in airgapped environments can be intricate, as the limited convenience poses challenges for user interactions and system operations."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Maintenance Complexity:"})," Regular system updates, package and dependency updates, and overall maintenance can be challenging in airgapped systems, as the limited network connectivity complicates the process, requiring meticulous planning and execution."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Costly Implementation:"})," Implementing and maintaining airgapped systems can be costly, demanding specialized workflows, protocols, and security measures to uphold the system's integrity and security."]}),"\n"]})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},8010:(e,n,a)=>{a.d(n,{A:()=>i});const i=a.p+"assets/images/hauler-workflow-diagram-a0761cc99fb86b21c4ca1a7d8a31dfc4.png"},8453:(e,n,a)=>{a.d(n,{R:()=>s,x:()=>o});var i=a(6540);const r={},t=i.createContext(r);function s(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f7b007a5.e3f7409e.js b/assets/js/f7b007a5.e3f7409e.js new file mode 100644 index 000000000..b368a0b5e --- /dev/null +++ b/assets/js/f7b007a5.e3f7409e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5849],{3959:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>s,default:()=>p,frontMatter:()=>t,metadata:()=>o,toc:()=>c});var a=i(4848),r=i(8453);const t={title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},s=void 0,o={id:"airgap-workflow",title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",source:"@site/versioned_docs/version-1.0.x/airgap-workflow.md",sourceDirName:".",slug:"/airgap-workflow",permalink:"/docs/airgap-workflow",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.x/airgap-workflow.md",tags:[],version:"1.0.x",frontMatter:{title:"Airgap Workflow",description:"Airgap Workflow Documentation for Hauler",sidebar_label:"Airgap Workflow"},sidebar:"haulerSidebar",previous:{title:"Core Concepts",permalink:"/docs/core-concepts"},next:{title:"Quickstart",permalink:"/docs/introduction/quickstart"}},l={},c=[{value:"Workflow Diagram",id:"workflow-diagram",level:2},{value:"What's an Airgap?",id:"whats-an-airgap",level:2},{value:"Example Use Cases",id:"example-use-cases",level:3},{value:"Challenges of an Airgap",id:"challenges-of-an-airgap",level:2}];function d(e){const n={h2:"h2",h3:"h3",img:"img",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h2,{id:"workflow-diagram",children:"Workflow Diagram"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.img,{alt:"hauler-workflow-diagram",src:i(8010).A+"",width:"2883",height:"1013"})}),"\n",(0,a.jsx)(n.h2,{id:"whats-an-airgap",children:"What's an Airgap?"}),"\n",(0,a.jsx)(n.p,{children:"An airgap is a highly secure environment that is physically isolated from external connectivity (usually the internet), ensuring complete isolation from other environments by preventing unauthorized access or data transfers."}),"\n",(0,a.jsx)(n.h3,{id:"example-use-cases",children:"Example Use Cases"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"Government and Military:"})," These airgaps protect sensitive government and military information and critical defense infrastructure, ensuring that classified data remains secure and inaccessible to unauthorized entities."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"Critical Infrastructure:"})," These airgaps secure power grids, water supply systems, and transportation networks from cyber threats, shielding them from potential disruptions and ensuring their continuous operation."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"Financial Institutions:"})," These airgaps safeguard financial transactions and customer data from cyberattacks, maintaining the trust and integrity of financial systems."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"Research Facilities:"})," These airgaps protect valuable research data, intellectual property, and proprietary information, preserving the integrity and confidentiality of research efforts."]}),"\n"]}),"\n",(0,a.jsx)(n.h2,{id:"challenges-of-an-airgap",children:"Challenges of an Airgap"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"Data Transfers:"})," Transferring data in and out of an airgapped system is complex due to the lack of network connectivity, often necessitating the use of physical media, trusted intermediaries, and meticulous approval processes to ensure data security."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"Usability vs. Security Balance:"})," Balancing security with usability in airgapped environments can be intricate, as the limited convenience poses challenges for user interactions and system operations."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"Maintenance Complexity:"})," Regular system updates, package and dependency updates, and overall maintenance can be challenging in airgapped systems, as the limited network connectivity complicates the process, requiring meticulous planning and execution."]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.strong,{children:"Costly Implementation:"})," Implementing and maintaining airgapped systems can be costly, demanding specialized workflows, protocols, and security measures to uphold the system's integrity and security."]}),"\n"]})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},8010:(e,n,i)=>{i.d(n,{A:()=>a});const a=i.p+"assets/images/hauler-workflow-diagram-a0761cc99fb86b21c4ca1a7d8a31dfc4.png"},8453:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>o});var a=i(6540);const r={},t=a.createContext(r);function s(e){const n=a.useContext(t);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),a.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f7f847a4.3539ccef.js b/assets/js/f7f847a4.3539ccef.js deleted file mode 100644 index a96bf6557..000000000 --- a/assets/js/f7f847a4.3539ccef.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7976],{2987:(e,r,o)=>{o.r(r),o.d(r,{assets:()=>l,contentTitle:()=>t,default:()=>u,frontMatter:()=>s,metadata:()=>i,toc:()=>c});var a=o(4848),n=o(8453);const s={title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",sidebar_label:"RGS Carbide Customers"},t=void 0,i={id:"guides-references/carbide-customers",title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",source:"@site/versioned_docs/version-0.4.4/guides-references/carbide-customers.md",sourceDirName:"guides-references",slug:"/guides-references/carbide-customers",permalink:"/hauler-docs/docs/0.4.4/guides-references/carbide-customers",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.4/guides-references/carbide-customers.md",tags:[],version:"0.4.4",frontMatter:{title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",sidebar_label:"RGS Carbide Customers"},sidebar:"haulerSidebar",previous:{title:"Fetch Cluster Images",permalink:"/hauler-docs/docs/0.4.4/guides-references/cluster-images"},next:{title:"Overview",permalink:"/hauler-docs/docs/0.4.4/guides-references/hauler-collections/overview"}},l={},c=[{value:"Example Workflow for Carbide",id:"example-workflow-for-carbide",level:3},{value:"Example Workflow for RKE2",id:"example-workflow-for-rke2",level:3},{value:"Example Workflow for K3S",id:"example-workflow-for-k3s",level:3},{value:"Example Workflow for Rancher",id:"example-workflow-for-rancher",level:3},{value:"Example Workflow for Cert-Manager",id:"example-workflow-for-cert-manager",level:3},{value:"Example Workflow for Longhorn",id:"example-workflow-for-longhorn",level:3},{value:"Example Workflow for NeuVector",id:"example-workflow-for-neuvector",level:3}];function d(e){const r={a:"a",code:"code",h3:"h3",p:"p",pre:"pre",...(0,n.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsxs)(r.p,{children:["For all supported customers of Rancher Government Solutions, under the umbrella of Rancher Government Carbide, there is addon functionality within ",(0,a.jsx)(r.code,{children:"Hauler"}),"."]}),"\n",(0,a.jsxs)(r.p,{children:[(0,a.jsx)(r.code,{children:"Hauler"})," has the the ability to reference pre-defined ",(0,a.jsx)(r.code,{children:"Hauler"})," manifests from the Carbide Secured Registry (CSR). ",(0,a.jsx)(r.code,{children:"Hauler"})," is built to allow users to fetch, store, package, and distribute content and collections, but most users may be unsure of what to fetch, store, package, and distribue and that is where our supported customers are able to leverage these pre-defined manifests for all of the Rancher products. Below are some of the available ",(0,a.jsx)(r.code,{children:"product"})," flags."]}),"\n",(0,a.jsxs)(r.p,{children:["RGS Carbide Setup Documentation: ",(0,a.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/intro",children:"https://rancherfederal.github.io/carbide-docs/docs/intro"})]}),"\n",(0,a.jsxs)(r.p,{children:["RGS Carbide Public Key: ",(0,a.jsx)(r.a,{href:"https://raw.githubusercontent.com/rancherfederal/carbide-releases/main/carbide-key.pub",children:"https://raw.githubusercontent.com/rancherfederal/carbide-releases/main/carbide-key.pub"})]}),"\n",(0,a.jsx)(r.h3,{id:"example-workflow-for-carbide",children:"Example Workflow for Carbide"}),"\n",(0,a.jsxs)(r.p,{children:["Please see the ",(0,a.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/registry-docs/downloading-images",children:"Carbide Documentation"})," for easily fetching and packing Carbide. We are actively working to improve this workflow."]}),"\n",(0,a.jsx)(r.h3,{id:"example-workflow-for-rke2",children:"Example Workflow for RKE2"}),"\n",(0,a.jsx)(r.pre,{children:(0,a.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products rke2=v1.26.13+rke2r1 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products rke2=v1.26.13+rke2r1 --platform linux/amd64\n"})}),"\n",(0,a.jsx)(r.h3,{id:"example-workflow-for-k3s",children:"Example Workflow for K3S"}),"\n",(0,a.jsx)(r.pre,{children:(0,a.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products k3s=v1.26.13-k3s2 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products k3s=v1.26.13-k3s2 --platform linux/amd64\n"})}),"\n",(0,a.jsx)(r.h3,{id:"example-workflow-for-rancher",children:"Example Workflow for Rancher"}),"\n",(0,a.jsx)(r.pre,{children:(0,a.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products rancher=v2.8.2 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products rancher=v2.8.2 --platform linux/amd64\n"})}),"\n",(0,a.jsx)(r.h3,{id:"example-workflow-for-cert-manager",children:"Example Workflow for Cert-Manager"}),"\n",(0,a.jsx)(r.pre,{children:(0,a.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products cert-manager=v1.14.2 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products cert-manager=v1.14.2 --platform linux/amd64\n"})}),"\n",(0,a.jsx)(r.h3,{id:"example-workflow-for-longhorn",children:"Example Workflow for Longhorn"}),"\n",(0,a.jsx)(r.pre,{children:(0,a.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products longhorn=v1.6.0 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products longhorn=v1.6.0 --platform linux/amd64\n"})}),"\n",(0,a.jsx)(r.h3,{id:"example-workflow-for-neuvector",children:"Example Workflow for NeuVector"}),"\n",(0,a.jsx)(r.pre,{children:(0,a.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products neuvector=v2.7.3 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products neuvector=v2.7.3 --platform linux/amd64\n"})})]})}function u(e={}){const{wrapper:r}={...(0,n.R)(),...e.components};return r?(0,a.jsx)(r,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},8453:(e,r,o)=>{o.d(r,{R:()=>t,x:()=>i});var a=o(6540);const n={},s=a.createContext(n);function t(e){const r=a.useContext(s);return a.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:t(e.components),a.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f7f847a4.7223c0cf.js b/assets/js/f7f847a4.7223c0cf.js new file mode 100644 index 000000000..58ccac450 --- /dev/null +++ b/assets/js/f7f847a4.7223c0cf.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[7976],{2987:(e,r,o)=>{o.r(r),o.d(r,{assets:()=>l,contentTitle:()=>s,default:()=>u,frontMatter:()=>t,metadata:()=>i,toc:()=>c});var n=o(4848),a=o(8453);const t={title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",sidebar_label:"RGS Carbide Customers"},s=void 0,i={id:"guides-references/carbide-customers",title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",source:"@site/versioned_docs/version-0.4.4/guides-references/carbide-customers.md",sourceDirName:"guides-references",slug:"/guides-references/carbide-customers",permalink:"/docs/0.4.4/guides-references/carbide-customers",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.4/guides-references/carbide-customers.md",tags:[],version:"0.4.4",frontMatter:{title:"RGS Carbide Customers",description:"RGS Carbide Customers Documentation",sidebar_label:"RGS Carbide Customers"},sidebar:"haulerSidebar",previous:{title:"Fetch Cluster Images",permalink:"/docs/0.4.4/guides-references/cluster-images"},next:{title:"Overview",permalink:"/docs/0.4.4/guides-references/hauler-collections/overview"}},l={},c=[{value:"Example Workflow for Carbide",id:"example-workflow-for-carbide",level:3},{value:"Example Workflow for RKE2",id:"example-workflow-for-rke2",level:3},{value:"Example Workflow for K3S",id:"example-workflow-for-k3s",level:3},{value:"Example Workflow for Rancher",id:"example-workflow-for-rancher",level:3},{value:"Example Workflow for Cert-Manager",id:"example-workflow-for-cert-manager",level:3},{value:"Example Workflow for Longhorn",id:"example-workflow-for-longhorn",level:3},{value:"Example Workflow for NeuVector",id:"example-workflow-for-neuvector",level:3}];function d(e){const r={a:"a",code:"code",h3:"h3",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(r.p,{children:["For all supported customers of Rancher Government Solutions, under the umbrella of Rancher Government Carbide, there is addon functionality within ",(0,n.jsx)(r.code,{children:"Hauler"}),"."]}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"Hauler"})," has the the ability to reference pre-defined ",(0,n.jsx)(r.code,{children:"Hauler"})," manifests from the Carbide Secured Registry (CSR). ",(0,n.jsx)(r.code,{children:"Hauler"})," is built to allow users to fetch, store, package, and distribute content and collections, but most users may be unsure of what to fetch, store, package, and distribue and that is where our supported customers are able to leverage these pre-defined manifests for all of the Rancher products. Below are some of the available ",(0,n.jsx)(r.code,{children:"product"})," flags."]}),"\n",(0,n.jsxs)(r.p,{children:["RGS Carbide Setup Documentation: ",(0,n.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/intro",children:"https://rancherfederal.github.io/carbide-docs/docs/intro"})]}),"\n",(0,n.jsxs)(r.p,{children:["RGS Carbide Public Key: ",(0,n.jsx)(r.a,{href:"https://raw.githubusercontent.com/rancherfederal/carbide-releases/main/carbide-key.pub",children:"https://raw.githubusercontent.com/rancherfederal/carbide-releases/main/carbide-key.pub"})]}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-carbide",children:"Example Workflow for Carbide"}),"\n",(0,n.jsxs)(r.p,{children:["Please see the ",(0,n.jsx)(r.a,{href:"https://rancherfederal.github.io/carbide-docs/docs/registry-docs/downloading-images",children:"Carbide Documentation"})," for easily fetching and packing Carbide. We are actively working to improve this workflow."]}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-rke2",children:"Example Workflow for RKE2"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products rke2=v1.26.13+rke2r1 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products rke2=v1.26.13+rke2r1 --platform linux/amd64\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-k3s",children:"Example Workflow for K3S"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products k3s=v1.26.13-k3s2 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products k3s=v1.26.13-k3s2 --platform linux/amd64\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-rancher",children:"Example Workflow for Rancher"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products rancher=v2.8.2 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products rancher=v2.8.2 --platform linux/amd64\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-cert-manager",children:"Example Workflow for Cert-Manager"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products cert-manager=v1.14.2 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products cert-manager=v1.14.2 --platform linux/amd64\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-longhorn",children:"Example Workflow for Longhorn"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products longhorn=v1.6.0 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products longhorn=v1.6.0 --platform linux/amd64\n"})}),"\n",(0,n.jsx)(r.h3,{id:"example-workflow-for-neuvector",children:"Example Workflow for NeuVector"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-bash",children:"# with signature verification\nhauler store sync --products neuvector=v2.7.3 --key carbide-key.pub --platform linux/amd64\n\n# without signature verification\nhauler store sync --products neuvector=v2.7.3 --platform linux/amd64\n"})})]})}function u(e={}){const{wrapper:r}={...(0,a.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,r,o)=>{o.d(r,{R:()=>s,x:()=>i});var n=o(6540);const a={},t=n.createContext(a);function s(e){const r=n.useContext(t);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function i(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),n.createElement(t.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fcac5ca8.188c967e.js b/assets/js/fcac5ca8.188c967e.js new file mode 100644 index 000000000..127cd51fc --- /dev/null +++ b/assets/js/fcac5ca8.188c967e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9425],{2442:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>i,contentTitle:()=>s,default:()=>h,frontMatter:()=>o,metadata:()=>l,toc:()=>c});var n=t(4848),a=t(8453);const o={title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},s=void 0,l={id:"guides-references/command-line/hauler-store",title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",source:"@site/versioned_docs/version-1.0.0/guides-references/command-line/hauler-store.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-store",permalink:"/docs/1.0.0/guides-references/command-line/hauler-store",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-1.0.0/guides-references/command-line/hauler-store.md",tags:[],version:"1.0.0",frontMatter:{title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},sidebar:"haulerSidebar",previous:{title:"Hauler",permalink:"/docs/1.0.0/guides-references/command-line/hauler"},next:{title:"Hauler Completion",permalink:"/docs/1.0.0/guides-references/command-line/hauler-completion"}},i={},c=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler store add:",id:"hauler-store-add",level:4},{value:"hauler store add image:",id:"hauler-store-add-image",level:4},{value:"hauler store add chart:",id:"hauler-store-add-chart",level:4},{value:"hauler store add file:",id:"hauler-store-add-file",level:4},{value:"hauler store copy:",id:"hauler-store-copy",level:4},{value:"hauler store extract:",id:"hauler-store-extract",level:4},{value:"hauler store info:",id:"hauler-store-info",level:4},{value:"hauler store load:",id:"hauler-store-load",level:4},{value:"hauler store save:",id:"hauler-store-save",level:4},{value:"hauler store sync:",id:"hauler-store-sync",level:4},{value:"hauler store serve:",id:"hauler-store-serve",level:4},{value:"hauler store serve registry:",id:"hauler-store-serve-registry",level:4},{value:"hauler store serve fileserver:",id:"hauler-store-serve-fileserver",level:4}];function d(e){const r={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Interact with Hauler's embedded content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Interact with hauler\'s embedded content store\n\nUsage:\n hauler store [flags]\n hauler store [command]\n\nAliases:\n store, s\n\nAvailable Commands:\n add Add content to store\n copy Copy all store contents to another OCI registry\n extract Extract content from the store to disk\n info Print out information about the store\n load Load a content store from a store archive\n save Save a content store to a store archive\n serve Expose the content of a local store through an OCI compliant registry or file server\n sync Sync content to the embedded content store\n\nFlags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -h, --help help for store\n -s, --store string Location to create store at (default "store")\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler store [command] --help" for more information about a command.\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-add",children:[(0,n.jsx)(r.code,{children:"hauler store add"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Add content to store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add [flags]\n hauler store add [command]\n\nAvailable Commands:\n chart Add a local or remote chart to the content store\n file Add a file to the content store\n image Add an image to the content store\n\nFlags:\n -h, --help help for add\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n\nUse "hauler store add [command] --help" for more information about a command.\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-add-image",children:[(0,n.jsx)(r.code,{children:"hauler store add image"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Add an image to the content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add image [flags]\n\nFlags:\n -h, --help help for image\n -k, --key string (Optional) Path to the key for digital signature verification\n -p, --platform string (Optional) Specific platform to save. i.e. linux/amd64. Defaults to all if flag is omitted.\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-add-chart",children:[(0,n.jsx)(r.code,{children:"hauler store add chart"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Add a local or remote chart to the content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add chart [flags]\n\nExamples:\n\n# add a local chart\nhauler store add chart path/to/chart/directory\n\n# add a local compressed chart\nhauler store add chart path/to/chart.tar.gz\n\n# add a remote chart\nhauler store add chart longhorn --repo "https://charts.longhorn.io"\n\n# add a specific version of a chart\nhauler store add chart rancher --repo "https://releases.rancher.com/server-charts/latest" --version "2.6.2"\n\n\nFlags:\n --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle\n --cert-file string identify HTTPS client using this SSL certificate file\n -h, --help help for chart\n --insecure-skip-tls-verify skip tls certificate checks for the chart download\n --key-file string identify HTTPS client using this SSL key file\n --password string chart repository password where to locate the requested chart\n --repo string chart repository url where to locate the requested chart\n --username string chart repository username where to locate the requested chart\n --verify verify the package before using it\n --version string specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-add-file",children:[(0,n.jsx)(r.code,{children:"hauler store add file"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Add a file to the content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add file [flags]\n\nFlags:\n -h, --help help for file\n -n, --name string (Optional) Name to assign to file in store\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-copy",children:[(0,n.jsx)(r.code,{children:"hauler store copy"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Copy all store contents to another OCI registry."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store copy [flags]\n\nFlags:\n -h, --help help for copy\n --insecure Toggle allowing insecure connections when copying to a remote registry\n -p, --password string Password when copying to an authenticated remote registry\n --plain-http Toggle allowing plain http connections when copying to a remote registry\n -u, --username string Username when copying to an authenticated remote registry\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-extract",children:[(0,n.jsx)(r.code,{children:"hauler store extract"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Extract content from the store to disk."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store extract [flags]\n\nAliases:\n extract, x\n\nFlags:\n -h, --help help for extract\n -o, --output string Directory to save contents to (defaults to current directory)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-info",children:[(0,n.jsx)(r.code,{children:"hauler store info"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Print out information about the store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store info [flags]\n\nAliases:\n info, i, list, ls\n\nFlags:\n -h, --help help for info\n -o, --output string Output format (table, json) (default "table")\n -t, --type string Filter on type (image, chart, file, sigs, atts, sbom) (default "all")\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-load",children:[(0,n.jsx)(r.code,{children:"hauler store load"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Load a content store from a store archive."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store load [flags]\n\nFlags:\n -h, --help help for load\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-save",children:[(0,n.jsx)(r.code,{children:"hauler store save"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Save a content store to a store archive."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store save [flags]\n\nFlags:\n -f, --filename string Name of archive (default "haul.tar.zst")\n -h, --help help for save\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-sync",children:[(0,n.jsx)(r.code,{children:"hauler store sync"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Sync content to the embedded content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store sync [flags]\n\nFlags:\n -f, --files strings Path to content files\n -h, --help help for sync\n -k, --key string (Optional) Path to the key for signature verification\n -p, --platform string (Optional) Specific platform to save. i.e. linux/amd64. Defaults to all if flag is omitted.\n --products strings Used for RGS Carbide customers to supply a product and version and Hauler will retrieve the images. i.e. \'--product rancher=v2.7.6\'\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-serve",children:[(0,n.jsx)(r.code,{children:"hauler store serve"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Expose the content of a local store through an OCI compliant registry or file server."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve [flags]\n hauler store serve [command]\n\nAvailable Commands:\n fileserver Serve the file server\n registry Serve the embedded registry\n\nFlags:\n -h, --help help for serve\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n\nUse "hauler store serve [command] --help" for more information about a command.\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-serve-registry",children:[(0,n.jsx)(r.code,{children:"hauler store serve registry"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Serve the embedded registry"}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve registry [flags]\n\nFlags:\n -c, --config string Path to a config file, will override all other configs\n --directory string Directory to use for backend. Defaults to $PWD/registry (default "registry")\n -h, --help help for registry\n -p, --port int Port to listen on. (default 5000)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-serve-fileserver",children:[(0,n.jsx)(r.code,{children:"hauler store serve fileserver"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Serve the fileserver"}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve fileserver [flags]\n\nFlags:\n --directory string Directory to use for backend. Defaults to $PWD/store-files (default "store-files")\n -h, --help help for fileserver\n -p, --port int Port to listen on. (default 8080)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})})]})}function h(e={}){const{wrapper:r}={...(0,a.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>s,x:()=>l});var n=t(6540);const a={},o=n.createContext(a);function s(e){const r=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function l(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),n.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fcac5ca8.2cd3b83f.js b/assets/js/fcac5ca8.2cd3b83f.js deleted file mode 100644 index 5d6ff38fb..000000000 --- a/assets/js/fcac5ca8.2cd3b83f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9425],{2442:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>i,contentTitle:()=>s,default:()=>h,frontMatter:()=>o,metadata:()=>l,toc:()=>c});var n=t(4848),a=t(8453);const o={title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},s=void 0,l={id:"guides-references/command-line/hauler-store",title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",source:"@site/versioned_docs/version-1.0.0/guides-references/command-line/hauler-store.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-store",permalink:"/hauler-docs/docs/1.0.0/guides-references/command-line/hauler-store",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-1.0.0/guides-references/command-line/hauler-store.md",tags:[],version:"1.0.0",frontMatter:{title:"Hauler Store (Command)",description:"Hauler CLI Reference for hauler store",sidebar_label:"Hauler Store"},sidebar:"haulerSidebar",previous:{title:"Hauler",permalink:"/hauler-docs/docs/1.0.0/guides-references/command-line/hauler"},next:{title:"Hauler Completion",permalink:"/hauler-docs/docs/1.0.0/guides-references/command-line/hauler-completion"}},i={},c=[{value:"Command Overview",id:"command-overview",level:3},{value:"hauler store add:",id:"hauler-store-add",level:4},{value:"hauler store add image:",id:"hauler-store-add-image",level:4},{value:"hauler store add chart:",id:"hauler-store-add-chart",level:4},{value:"hauler store add file:",id:"hauler-store-add-file",level:4},{value:"hauler store copy:",id:"hauler-store-copy",level:4},{value:"hauler store extract:",id:"hauler-store-extract",level:4},{value:"hauler store info:",id:"hauler-store-info",level:4},{value:"hauler store load:",id:"hauler-store-load",level:4},{value:"hauler store save:",id:"hauler-store-save",level:4},{value:"hauler store sync:",id:"hauler-store-sync",level:4},{value:"hauler store serve:",id:"hauler-store-serve",level:4},{value:"hauler store serve registry:",id:"hauler-store-serve-registry",level:4},{value:"hauler store serve fileserver:",id:"hauler-store-serve-fileserver",level:4}];function d(e){const r={code:"code",h3:"h3",h4:"h4",li:"li",pre:"pre",ul:"ul",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Interact with Hauler's embedded content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Interact with hauler\'s embedded content store\n\nUsage:\n hauler store [flags]\n hauler store [command]\n\nAliases:\n store, s\n\nAvailable Commands:\n add Add content to store\n copy Copy all store contents to another OCI registry\n extract Extract content from the store to disk\n info Print out information about the store\n load Load a content store from a store archive\n save Save a content store to a store archive\n serve Expose the content of a local store through an OCI compliant registry or file server\n sync Sync content to the embedded content store\n\nFlags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -h, --help help for store\n -s, --store string Location to create store at (default "store")\n\nGlobal Flags:\n -l, --log-level string (default "info")\n\nUse "hauler store [command] --help" for more information about a command.\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-add",children:[(0,n.jsx)(r.code,{children:"hauler store add"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Add content to store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add [flags]\n hauler store add [command]\n\nAvailable Commands:\n chart Add a local or remote chart to the content store\n file Add a file to the content store\n image Add an image to the content store\n\nFlags:\n -h, --help help for add\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n\nUse "hauler store add [command] --help" for more information about a command.\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-add-image",children:[(0,n.jsx)(r.code,{children:"hauler store add image"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Add an image to the content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add image [flags]\n\nFlags:\n -h, --help help for image\n -k, --key string (Optional) Path to the key for digital signature verification\n -p, --platform string (Optional) Specific platform to save. i.e. linux/amd64. Defaults to all if flag is omitted.\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-add-chart",children:[(0,n.jsx)(r.code,{children:"hauler store add chart"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Add a local or remote chart to the content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add chart [flags]\n\nExamples:\n\n# add a local chart\nhauler store add chart path/to/chart/directory\n\n# add a local compressed chart\nhauler store add chart path/to/chart.tar.gz\n\n# add a remote chart\nhauler store add chart longhorn --repo "https://charts.longhorn.io"\n\n# add a specific version of a chart\nhauler store add chart rancher --repo "https://releases.rancher.com/server-charts/latest" --version "2.6.2"\n\n\nFlags:\n --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle\n --cert-file string identify HTTPS client using this SSL certificate file\n -h, --help help for chart\n --insecure-skip-tls-verify skip tls certificate checks for the chart download\n --key-file string identify HTTPS client using this SSL key file\n --password string chart repository password where to locate the requested chart\n --repo string chart repository url where to locate the requested chart\n --username string chart repository username where to locate the requested chart\n --verify verify the package before using it\n --version string specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-add-file",children:[(0,n.jsx)(r.code,{children:"hauler store add file"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Add a file to the content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store add file [flags]\n\nFlags:\n -h, --help help for file\n -n, --name string (Optional) Name to assign to file in store\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-copy",children:[(0,n.jsx)(r.code,{children:"hauler store copy"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Copy all store contents to another OCI registry."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store copy [flags]\n\nFlags:\n -h, --help help for copy\n --insecure Toggle allowing insecure connections when copying to a remote registry\n -p, --password string Password when copying to an authenticated remote registry\n --plain-http Toggle allowing plain http connections when copying to a remote registry\n -u, --username string Username when copying to an authenticated remote registry\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-extract",children:[(0,n.jsx)(r.code,{children:"hauler store extract"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Extract content from the store to disk."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store extract [flags]\n\nAliases:\n extract, x\n\nFlags:\n -h, --help help for extract\n -o, --output string Directory to save contents to (defaults to current directory)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-info",children:[(0,n.jsx)(r.code,{children:"hauler store info"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Print out information about the store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store info [flags]\n\nAliases:\n info, i, list, ls\n\nFlags:\n -h, --help help for info\n -o, --output string Output format (table, json) (default "table")\n -t, --type string Filter on type (image, chart, file, sigs, atts, sbom) (default "all")\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-load",children:[(0,n.jsx)(r.code,{children:"hauler store load"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Load a content store from a store archive."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store load [flags]\n\nFlags:\n -h, --help help for load\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-save",children:[(0,n.jsx)(r.code,{children:"hauler store save"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Save a content store to a store archive."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store save [flags]\n\nFlags:\n -f, --filename string Name of archive (default "haul.tar.zst")\n -h, --help help for save\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-sync",children:[(0,n.jsx)(r.code,{children:"hauler store sync"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Sync content to the embedded content store."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store sync [flags]\n\nFlags:\n -f, --files strings Path to content files\n -h, --help help for sync\n -k, --key string (Optional) Path to the key for signature verification\n -p, --platform string (Optional) Specific platform to save. i.e. linux/amd64. Defaults to all if flag is omitted.\n --products strings Used for RGS Carbide customers to supply a product and version and Hauler will retrieve the images. i.e. \'--product rancher=v2.7.6\'\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-serve",children:[(0,n.jsx)(r.code,{children:"hauler store serve"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Expose the content of a local store through an OCI compliant registry or file server."}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve [flags]\n hauler store serve [command]\n\nAvailable Commands:\n fileserver Serve the file server\n registry Serve the embedded registry\n\nFlags:\n -h, --help help for serve\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n\nUse "hauler store serve [command] --help" for more information about a command.\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-serve-registry",children:[(0,n.jsx)(r.code,{children:"hauler store serve registry"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Serve the embedded registry"}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve registry [flags]\n\nFlags:\n -c, --config string Path to a config file, will override all other configs\n --directory string Directory to use for backend. Defaults to $PWD/registry (default "registry")\n -h, --help help for registry\n -p, --port int Port to listen on. (default 5000)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})}),"\n",(0,n.jsxs)(r.h4,{id:"hauler-store-serve-fileserver",children:[(0,n.jsx)(r.code,{children:"hauler store serve fileserver"}),":"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:"Serve the fileserver"}),"\n"]}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-yaml",children:'Usage:\n hauler store serve fileserver [flags]\n\nFlags:\n --directory string Directory to use for backend. Defaults to $PWD/store-files (default "store-files")\n -h, --help help for fileserver\n -p, --port int Port to listen on. (default 8080)\n\nGlobal Flags:\n --cache string Location of where to store cache data (defaults to $XDG_CACHE_DIR/hauler)\n -l, --log-level string (default "info")\n -s, --store string Location to create store at (default "store")\n'})})]})}function h(e={}){const{wrapper:r}={...(0,a.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},8453:(e,r,t)=>{t.d(r,{R:()=>s,x:()=>l});var n=t(6540);const a={},o=n.createContext(a);function s(e){const r=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function l(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),n.createElement(o.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fd1af507.a4c6f487.js b/assets/js/fd1af507.a4c6f487.js deleted file mode 100644 index c0237e33f..000000000 --- a/assets/js/fd1af507.a4c6f487.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3575],{8641:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var o=t(4848),r=t(8453);const i={title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},c=void 0,s={id:"core-concepts",title:"Core Concepts",description:"Core Concepts Documentation for Hauler",source:"@site/versioned_docs/version-0.4.0/core-concepts.md",sourceDirName:".",slug:"/core-concepts",permalink:"/hauler-docs/docs/0.4.0/core-concepts",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/versioned_docs/version-0.4.0/core-concepts.md",tags:[],version:"0.4.0",frontMatter:{title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},sidebar:"haulerSidebar",previous:{title:"Introduction",permalink:"/hauler-docs/docs/0.4.0/intro"},next:{title:"Airgap Workflow",permalink:"/hauler-docs/docs/0.4.0/airgap-workflow"}},a={},l=[{value:"Haul",id:"haul",level:2},{value:"Collections",id:"collections",level:2},{value:"Community Collections",id:"community-collections",level:3},{value:"RGS Carbide Collections",id:"rgs-carbide-collections",level:3},{value:"Content",id:"content",level:2},{value:"Declarative Content",id:"declarative-content",level:3}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",ul:"ul",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"hauler-diagram",src:t(6178).A+"",width:"1949",height:"988"})}),"\n",(0,o.jsx)(n.h2,{id:"haul",children:"Haul"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauls"})," are Compressed Archive (Tarball) of Hauler Collections and Content."]})}),"\n",(0,o.jsxs)(n.p,{children:["At the heart of Hauler lies the concept of a ",(0,o.jsx)(n.code,{children:"Haul"}),". A ",(0,o.jsx)(n.code,{children:"Haul"})," is a compressed archive, often in the form of a tarball, containing Hauler collections and content. It serves as a container for grouping and transporting various data types, making it a fundamental element in the Hauler ecosystem."]}),"\n",(0,o.jsx)(n.h2,{id:"collections",children:"Collections"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are Grouping of one or more Hauler Contents."]})}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are the building blocks of Hauler. These are groupings of one or more Hauler ",(0,o.jsx)(n.code,{children:"contents"}),". Think of ",(0,o.jsx)(n.code,{children:"collections"})," as organized sets of data that collectively represent something desirable."]}),"\n",(0,o.jsx)(n.h3,{id:"community-collections",children:"Community Collections"}),"\n",(0,o.jsxs)(n.p,{children:["While ",(0,o.jsx)(n.code,{children:"collections"})," (and ",(0,o.jsx)(n.code,{children:"contents"}),") are built into Hauler, our goal is to empower users to define their own ",(0,o.jsx)(n.code,{children:"collections"}),". This way, you can tailor Hauler to your unique requirements and take full control of your artifacts."]}),"\n",(0,o.jsx)(n.h3,{id:"rgs-carbide-collections",children:"RGS Carbide Collections"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauler"})," provides the ability to import ",(0,o.jsx)(n.code,{children:"collections"})," for the Rancher products, making it seamless for RGS Supported Customers to airgap any of the Rancher products or projects. If you haven't heard of Rancher Government Carbide, check it out ",(0,o.jsx)(n.a,{href:"https://ranchergovernment.com/carbide",children:"here"}),"!"]}),"\n",(0,o.jsx)(n.h2,{id:"content",children:"Content"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Contents"})," are Artifacts such as Images, Charts, or Files."]})}),"\n",(0,o.jsxs)(n.p,{children:["In Hauler's terminology, ",(0,o.jsx)(n.code,{children:"content"})," refers to artifacts such as images, charts, or files. These are the fundamental types of resources that Hauler understands and manages. To understand the term better, let's break it down:"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Content"}),": The fundamental type of artifacts that Hauler recognizes (images, charts, and files)."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Artifact"}),": Anything that can be represented as an OCI (Open Container Initiative) artifact.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"OCI Artifacts provide a standardized way to store arbitrary files, making it easier to manage content efficiently."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"declarative-content",children:"Declarative Content"}),"\n",(0,o.jsxs)(n.p,{children:["While manually adding content to ",(0,o.jsx)(n.code,{children:"Hauler"})," is a straightforward way to get started, we recommend a much more sustainable approach. ",(0,o.jsx)(n.code,{children:"Hauler"})," provides a declarative approach for each ",(0,o.jsx)(n.code,{children:"content"})," type, allowing you to define all the ",(0,o.jsx)(n.code,{children:"content"})," within a manifest. This approach ensures a more reproducable workflow for managing the lifecycle of your ",(0,o.jsx)(n.code,{children:"hauls"}),"."]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},6178:(e,n,t)=>{t.d(n,{A:()=>o});const o=t.p+"assets/images/hauler-diagram-53f9182c0d98fe871fb3cf7fe8cd475a.png"},8453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>s});var o=t(6540);const r={},i=o.createContext(r);function c(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fd1af507.b333a75d.js b/assets/js/fd1af507.b333a75d.js new file mode 100644 index 000000000..2cb582bba --- /dev/null +++ b/assets/js/fd1af507.b333a75d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[3575],{8641:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var o=t(4848),r=t(8453);const i={title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},s=void 0,c={id:"core-concepts",title:"Core Concepts",description:"Core Concepts Documentation for Hauler",source:"@site/versioned_docs/version-0.4.0/core-concepts.md",sourceDirName:".",slug:"/core-concepts",permalink:"/docs/0.4.0/core-concepts",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/versioned_docs/version-0.4.0/core-concepts.md",tags:[],version:"0.4.0",frontMatter:{title:"Core Concepts",description:"Core Concepts Documentation for Hauler",sidebar_label:"Core Concepts"},sidebar:"haulerSidebar",previous:{title:"Introduction",permalink:"/docs/0.4.0/intro"},next:{title:"Airgap Workflow",permalink:"/docs/0.4.0/airgap-workflow"}},a={},l=[{value:"Haul",id:"haul",level:2},{value:"Collections",id:"collections",level:2},{value:"Community Collections",id:"community-collections",level:3},{value:"RGS Carbide Collections",id:"rgs-carbide-collections",level:3},{value:"Content",id:"content",level:2},{value:"Declarative Content",id:"declarative-content",level:3}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",p:"p",ul:"ul",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.p,{children:(0,o.jsx)(n.img,{alt:"hauler-diagram",src:t(6178).A+"",width:"1949",height:"988"})}),"\n",(0,o.jsx)(n.h2,{id:"haul",children:"Haul"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauls"})," are Compressed Archive (Tarball) of Hauler Collections and Content."]})}),"\n",(0,o.jsxs)(n.p,{children:["At the heart of Hauler lies the concept of a ",(0,o.jsx)(n.code,{children:"Haul"}),". A ",(0,o.jsx)(n.code,{children:"Haul"})," is a compressed archive, often in the form of a tarball, containing Hauler collections and content. It serves as a container for grouping and transporting various data types, making it a fundamental element in the Hauler ecosystem."]}),"\n",(0,o.jsx)(n.h2,{id:"collections",children:"Collections"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are Grouping of one or more Hauler Contents."]})}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Collections"})," are the building blocks of Hauler. These are groupings of one or more Hauler ",(0,o.jsx)(n.code,{children:"contents"}),". Think of ",(0,o.jsx)(n.code,{children:"collections"})," as organized sets of data that collectively represent something desirable."]}),"\n",(0,o.jsx)(n.h3,{id:"community-collections",children:"Community Collections"}),"\n",(0,o.jsxs)(n.p,{children:["While ",(0,o.jsx)(n.code,{children:"collections"})," (and ",(0,o.jsx)(n.code,{children:"contents"}),") are built into Hauler, our goal is to empower users to define their own ",(0,o.jsx)(n.code,{children:"collections"}),". This way, you can tailor Hauler to your unique requirements and take full control of your artifacts."]}),"\n",(0,o.jsx)(n.h3,{id:"rgs-carbide-collections",children:"RGS Carbide Collections"}),"\n",(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Hauler"})," provides the ability to import ",(0,o.jsx)(n.code,{children:"collections"})," for the Rancher products, making it seamless for RGS Supported Customers to airgap any of the Rancher products or projects. If you haven't heard of Rancher Government Carbide, check it out ",(0,o.jsx)(n.a,{href:"https://ranchergovernment.com/carbide",children:"here"}),"!"]}),"\n",(0,o.jsx)(n.h2,{id:"content",children:"Content"}),"\n",(0,o.jsx)(n.admonition,{title:"SUMMARY:",type:"tip",children:(0,o.jsxs)(n.p,{children:[(0,o.jsx)(n.code,{children:"Contents"})," are Artifacts such as Images, Charts, or Files."]})}),"\n",(0,o.jsxs)(n.p,{children:["In Hauler's terminology, ",(0,o.jsx)(n.code,{children:"content"})," refers to artifacts such as images, charts, or files. These are the fundamental types of resources that Hauler understands and manages. To understand the term better, let's break it down:"]}),"\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Content"}),": The fundamental type of artifacts that Hauler recognizes (images, charts, and files)."]}),"\n",(0,o.jsxs)(n.li,{children:[(0,o.jsx)(n.code,{children:"Artifact"}),": Anything that can be represented as an OCI (Open Container Initiative) artifact.","\n",(0,o.jsxs)(n.ul,{children:["\n",(0,o.jsx)(n.li,{children:"OCI Artifacts provide a standardized way to store arbitrary files, making it easier to manage content efficiently."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,o.jsx)(n.h3,{id:"declarative-content",children:"Declarative Content"}),"\n",(0,o.jsxs)(n.p,{children:["While manually adding content to ",(0,o.jsx)(n.code,{children:"Hauler"})," is a straightforward way to get started, we recommend a much more sustainable approach. ",(0,o.jsx)(n.code,{children:"Hauler"})," provides a declarative approach for each ",(0,o.jsx)(n.code,{children:"content"})," type, allowing you to define all the ",(0,o.jsx)(n.code,{children:"content"})," within a manifest. This approach ensures a more reproducable workflow for managing the lifecycle of your ",(0,o.jsx)(n.code,{children:"hauls"}),"."]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},6178:(e,n,t)=>{t.d(n,{A:()=>o});const o=t.p+"assets/images/hauler-diagram-53f9182c0d98fe871fb3cf7fe8cd475a.png"},8453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>c});var o=t(6540);const r={},i=o.createContext(r);function s(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fe306ed6.29b9cb20.js b/assets/js/fe306ed6.29b9cb20.js new file mode 100644 index 000000000..3f66a7370 --- /dev/null +++ b/assets/js/fe306ed6.29b9cb20.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5180],{1476:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>u,frontMatter:()=>s,metadata:()=>_,toc:()=>l});var i=r(4848),o=r(8453);const s={title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},t=void 0,_={id:"guides-references/command-line/hauler-version",title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",source:"@site/docs/guides-references/command-line/hauler-version.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-version",permalink:"/docs/next/guides-references/command-line/hauler-version",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/docs/guides-references/command-line/hauler-version.md",tags:[],version:"current",frontMatter:{title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},sidebar:"haulerSidebar",previous:{title:"Hauler Completion",permalink:"/docs/next/guides-references/command-line/hauler-completion"},next:{title:"Known Issues/Limits",permalink:"/docs/next/known-limits"}},a={},l=[{value:"Command Overview",id:"command-overview",level:3}];function c(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Print Hauler's current version."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-yaml",children:" __ __ ___ __ __ __ _______ .______\n| | | | / \\ | | | | | | | ____|| _ \\\n| |__| | / ^ \\ | | | | | | | |__ | |_) |\n| __ | / /_\\ \\ | | | | | | | __| | /\n| | | | / _____ \\ | `--' | | `----.| |____ | |\\ \\----.\n|__| |__| /__/ \\__\\ \\______/ |_______||_______|| _| `._____|\n\nhauler: Airgap Swiss Army Knife\n\nGitVersion: 1.0.3\nGitCommit: f7c24f6\nGitTreeState: clean\nBuildDate: 2024-04-24T16:50:33Z\nGoVersion: go1.21.9\nCompiler: gc\nPlatform: darwin/arm64\n"})})]})}function u(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>t,x:()=>_});var i=r(6540);const o={},s=i.createContext(o);function t(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function _(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:t(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/fe306ed6.4805d30c.js b/assets/js/fe306ed6.4805d30c.js deleted file mode 100644 index c55d69869..000000000 --- a/assets/js/fe306ed6.4805d30c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[5180],{1476:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>d,frontMatter:()=>s,metadata:()=>_,toc:()=>l});var i=r(4848),o=r(8453);const s={title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},t=void 0,_={id:"guides-references/command-line/hauler-version",title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",source:"@site/docs/guides-references/command-line/hauler-version.md",sourceDirName:"guides-references/command-line",slug:"/guides-references/command-line/hauler-version",permalink:"/hauler-docs/docs/next/guides-references/command-line/hauler-version",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/docs/guides-references/command-line/hauler-version.md",tags:[],version:"current",frontMatter:{title:"Hauler Version (Command)",description:"Hauler CLI Reference for hauler version",sidebar_label:"Hauler Version"},sidebar:"haulerSidebar",previous:{title:"Hauler Completion",permalink:"/hauler-docs/docs/next/guides-references/command-line/hauler-completion"},next:{title:"Known Issues/Limits",permalink:"/hauler-docs/docs/next/known-limits"}},a={},l=[{value:"Command Overview",id:"command-overview",level:3}];function c(e){const n={code:"code",h3:"h3",li:"li",pre:"pre",ul:"ul",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h3,{id:"command-overview",children:"Command Overview"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Print Hauler's current version."}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-yaml",children:" __ __ ___ __ __ __ _______ .______\n| | | | / \\ | | | | | | | ____|| _ \\\n| |__| | / ^ \\ | | | | | | | |__ | |_) |\n| __ | / /_\\ \\ | | | | | | | __| | /\n| | | | / _____ \\ | `--' | | `----.| |____ | |\\ \\----.\n|__| |__| /__/ \\__\\ \\______/ |_______||_______|| _| `._____|\n\nhauler: Airgap Swiss Army Knife\n\nGitVersion: 1.0.3\nGitCommit: f7c24f6\nGitTreeState: clean\nBuildDate: 2024-04-24T16:50:33Z\nGoVersion: go1.21.9\nCompiler: gc\nPlatform: darwin/arm64\n"})})]})}function d(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>t,x:()=>_});var i=r(6540);const o={},s=i.createContext(o);function t(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function _(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:t(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ffba34cc.33a70c82.js b/assets/js/ffba34cc.33a70c82.js new file mode 100644 index 000000000..7d92e5783 --- /dev/null +++ b/assets/js/ffba34cc.33a70c82.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9163],{6952:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>s,contentTitle:()=>o,default:()=>u,frontMatter:()=>t,metadata:()=>l,toc:()=>c});var r=a(4848),i=a(8453);const t={title:"Hauler Content - Images",description:"Hauler Content - Images Documentation",sidebar_label:"Images"},o=void 0,l={id:"guides-references/hauler-content/images",title:"Hauler Content - Images",description:"Hauler Content - Images Documentation",source:"@site/docs/guides-references/hauler-content/images.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/images",permalink:"/docs/next/guides-references/hauler-content/images",draft:!1,unlisted:!1,editUrl:"https://github.com/hauler-dev/hauler-docs/edit/main/docs/guides-references/hauler-content/images.md",tags:[],version:"current",frontMatter:{title:"Hauler Content - Images",description:"Hauler Content - Images Documentation",sidebar_label:"Images"},sidebar:"haulerSidebar",previous:{title:"Community Collections",permalink:"/docs/next/guides-references/hauler-collections/community-collections"},next:{title:"Charts",permalink:"/docs/next/guides-references/hauler-content/charts"}},s={},c=[{value:"Hauler Command Line for Images",id:"hauler-command-line-for-images",level:2},{value:"Example Commands for Images",id:"example-commands-for-images",level:2},{value:"Hauler Manifest for Images",id:"hauler-manifest-for-images",level:2},{value:"Example Manifest for Images",id:"example-manifest-for-images",level:2}];function m(e){const n={code:"code",h2:"h2",pre:"pre",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"hauler-command-line-for-images",children:"Hauler Command Line for Images"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"hauler store add image --platform --key \n"})}),"\n",(0,r.jsx)(n.h2,{id:"example-commands-for-images",children:"Example Commands for Images"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"# fetch image\nhauler store add image neuvector/scanner\n\n# fetch image with full image reference\nhauler store add image name: docker.io/neuvector/updater:latest\n\n# fetch image with full image reference with digest\nhauler store add image docker.io/neuvector/updater@sha256:0076b356368c9988eec5f3cead771d29a377074b982f22800f4d9c8c3b215a56\n\n# fetch image with full image reference, specific version, specific platform\nhauler store add image docker.io/longhornio/longhorn-ui:v1.6.0 --platform: linux/amd64\n\n# fetch image with full image reference, specific version, specific platform, and signature verification\nhauler store add image docker.io/longhornio/longhorn-manager:v1.6.0 --platform linux/amd64 --key cosign-public-key.pub\n"})}),"\n",(0,r.jsx)(n.h2,{id:"hauler-manifest-for-images",children:"Hauler Manifest for Images"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-image-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\n annotations:\n # global flags for all images in the manifest\n # image flags override global flags\n hauler.dev/key: \n hauler.dev/platform: \n hauler.dev/registry: \nspec:\n images:\n - name: \n key: \n platform: \n"})}),"\n",(0,r.jsx)(n.h2,{id:"example-manifest-for-images",children:"Example Manifest for Images"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-image-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\n annotations:\n # global flags for all images in the manifest\n # image flags override global flags\n hauler.dev/key: \n hauler.dev/platform: \n hauler.dev/registry: \nspec:\n images:\n # fetch image\n - name: neuvector/scanner\n # fetch image with full image reference\n - name: docker.io/neuvector/updater:latest\n # fetch image with full image reference with digest\n - name: docker.io/neuvector/updater@sha256:0076b356368c9988eec5f3cead771d29a377074b982f22800f4d9c8c3b215a56\n # fetch image with full image reference, specific version, specific platform\n - name: docker.io/longhornio/longhorn-ui:v1.6.0\n platform: linux/amd64\n # fetch image with full image reference, specific version, specific platform, and signature verification\n - name: docker.io/longhornio/longhorn-manager:v1.6.0\n key: cosign-public-key.pub\n platform: linux/amd64\n"})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(m,{...e})}):m(e)}},8453:(e,n,a)=>{a.d(n,{R:()=>o,x:()=>l});var r=a(6540);const i={},t=r.createContext(i);function o(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ffba34cc.e446c161.js b/assets/js/ffba34cc.e446c161.js deleted file mode 100644 index 23ed61d72..000000000 --- a/assets/js/ffba34cc.e446c161.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[9163],{6952:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>s,contentTitle:()=>o,default:()=>u,frontMatter:()=>t,metadata:()=>l,toc:()=>c});var r=a(4848),i=a(8453);const t={title:"Hauler Content - Images",description:"Hauler Content - Images Documentation",sidebar_label:"Images"},o=void 0,l={id:"guides-references/hauler-content/images",title:"Hauler Content - Images",description:"Hauler Content - Images Documentation",source:"@site/docs/guides-references/hauler-content/images.md",sourceDirName:"guides-references/hauler-content",slug:"/guides-references/hauler-content/images",permalink:"/hauler-docs/docs/next/guides-references/hauler-content/images",draft:!1,unlisted:!1,editUrl:"https://github.com/rancherfederal/hauler-docs/edit/main/docs/guides-references/hauler-content/images.md",tags:[],version:"current",frontMatter:{title:"Hauler Content - Images",description:"Hauler Content - Images Documentation",sidebar_label:"Images"},sidebar:"haulerSidebar",previous:{title:"Community Collections",permalink:"/hauler-docs/docs/next/guides-references/hauler-collections/community-collections"},next:{title:"Charts",permalink:"/hauler-docs/docs/next/guides-references/hauler-content/charts"}},s={},c=[{value:"Hauler Command Line for Images",id:"hauler-command-line-for-images",level:2},{value:"Example Commands for Images",id:"example-commands-for-images",level:2},{value:"Hauler Manifest for Images",id:"hauler-manifest-for-images",level:2},{value:"Example Manifest for Images",id:"example-manifest-for-images",level:2}];function m(e){const n={code:"code",h2:"h2",pre:"pre",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"hauler-command-line-for-images",children:"Hauler Command Line for Images"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"hauler store add image --platform --key \n"})}),"\n",(0,r.jsx)(n.h2,{id:"example-commands-for-images",children:"Example Commands for Images"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"# fetch image\nhauler store add image neuvector/scanner\n\n# fetch image with full image reference\nhauler store add image name: docker.io/neuvector/updater:latest\n\n# fetch image with full image reference with digest\nhauler store add image docker.io/neuvector/updater@sha256:0076b356368c9988eec5f3cead771d29a377074b982f22800f4d9c8c3b215a56\n\n# fetch image with full image reference, specific version, specific platform\nhauler store add image docker.io/longhornio/longhorn-ui:v1.6.0 --platform: linux/amd64\n\n# fetch image with full image reference, specific version, specific platform, and signature verification\nhauler store add image docker.io/longhornio/longhorn-manager:v1.6.0 --platform linux/amd64 --key cosign-public-key.pub\n"})}),"\n",(0,r.jsx)(n.h2,{id:"hauler-manifest-for-images",children:"Hauler Manifest for Images"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-image-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\n annotations:\n # global flags for all images in the manifest\n # image flags override global flags\n hauler.dev/key: \n hauler.dev/platform: \n hauler.dev/registry: \nspec:\n images:\n - name: \n key: \n platform: \n"})}),"\n",(0,r.jsx)(n.h2,{id:"example-manifest-for-images",children:"Example Manifest for Images"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",metastring:'title="hauler-image-manifest.yaml"',children:"apiVersion: content.hauler.cattle.io/v1alpha1\nkind: Images\nmetadata:\n name: hauler-content-images-example\n annotations:\n # global flags for all images in the manifest\n # image flags override global flags\n hauler.dev/key: \n hauler.dev/platform: \n hauler.dev/registry: \nspec:\n images:\n # fetch image\n - name: neuvector/scanner\n # fetch image with full image reference\n - name: docker.io/neuvector/updater:latest\n # fetch image with full image reference with digest\n - name: docker.io/neuvector/updater@sha256:0076b356368c9988eec5f3cead771d29a377074b982f22800f4d9c8c3b215a56\n # fetch image with full image reference, specific version, specific platform\n - name: docker.io/longhornio/longhorn-ui:v1.6.0\n platform: linux/amd64\n # fetch image with full image reference, specific version, specific platform, and signature verification\n - name: docker.io/longhornio/longhorn-manager:v1.6.0\n key: cosign-public-key.pub\n platform: linux/amd64\n"})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(m,{...e})}):m(e)}},8453:(e,n,a)=>{a.d(n,{R:()=>o,x:()=>l});var r=a(6540);const i={},t=r.createContext(i);function o(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/main.32bf4b49.js b/assets/js/main.32bf4b49.js deleted file mode 100644 index 13651151c..000000000 --- a/assets/js/main.32bf4b49.js +++ /dev/null @@ -1,2 +0,0 @@ -/*! For license information please see main.32bf4b49.js.LICENSE.txt */ -(self.webpackChunkhauler_docs=self.webpackChunkhauler_docs||[]).push([[6411],{8328:(e,t,n)=>{"use strict";n.d(t,{A:()=>f});n(6540);var r=n(3259),o=n.n(r),a=n(4054);const i={"0039f7b2":[()=>n.e(3750).then(n.bind(n,1525)),"@site/versioned_docs/version-0.4.3/airgap-workflow.md",1525],"015db4fe":[()=>n.e(9940).then(n.bind(n,9368)),"@site/docs/airgap-workflow.md",9368],"016e5590":[()=>n.e(3732).then(n.bind(n,7590)),"@site/versioned_docs/version-1.0.x/guides-references/utilities/fileserver.md",7590],"067e0e98":[()=>n.e(8967).then(n.bind(n,7852)),"@site/versioned_docs/version-1.0.0/introduction/uninstall.md",7852],"08a39dec":[()=>n.e(4356).then(n.bind(n,5334)),"@site/versioned_docs/version-0.4.1/guides-references/command-line/hauler-store.md",5334],"092dd1ce":[()=>n.e(7989).then(n.bind(n,1093)),"@site/versioned_docs/version-0.4.4/guides-references/command-line/hauler.md",1093],"0c154106":[()=>n.e(9497).then(n.bind(n,241)),"@site/versioned_docs/version-1.0.x/introduction/quickstart.md",241],"0c54d6cd":[()=>n.e(1568).then(n.t.bind(n,4702,19)),"@generated/docusaurus-plugin-content-docs/default/p/hauler-docs-docs-92f.json",4702],"0c5a8bb3":[()=>n.e(6613).then(n.bind(n,4409)),"@site/versioned_docs/version-1.0.x/guides-references/overview.md",4409],"0d694d04":[()=>n.e(272).then(n.bind(n,8916)),"@site/docs/guides-references/command-line/hauler-completion.md",8916],"0dfe3d03":[()=>n.e(2774).then(n.bind(n,1517)),"@site/versioned_docs/version-0.4.1/guides-references/cluster-images.md",1517],"0e07dcbd":[()=>n.e(3552).then(n.bind(n,1184)),"@site/versioned_docs/version-0.4.4/guides-references/cluster-images.md",1184],"0e384e19":[()=>n.e(3976).then(n.bind(n,1512)),"@site/docs/intro.md",1512],"0efd9b8a":[()=>n.e(5444).then(n.bind(n,8114)),"@site/versioned_docs/version-0.4.2/airgap-workflow.md",8114],"0f67b906":[()=>n.e(4825).then(n.bind(n,5570)),"@site/versioned_docs/version-1.0.0/guides-references/manifests.md",5570],"13b4a6fe":[()=>n.e(9511).then(n.bind(n,4805)),"@site/versioned_docs/version-0.4.2/guides-references/hauler-content/images.md",4805],"1671c90a":[()=>n.e(7239).then(n.bind(n,9098)),"@site/versioned_docs/version-1.0.0/core-concepts.md",9098],17896441:[()=>Promise.all([n.e(1869),n.e(2490),n.e(8401)]).then(n.bind(n,6365)),"@theme/DocItem",6365],"18b021cc":[()=>n.e(8735).then(n.bind(n,3290)),"@site/docs/introduction/quickstart.md",3290],"18f564c8":[()=>n.e(7432).then(n.bind(n,8771)),"@site/versioned_docs/version-1.0.x/intro.md",8771],"18fa258f":[()=>n.e(2422).then(n.bind(n,706)),"@site/docs/guides-references/hauler-content/files.md",706],"194e810c":[()=>n.e(902).then(n.bind(n,6990)),"@site/versioned_docs/version-0.4.4/known-limits.md",6990],"198208fc":[()=>n.e(3322).then(n.bind(n,3189)),"@site/versioned_docs/version-0.4.4/guides-references/hauler-collections/overview.md",3189],"19aeb315":[()=>n.e(7764).then(n.bind(n,9997)),"@site/versioned_docs/version-0.4.3/guides-references/command-line/hauler-version.md",9997],"1ad55919":[()=>n.e(3412).then(n.bind(n,4649)),"@site/versioned_docs/version-1.0.x/guides-references/cluster-images.md",4649],"1cfe0173":[()=>n.e(9651).then(n.bind(n,1937)),"@site/versioned_docs/version-1.0.0/guides-references/command-line/hauler-completion.md",1937],"1db0d189":[()=>n.e(4306).then(n.bind(n,948)),"@site/versioned_docs/version-0.4.4/airgap-workflow.md",948],"1f391b9e":[()=>Promise.all([n.e(1869),n.e(2490),n.e(6061)]).then(n.bind(n,7973)),"@theme/MDXPage",7973],"238f7f49":[()=>n.e(5398).then(n.bind(n,2924)),"@site/versioned_docs/version-0.4.4/guides-references/hauler-content/charts.md",2924],"263082ee":[()=>n.e(6590).then(n.bind(n,9376)),"@site/docs/guides-references/hauler-content/charts.md",9376],"27e9e2e1":[()=>n.e(8191).then(n.bind(n,8403)),"@site/versioned_docs/version-1.0.0/known-limits.md",8403],"28e0ee0f":[()=>n.e(8614).then(n.bind(n,4512)),"@site/versioned_docs/version-0.4.1/guides-references/hauler-content/files.md",4512],"3062a55a":[()=>n.e(1550).then(n.t.bind(n,1068,19)),"@generated/docusaurus-plugin-content-docs/default/p/hauler-docs-docs-1-0-0-ba0.json",1068],"34fcde0b":[()=>n.e(2732).then(n.bind(n,710)),"@site/versioned_docs/version-0.4.4/introduction/quickstart.md",710],"37803b2d":[()=>n.e(7060).then(n.bind(n,4129)),"@site/docs/guides-references/command-line/hauler.md",4129],"37e3f54f":[()=>n.e(8852).then(n.bind(n,498)),"@site/versioned_docs/version-1.0.0/guides-references/command-line/hauler.md",498],"380c291a":[()=>n.e(3492).then(n.bind(n,1335)),"@site/versioned_docs/version-0.4.3/guides-references/overview.md",1335],"393be207":[()=>n.e(4134).then(n.bind(n,6602)),"@site/src/pages/markdown-page.md",6602],"3a764183":[()=>n.e(2370).then(n.t.bind(n,7412,19)),"@generated/docusaurus-plugin-content-docs/default/p/hauler-docs-docs-0-4-3-160.json",7412],"3ba2d46d":[()=>n.e(3779).then(n.bind(n,7209)),"@site/versioned_docs/version-1.0.0/introduction/install.md",7209],"3ed46708":[()=>n.e(41).then(n.bind(n,280)),"@site/versioned_docs/version-0.4.4/guides-references/overview.md",280],"4121d743":[()=>n.e(6753).then(n.bind(n,2651)),"@site/versioned_docs/version-0.4.2/introduction/uninstall.md",2651],"427729a3":[()=>n.e(6848).then(n.bind(n,9875)),"@site/versioned_docs/version-0.4.2/guides-references/command-line/hauler.md",9875],"43cd4838":[()=>n.e(8184).then(n.bind(n,4393)),"@site/docs/core-concepts.md",4393],"44768bd5":[()=>n.e(6867).then(n.bind(n,6341)),"@site/versioned_docs/version-1.0.x/guides-references/command-line/hauler-store.md",6341],"450a63b5":[()=>n.e(5481).then(n.bind(n,6908)),"@site/versioned_docs/version-0.4.2/introduction/quickstart.md",6908],"473c7268":[()=>n.e(5851).then(n.bind(n,2802)),"@site/versioned_docs/version-0.4.2/guides-references/command-line/hauler-completion.md",2802],"4808dc98":[()=>n.e(4407).then(n.bind(n,1217)),"@site/versioned_docs/version-1.0.x/introduction/install.md",1217],"4832a47a":[()=>n.e(7795).then(n.bind(n,5477)),"@site/versioned_docs/version-1.0.x/guides-references/hauler-collections/community-collections.md",5477],"4996a385":[()=>n.e(9902).then(n.bind(n,2665)),"@site/versioned_docs/version-1.0.x/guides-references/command-line/hauler-completion.md",2665],"49c5a881":[()=>n.e(8236).then(n.bind(n,721)),"@site/docs/introduction/uninstall.md",721],"4a727ec9":[()=>n.e(1081).then(n.bind(n,5611)),"@site/versioned_docs/version-0.4.3/guides-references/command-line/hauler-completion.md",5611],"4a8152f5":[()=>n.e(2217).then(n.bind(n,2673)),"@site/versioned_docs/version-0.4.3/guides-references/hauler-content/files.md",2673],"4aedc38e":[()=>n.e(2186).then(n.bind(n,6167)),"@site/versioned_docs/version-0.4.3/guides-references/hauler-content/overview.md",6167],"4b93f48b":[()=>n.e(2669).then(n.bind(n,4733)),"@site/versioned_docs/version-0.4.4/introduction/uninstall.md",4733],"4b9ecfb3":[()=>n.e(557).then(n.bind(n,7569)),"@site/versioned_docs/version-0.4.3/intro.md",7569],"4c3097c2":[()=>n.e(4130).then(n.bind(n,5308)),"@site/versioned_docs/version-0.4.2/guides-references/hauler-collections/overview.md",5308],"4c39d837":[()=>n.e(570).then(n.t.bind(n,6002,19)),"@generated/docusaurus-plugin-content-docs/default/p/hauler-docs-docs-0-4-2-992.json",6002],"5180c9e5":[()=>n.e(7079).then(n.bind(n,4142)),"@site/versioned_docs/version-0.4.1/guides-references/command-line/hauler.md",4142],"52604abb":[()=>n.e(421).then(n.bind(n,7095)),"@site/versioned_docs/version-1.0.0/guides-references/hauler-content/files.md",7095],"52a6cb34":[()=>n.e(617).then(n.bind(n,1100)),"@site/versioned_docs/version-0.4.4/intro.md",1100],"52ca3a3f":[()=>n.e(9481).then(n.bind(n,2738)),"@site/versioned_docs/version-1.0.x/core-concepts.md",2738],"534a9f50":[()=>n.e(3920).then(n.bind(n,2097)),"@site/versioned_docs/version-1.0.0/guides-references/overview.md",2097],"53eeb07f":[()=>n.e(1260).then(n.bind(n,9675)),"@site/versioned_docs/version-1.0.0/guides-references/command-line/hauler-version.md",9675],"541c05f8":[()=>n.e(271).then(n.t.bind(n,7730,19)),"@generated/docusaurus-plugin-content-docs/default/p/hauler-docs-docs-0-4-4-edc.json",7730],"558b039e":[()=>n.e(7858).then(n.bind(n,4019)),"@site/versioned_docs/version-0.4.1/airgap-workflow.md",4019],"55e387c7":[()=>n.e(4288).then(n.bind(n,3001)),"@site/docs/guides-references/manifests.md",3001],"5814b660":[()=>n.e(9421).then(n.bind(n,4621)),"@site/versioned_docs/version-0.4.1/guides-references/overview.md",4621],"5916736d":[()=>n.e(1664).then(n.bind(n,9859)),"@site/versioned_docs/version-0.4.3/introduction/install.md",9859],"5b458d10":[()=>n.e(9068).then(n.bind(n,9506)),"@site/versioned_docs/version-0.4.4/guides-references/hauler-content/overview.md",9506],"5c6ec25c":[()=>n.e(9167).then(n.bind(n,7991)),"@site/versioned_docs/version-0.4.3/guides-references/cluster-images.md",7991],"5ce9c3d1":[()=>n.e(5722).then(n.bind(n,6806)),"@site/versioned_docs/version-0.4.2/guides-references/hauler-content/charts.md",6806],"5d1761f8":[()=>n.e(5917).then(n.bind(n,260)),"@site/docs/guides-references/overview.md",260],"5d33113d":[()=>n.e(1397).then(n.bind(n,4166)),"@site/versioned_docs/version-0.4.4/guides-references/hauler-content/files.md",4166],"5d8bfdfe":[()=>n.e(31).then(n.bind(n,6832)),"@site/versioned_docs/version-0.4.1/guides-references/hauler-content/images.md",6832],"5d94dea0":[()=>n.e(9845).then(n.bind(n,427)),"@site/versioned_docs/version-1.0.0/intro.md",427],"5e95c892":[()=>n.e(9647).then(n.bind(n,7121)),"@theme/DocsRoot",7121],"5e9f5e1a":[()=>Promise.resolve().then(n.bind(n,4784)),"@generated/docusaurus.config",4784],"5fae9c9a":[()=>n.e(9662).then(n.bind(n,321)),"@site/versioned_docs/version-1.0.0/guides-references/cluster-images.md",321],"673a5700":[()=>n.e(1753).then(n.bind(n,1803)),"@site/versioned_docs/version-0.4.1/guides-references/hauler-content/charts.md",1803],"678a4048":[()=>n.e(7879).then(n.bind(n,6045)),"@site/versioned_docs/version-0.4.2/intro.md",6045],68084510:[()=>n.e(4891).then(n.bind(n,9208)),"@site/versioned_docs/version-0.4.0/guides-references/hauler-content/charts.md",9208],"692c69f5":[()=>n.e(6125).then(n.bind(n,9961)),"@site/versioned_docs/version-0.4.3/guides-references/hauler-content/charts.md",9961],"6a9afd52":[()=>n.e(9969).then(n.bind(n,2451)),"@site/versioned_docs/version-0.4.0/guides-references/hauler-content/images.md",2451],"6adf121f":[()=>n.e(7610).then(n.bind(n,6626)),"@site/versioned_docs/version-0.4.0/introduction/quickstart.md",6626],"6be30e7c":[()=>n.e(5664).then(n.bind(n,7660)),"@site/docs/guides-references/cluster-images.md",7660],"6eba25ce":[()=>n.e(5784).then(n.bind(n,2146)),"@site/versioned_docs/version-0.4.0/known-limits.md",2146],"72c253a6":[()=>n.e(5110).then(n.bind(n,733)),"@site/versioned_docs/version-0.4.4/core-concepts.md",733],"741fe335":[()=>n.e(7263).then(n.bind(n,3914)),"@site/versioned_docs/version-0.4.0/guides-references/hauler-content/files.md",3914],"7706f24b":[()=>n.e(893).then(n.bind(n,2083)),"@site/versioned_docs/version-1.0.x/guides-references/command-line/hauler-version.md",2083],"776a8828":[()=>n.e(9184).then(n.bind(n,4001)),"@site/versioned_docs/version-0.4.3/known-limits.md",4001],"798007c7":[()=>n.e(4622).then(n.bind(n,77)),"@site/versioned_docs/version-0.4.1/guides-references/hauler-collections/overview.md",77],"7d221af7":[()=>n.e(8045).then(n.bind(n,3426)),"@site/versioned_docs/version-0.4.3/guides-references/carbide-customers.md",3426],"80d0621e":[()=>n.e(1897).then(n.bind(n,1142)),"@site/versioned_docs/version-0.4.1/core-concepts.md",1142],"82b7e4a8":[()=>n.e(2152).then(n.bind(n,3497)),"@site/versioned_docs/version-1.0.0/introduction/quickstart.md",3497],"84a33f5c":[()=>n.e(2236).then(n.bind(n,2232)),"@site/versioned_docs/version-0.4.3/guides-references/command-line/hauler.md",2232],"86b8ec4f":[()=>n.e(5861).then(n.bind(n,9687)),"@site/versioned_docs/version-1.0.0/guides-references/hauler-content/charts.md",9687],"86cd4487":[()=>n.e(3819).then(n.bind(n,1596)),"@site/versioned_docs/version-0.4.0/guides-references/command-line/hauler-version.md",1596],"8995c3a4":[()=>n.e(2005).then(n.bind(n,7716)),"@site/versioned_docs/version-1.0.x/guides-references/carbide-customers.md",7716],"8a1acfe9":[()=>n.e(9025).then(n.t.bind(n,9280,19)),"@generated/docusaurus-plugin-content-docs/default/p/hauler-docs-docs-0-4-1-e2b.json",9280],"8b123aa6":[()=>n.e(7117).then(n.bind(n,2330)),"@site/versioned_docs/version-1.0.x/guides-references/command-line/hauler.md",2330],"8e4a7bb4":[()=>n.e(8126).then(n.bind(n,204)),"@site/versioned_docs/version-0.4.2/known-limits.md",204],"8f3c2c5e":[()=>n.e(844).then(n.bind(n,4571)),"@site/versioned_docs/version-1.0.x/known-limits.md",4571],"8fc29581":[()=>n.e(1721).then(n.bind(n,1098)),"@site/docs/known-limits.md",1098],90636519:[()=>n.e(1056).then(n.bind(n,4672)),"@site/versioned_docs/version-0.4.1/introduction/uninstall.md",4672],"915076b3":[()=>n.e(5584).then(n.bind(n,1633)),"@site/docs/guides-references/command-line/hauler-store.md",1633],"94b10bcf":[()=>n.e(1754).then(n.bind(n,9263)),"@site/docs/guides-references/carbide-customers.md",9263],"95c65ae4":[()=>n.e(759).then(n.bind(n,1949)),"@site/versioned_docs/version-0.4.1/introduction/quickstart.md",1949],"96c5fba0":[()=>n.e(7461).then(n.bind(n,1032)),"@site/versioned_docs/version-0.4.2/guides-references/hauler-content/files.md",1032],"989e584c":[()=>n.e(7446).then(n.bind(n,6218)),"@site/versioned_docs/version-1.0.x/guides-references/manifests.md",6218],"989f82e2":[()=>n.e(4198).then(n.bind(n,3727)),"@site/versioned_docs/version-1.0.x/guides-references/hauler-content/files.md",3727],"99d8f5e1":[()=>n.e(1520).then(n.bind(n,8489)),"@site/versioned_docs/version-0.4.0/guides-references/command-line/hauler.md",8489],"9ae84177":[()=>n.e(6821).then(n.bind(n,1502)),"@site/versioned_docs/version-1.0.x/guides-references/command-line/hauler-login.md",1502],"9b4a10b8":[()=>n.e(4662).then(n.bind(n,2160)),"@site/docs/introduction/install.md",2160],"9ea6ce46":[()=>n.e(3254).then(n.bind(n,6742)),"@site/versioned_docs/version-0.4.2/guides-references/cluster-images.md",6742],a0e1656a:[()=>n.e(6506).then(n.bind(n,3303)),"@site/versioned_docs/version-0.4.4/guides-references/hauler-content/images.md",3303],a1085104:[()=>n.e(7107).then(n.bind(n,6909)),"@site/versioned_docs/version-1.0.0/guides-references/hauler-collections/community-collections.md",6909],a1833862:[()=>n.e(775).then(n.t.bind(n,2814,19)),"@generated/docusaurus-plugin-content-docs/default/p/hauler-docs-docs-next-9db.json",2814],a3c9f3d7:[()=>n.e(5957).then(n.bind(n,8832)),"@site/versioned_docs/version-0.4.4/guides-references/command-line/hauler-completion.md",8832],a6e70215:[()=>n.e(1890).then(n.bind(n,9848)),"@site/versioned_docs/version-0.4.0/introduction/install.md",9848],a7456010:[()=>n.e(1235).then(n.t.bind(n,8552,19)),"@generated/docusaurus-plugin-content-pages/default/__plugin.json",8552],a74adf62:[()=>n.e(1652).then(n.bind(n,2092)),"@site/versioned_docs/version-0.4.0/guides-references/command-line/hauler-completion.md",2092],a7bd4aaa:[()=>n.e(7098).then(n.bind(n,4532)),"@theme/DocVersionRoot",4532],a7d2e20e:[()=>n.e(3497).then(n.bind(n,2150)),"@site/versioned_docs/version-0.4.0/guides-references/hauler-content/overview.md",2150],a90ac227:[()=>n.e(7426).then(n.bind(n,3020)),"@site/versioned_docs/version-1.0.0/guides-references/carbide-customers.md",3020],a94703ab:[()=>Promise.all([n.e(1869),n.e(9048)]).then(n.bind(n,2559)),"@theme/DocRoot",2559],aba21aa0:[()=>n.e(5742).then(n.t.bind(n,7093,19)),"@generated/docusaurus-plugin-content-docs/default/__plugin.json",7093],abf93448:[()=>n.e(2700).then(n.bind(n,5151)),"@site/versioned_docs/version-0.4.2/guides-references/command-line/hauler-store.md",5151],aee14194:[()=>n.e(1909).then(n.bind(n,5231)),"@site/docs/guides-references/utilities/fileserver.md",5231],af1b3cb5:[()=>n.e(6078).then(n.bind(n,7047)),"@site/versioned_docs/version-0.4.2/core-concepts.md",7047],af23d200:[()=>n.e(913).then(n.bind(n,6151)),"@site/versioned_docs/version-0.4.1/intro.md",6151],af7bf720:[()=>n.e(7846).then(n.bind(n,5851)),"@site/versioned_docs/version-0.4.3/guides-references/hauler-collections/overview.md",5851],afb652b9:[()=>n.e(688).then(n.t.bind(n,5396,19)),"@generated/docusaurus-plugin-content-docs/default/p/hauler-docs-docs-0-4-0-d40.json",5396],afcf285f:[()=>n.e(1482).then(n.bind(n,3277)),"@site/versioned_docs/version-0.4.1/introduction/install.md",3277],b3134099:[()=>n.e(8656).then(n.bind(n,6311)),"@site/versioned_docs/version-0.4.3/core-concepts.md",6311],b548b5e0:[()=>n.e(5560).then(n.bind(n,848)),"@site/versioned_docs/version-0.4.0/intro.md",848],bbe7335f:[()=>n.e(8548).then(n.bind(n,7135)),"@site/versioned_docs/version-0.4.3/introduction/quickstart.md",7135],bc025a59:[()=>n.e(1432).then(n.bind(n,2991)),"@site/versioned_docs/version-1.0.x/guides-references/hauler-content/charts.md",2991],bda10480:[()=>n.e(5683).then(n.bind(n,9284)),"@site/versioned_docs/version-1.0.x/introduction/uninstall.md",9284],bec068c2:[()=>n.e(8792).then(n.bind(n,8540)),"@site/versioned_docs/version-0.4.2/guides-references/hauler-content/overview.md",8540],c1ae016a:[()=>n.e(4007).then(n.bind(n,9452)),"@site/versioned_docs/version-0.4.4/introduction/install.md",9452],c24b511b:[()=>n.e(3413).then(n.bind(n,3855)),"@site/versioned_docs/version-1.0.0/airgap-workflow.md",3855],c3e6124d:[()=>n.e(941).then(n.bind(n,9147)),"@site/docs/feedback.md",9147],c45a31f6:[()=>n.e(2032).then(n.bind(n,3177)),"@site/versioned_docs/version-0.4.0/introduction/uninstall.md",3177],c47a16f3:[()=>n.e(2378).then(n.bind(n,9188)),"@site/versioned_docs/version-1.0.x/guides-references/hauler-content/images.md",9188],c4c39368:[()=>n.e(7810).then(n.bind(n,3151)),"@site/versioned_docs/version-0.4.1/known-limits.md",3151],c4f5d8e4:[()=>Promise.all([n.e(1869),n.e(2634)]).then(n.bind(n,6467)),"@site/src/pages/index.js",6467],c50bb318:[()=>n.e(1759).then(n.bind(n,714)),"@site/versioned_docs/version-1.0.0/feedback.md",714],c54e2943:[()=>n.e(9182).then(n.bind(n,6005)),"@site/versioned_docs/version-0.4.1/guides-references/command-line/hauler-completion.md",6005],c7112151:[()=>n.e(2646).then(n.bind(n,370)),"@site/versioned_docs/version-1.0.x/feedback.md",370],ccad6351:[()=>n.e(2541).then(n.bind(n,6814)),"@site/versioned_docs/version-0.4.0/guides-references/hauler-collections/overview.md",6814],cfe3dcaf:[()=>n.e(2890).then(n.bind(n,4132)),"@site/versioned_docs/version-0.4.3/guides-references/command-line/hauler-store.md",4132],cfe91dae:[()=>n.e(6923).then(n.bind(n,2372)),"@site/versioned_docs/version-0.4.0/guides-references/cluster-images.md",2372],d08f4848:[()=>n.e(7741).then(n.bind(n,3353)),"@site/versioned_docs/version-0.4.2/guides-references/carbide-customers.md",3353],d25cb22b:[()=>n.e(2713).then(n.bind(n,3206)),"@site/versioned_docs/version-0.4.2/guides-references/overview.md",3206],d346e559:[()=>n.e(7010).then(n.bind(n,6274)),"@site/versioned_docs/version-0.4.2/guides-references/command-line/hauler-version.md",6274],d8cfcbbf:[()=>n.e(8663).then(n.bind(n,5374)),"@site/versioned_docs/version-0.4.2/introduction/install.md",5374],dbfc2905:[()=>n.e(9510).then(n.bind(n,3519)),"@site/versioned_docs/version-0.4.1/guides-references/command-line/hauler-version.md",3519],e0511d92:[()=>n.e(8464).then(n.bind(n,380)),"@site/versioned_docs/version-1.0.x/guides-references/utilities/registry.md",380],e25e5fe1:[()=>n.e(9847).then(n.bind(n,6636)),"@site/versioned_docs/version-0.4.0/guides-references/overview.md",6636],e265a717:[()=>n.e(9021).then(n.bind(n,2608)),"@site/versioned_docs/version-0.4.0/airgap-workflow.md",2608],e35f73ee:[()=>n.e(3482).then(n.bind(n,5914)),"@site/versioned_docs/version-0.4.3/guides-references/hauler-content/images.md",5914],e59d17bf:[()=>n.e(1246).then(n.bind(n,1948)),"@site/versioned_docs/version-1.0.0/guides-references/hauler-content/images.md",1948],e5e2c0f7:[()=>n.e(3084).then(n.bind(n,2817)),"@site/versioned_docs/version-0.4.1/guides-references/hauler-content/overview.md",2817],e9373bc2:[()=>n.e(7339).then(n.bind(n,7321)),"@site/versioned_docs/version-0.4.0/guides-references/command-line/hauler-store.md",7321],e9c31bdf:[()=>n.e(608).then(n.bind(n,624)),"@site/versioned_docs/version-0.4.4/guides-references/command-line/hauler-version.md",624],e9c8eb9f:[()=>n.e(4812).then(n.bind(n,2986)),"@site/versioned_docs/version-0.4.3/introduction/uninstall.md",2986],eb3f7e0d:[()=>n.e(4373).then(n.bind(n,9109)),"@site/docs/guides-references/command-line/hauler-login.md",9109],f10ad690:[()=>n.e(1992).then(n.bind(n,7140)),"@site/docs/guides-references/hauler-collections/community-collections.md",7140],f663b962:[()=>n.e(2961).then(n.bind(n,9029)),"@site/docs/guides-references/utilities/registry.md",9029],f674df19:[()=>n.e(5058).then(n.bind(n,6453)),"@site/versioned_docs/version-0.4.4/guides-references/command-line/hauler-store.md",6453],f7b007a5:[()=>n.e(5849).then(n.bind(n,3959)),"@site/versioned_docs/version-1.0.x/airgap-workflow.md",3959],f7f847a4:[()=>n.e(7976).then(n.bind(n,2987)),"@site/versioned_docs/version-0.4.4/guides-references/carbide-customers.md",2987],fcac5ca8:[()=>n.e(9425).then(n.bind(n,2442)),"@site/versioned_docs/version-1.0.0/guides-references/command-line/hauler-store.md",2442],fd1af507:[()=>n.e(3575).then(n.bind(n,8641)),"@site/versioned_docs/version-0.4.0/core-concepts.md",8641],fe306ed6:[()=>n.e(5180).then(n.bind(n,1476)),"@site/docs/guides-references/command-line/hauler-version.md",1476],ffba34cc:[()=>n.e(9163).then(n.bind(n,6952)),"@site/docs/guides-references/hauler-content/images.md",6952]};var s=n(4848);function l(e){let{error:t,retry:n,pastDelay:r}=e;return t?(0,s.jsxs)("div",{style:{textAlign:"center",color:"#fff",backgroundColor:"#fa383e",borderColor:"#fa383e",borderStyle:"solid",borderRadius:"0.25rem",borderWidth:"1px",boxSizing:"border-box",display:"block",padding:"1rem",flex:"0 0 50%",marginLeft:"25%",marginRight:"25%",marginTop:"5rem",maxWidth:"50%",width:"100%"},children:[(0,s.jsx)("p",{children:String(t)}),(0,s.jsx)("div",{children:(0,s.jsx)("button",{type:"button",onClick:n,children:"Retry"})})]}):r?(0,s.jsx)("div",{style:{display:"flex",justifyContent:"center",alignItems:"center",height:"100vh"},children:(0,s.jsx)("svg",{id:"loader",style:{width:128,height:110,position:"absolute",top:"calc(100vh - 64%)"},viewBox:"0 0 45 45",xmlns:"http://www.w3.org/2000/svg",stroke:"#61dafb",children:(0,s.jsxs)("g",{fill:"none",fillRule:"evenodd",transform:"translate(1 1)",strokeWidth:"2",children:[(0,s.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,s.jsx)("animate",{attributeName:"r",begin:"1.5s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-opacity",begin:"1.5s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-width",begin:"1.5s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,s.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,s.jsx)("animate",{attributeName:"r",begin:"3s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-opacity",begin:"3s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-width",begin:"3s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,s.jsx)("circle",{cx:"22",cy:"22",r:"8",children:(0,s.jsx)("animate",{attributeName:"r",begin:"0s",dur:"1.5s",values:"6;1;2;3;4;5;6",calcMode:"linear",repeatCount:"indefinite"})})]})})}):null}var c=n(6921),u=n(3102);function d(e,t){if("*"===e)return o()({loading:l,loader:()=>n.e(2237).then(n.bind(n,2237)),modules:["@theme/NotFound"],webpack:()=>[2237],render(e,t){const n=e.default;return(0,s.jsx)(u.W,{value:{plugin:{name:"native",id:"default"}},children:(0,s.jsx)(n,{...t})})}});const r=a[`${e}-${t}`],d={},f=[],p=[],h=(0,c.A)(r);return Object.entries(h).forEach((e=>{let[t,n]=e;const r=i[n];r&&(d[t]=r[0],f.push(r[1]),p.push(r[2]))})),o().Map({loading:l,loader:d,modules:f,webpack:()=>p,render(t,n){const o=JSON.parse(JSON.stringify(r));Object.entries(t).forEach((t=>{let[n,r]=t;const a=r.default;if(!a)throw new Error(`The page component at ${e} doesn't have a default export. This makes it impossible to render anything. Consider default-exporting a React component.`);"object"!=typeof a&&"function"!=typeof a||Object.keys(r).filter((e=>"default"!==e)).forEach((e=>{a[e]=r[e]}));let i=o;const s=n.split(".");s.slice(0,-1).forEach((e=>{i=i[e]})),i[s[s.length-1]]=a}));const a=o.__comp;delete o.__comp;const i=o.__context;delete o.__context;const l=o.__props;return delete o.__props,(0,s.jsx)(u.W,{value:i,children:(0,s.jsx)(a,{...o,...l,...n})})}})}const f=[{path:"/hauler-docs/markdown-page",component:d("/hauler-docs/markdown-page","9b6"),exact:!0},{path:"/hauler-docs/docs",component:d("/hauler-docs/docs","4f8"),routes:[{path:"/hauler-docs/docs/0.4.0",component:d("/hauler-docs/docs/0.4.0","10a"),routes:[{path:"/hauler-docs/docs/0.4.0",component:d("/hauler-docs/docs/0.4.0","325"),routes:[{path:"/hauler-docs/docs/0.4.0/airgap-workflow",component:d("/hauler-docs/docs/0.4.0/airgap-workflow","320"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.0/core-concepts",component:d("/hauler-docs/docs/0.4.0/core-concepts","ed8"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.0/guides-references/cluster-images",component:d("/hauler-docs/docs/0.4.0/guides-references/cluster-images","625"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.0/guides-references/command-line/hauler",component:d("/hauler-docs/docs/0.4.0/guides-references/command-line/hauler","59e"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.0/guides-references/command-line/hauler-completion",component:d("/hauler-docs/docs/0.4.0/guides-references/command-line/hauler-completion","8bf"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.0/guides-references/command-line/hauler-store",component:d("/hauler-docs/docs/0.4.0/guides-references/command-line/hauler-store","3f4"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.0/guides-references/command-line/hauler-version",component:d("/hauler-docs/docs/0.4.0/guides-references/command-line/hauler-version","e29"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.0/guides-references/hauler-collections/overview",component:d("/hauler-docs/docs/0.4.0/guides-references/hauler-collections/overview","47c"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.0/guides-references/hauler-content/charts",component:d("/hauler-docs/docs/0.4.0/guides-references/hauler-content/charts","379"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.0/guides-references/hauler-content/files",component:d("/hauler-docs/docs/0.4.0/guides-references/hauler-content/files","533"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.0/guides-references/hauler-content/images",component:d("/hauler-docs/docs/0.4.0/guides-references/hauler-content/images","e1e"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.0/guides-references/hauler-content/overview",component:d("/hauler-docs/docs/0.4.0/guides-references/hauler-content/overview","e49"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.0/guides-references/overview",component:d("/hauler-docs/docs/0.4.0/guides-references/overview","daa"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.0/intro",component:d("/hauler-docs/docs/0.4.0/intro","ebf"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.0/introduction/install",component:d("/hauler-docs/docs/0.4.0/introduction/install","5e8"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.0/introduction/quickstart",component:d("/hauler-docs/docs/0.4.0/introduction/quickstart","bfe"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.0/introduction/uninstall",component:d("/hauler-docs/docs/0.4.0/introduction/uninstall","7b4"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.0/known-limits",component:d("/hauler-docs/docs/0.4.0/known-limits","ac9"),exact:!0,sidebar:"haulerSidebar"}]}]},{path:"/hauler-docs/docs/0.4.1",component:d("/hauler-docs/docs/0.4.1","de4"),routes:[{path:"/hauler-docs/docs/0.4.1",component:d("/hauler-docs/docs/0.4.1","2d3"),routes:[{path:"/hauler-docs/docs/0.4.1/airgap-workflow",component:d("/hauler-docs/docs/0.4.1/airgap-workflow","aa1"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.1/core-concepts",component:d("/hauler-docs/docs/0.4.1/core-concepts","6b6"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.1/guides-references/cluster-images",component:d("/hauler-docs/docs/0.4.1/guides-references/cluster-images","fca"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.1/guides-references/command-line/hauler",component:d("/hauler-docs/docs/0.4.1/guides-references/command-line/hauler","6ec"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.1/guides-references/command-line/hauler-completion",component:d("/hauler-docs/docs/0.4.1/guides-references/command-line/hauler-completion","884"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.1/guides-references/command-line/hauler-store",component:d("/hauler-docs/docs/0.4.1/guides-references/command-line/hauler-store","bca"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.1/guides-references/command-line/hauler-version",component:d("/hauler-docs/docs/0.4.1/guides-references/command-line/hauler-version","ec5"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.1/guides-references/hauler-collections/overview",component:d("/hauler-docs/docs/0.4.1/guides-references/hauler-collections/overview","343"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.1/guides-references/hauler-content/charts",component:d("/hauler-docs/docs/0.4.1/guides-references/hauler-content/charts","68a"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.1/guides-references/hauler-content/files",component:d("/hauler-docs/docs/0.4.1/guides-references/hauler-content/files","2af"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.1/guides-references/hauler-content/images",component:d("/hauler-docs/docs/0.4.1/guides-references/hauler-content/images","65f"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.1/guides-references/hauler-content/overview",component:d("/hauler-docs/docs/0.4.1/guides-references/hauler-content/overview","da9"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.1/guides-references/overview",component:d("/hauler-docs/docs/0.4.1/guides-references/overview","f63"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.1/intro",component:d("/hauler-docs/docs/0.4.1/intro","a03"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.1/introduction/install",component:d("/hauler-docs/docs/0.4.1/introduction/install","2b2"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.1/introduction/quickstart",component:d("/hauler-docs/docs/0.4.1/introduction/quickstart","3fc"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.1/introduction/uninstall",component:d("/hauler-docs/docs/0.4.1/introduction/uninstall","467"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.1/known-limits",component:d("/hauler-docs/docs/0.4.1/known-limits","2f1"),exact:!0,sidebar:"haulerSidebar"}]}]},{path:"/hauler-docs/docs/0.4.2",component:d("/hauler-docs/docs/0.4.2","316"),routes:[{path:"/hauler-docs/docs/0.4.2",component:d("/hauler-docs/docs/0.4.2","16a"),routes:[{path:"/hauler-docs/docs/0.4.2/airgap-workflow",component:d("/hauler-docs/docs/0.4.2/airgap-workflow","7cb"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.2/core-concepts",component:d("/hauler-docs/docs/0.4.2/core-concepts","1f9"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.2/guides-references/carbide-customers",component:d("/hauler-docs/docs/0.4.2/guides-references/carbide-customers","055"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.2/guides-references/cluster-images",component:d("/hauler-docs/docs/0.4.2/guides-references/cluster-images","b25"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.2/guides-references/command-line/hauler",component:d("/hauler-docs/docs/0.4.2/guides-references/command-line/hauler","40c"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.2/guides-references/command-line/hauler-completion",component:d("/hauler-docs/docs/0.4.2/guides-references/command-line/hauler-completion","a63"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.2/guides-references/command-line/hauler-store",component:d("/hauler-docs/docs/0.4.2/guides-references/command-line/hauler-store","86f"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.2/guides-references/command-line/hauler-version",component:d("/hauler-docs/docs/0.4.2/guides-references/command-line/hauler-version","c62"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.2/guides-references/hauler-collections/overview",component:d("/hauler-docs/docs/0.4.2/guides-references/hauler-collections/overview","9c4"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.2/guides-references/hauler-content/charts",component:d("/hauler-docs/docs/0.4.2/guides-references/hauler-content/charts","e90"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.2/guides-references/hauler-content/files",component:d("/hauler-docs/docs/0.4.2/guides-references/hauler-content/files","c35"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.2/guides-references/hauler-content/images",component:d("/hauler-docs/docs/0.4.2/guides-references/hauler-content/images","d61"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.2/guides-references/hauler-content/overview",component:d("/hauler-docs/docs/0.4.2/guides-references/hauler-content/overview","8f0"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.2/guides-references/overview",component:d("/hauler-docs/docs/0.4.2/guides-references/overview","9d0"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.2/intro",component:d("/hauler-docs/docs/0.4.2/intro","268"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.2/introduction/install",component:d("/hauler-docs/docs/0.4.2/introduction/install","11c"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.2/introduction/quickstart",component:d("/hauler-docs/docs/0.4.2/introduction/quickstart","4fe"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.2/introduction/uninstall",component:d("/hauler-docs/docs/0.4.2/introduction/uninstall","295"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.2/known-limits",component:d("/hauler-docs/docs/0.4.2/known-limits","a1d"),exact:!0,sidebar:"haulerSidebar"}]}]},{path:"/hauler-docs/docs/0.4.3",component:d("/hauler-docs/docs/0.4.3","05f"),routes:[{path:"/hauler-docs/docs/0.4.3",component:d("/hauler-docs/docs/0.4.3","a83"),routes:[{path:"/hauler-docs/docs/0.4.3/airgap-workflow",component:d("/hauler-docs/docs/0.4.3/airgap-workflow","b0d"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.3/core-concepts",component:d("/hauler-docs/docs/0.4.3/core-concepts","107"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.3/guides-references/carbide-customers",component:d("/hauler-docs/docs/0.4.3/guides-references/carbide-customers","a7b"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.3/guides-references/cluster-images",component:d("/hauler-docs/docs/0.4.3/guides-references/cluster-images","716"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.3/guides-references/command-line/hauler",component:d("/hauler-docs/docs/0.4.3/guides-references/command-line/hauler","45c"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.3/guides-references/command-line/hauler-completion",component:d("/hauler-docs/docs/0.4.3/guides-references/command-line/hauler-completion","f12"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.3/guides-references/command-line/hauler-store",component:d("/hauler-docs/docs/0.4.3/guides-references/command-line/hauler-store","24a"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.3/guides-references/command-line/hauler-version",component:d("/hauler-docs/docs/0.4.3/guides-references/command-line/hauler-version","bf0"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.3/guides-references/hauler-collections/overview",component:d("/hauler-docs/docs/0.4.3/guides-references/hauler-collections/overview","7bc"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.3/guides-references/hauler-content/charts",component:d("/hauler-docs/docs/0.4.3/guides-references/hauler-content/charts","633"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.3/guides-references/hauler-content/files",component:d("/hauler-docs/docs/0.4.3/guides-references/hauler-content/files","de5"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.3/guides-references/hauler-content/images",component:d("/hauler-docs/docs/0.4.3/guides-references/hauler-content/images","45b"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.3/guides-references/hauler-content/overview",component:d("/hauler-docs/docs/0.4.3/guides-references/hauler-content/overview","52e"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.3/guides-references/overview",component:d("/hauler-docs/docs/0.4.3/guides-references/overview","c70"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.3/intro",component:d("/hauler-docs/docs/0.4.3/intro","82a"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.3/introduction/install",component:d("/hauler-docs/docs/0.4.3/introduction/install","ea7"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.3/introduction/quickstart",component:d("/hauler-docs/docs/0.4.3/introduction/quickstart","1e6"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.3/introduction/uninstall",component:d("/hauler-docs/docs/0.4.3/introduction/uninstall","fac"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.3/known-limits",component:d("/hauler-docs/docs/0.4.3/known-limits","d49"),exact:!0,sidebar:"haulerSidebar"}]}]},{path:"/hauler-docs/docs/0.4.4",component:d("/hauler-docs/docs/0.4.4","e78"),routes:[{path:"/hauler-docs/docs/0.4.4",component:d("/hauler-docs/docs/0.4.4","9e2"),routes:[{path:"/hauler-docs/docs/0.4.4/airgap-workflow",component:d("/hauler-docs/docs/0.4.4/airgap-workflow","930"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.4/core-concepts",component:d("/hauler-docs/docs/0.4.4/core-concepts","acf"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.4/guides-references/carbide-customers",component:d("/hauler-docs/docs/0.4.4/guides-references/carbide-customers","0da"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.4/guides-references/cluster-images",component:d("/hauler-docs/docs/0.4.4/guides-references/cluster-images","c73"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.4/guides-references/command-line/hauler",component:d("/hauler-docs/docs/0.4.4/guides-references/command-line/hauler","a43"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.4/guides-references/command-line/hauler-completion",component:d("/hauler-docs/docs/0.4.4/guides-references/command-line/hauler-completion","954"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.4/guides-references/command-line/hauler-store",component:d("/hauler-docs/docs/0.4.4/guides-references/command-line/hauler-store","ae4"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.4/guides-references/command-line/hauler-version",component:d("/hauler-docs/docs/0.4.4/guides-references/command-line/hauler-version","4fb"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.4/guides-references/hauler-collections/overview",component:d("/hauler-docs/docs/0.4.4/guides-references/hauler-collections/overview","8c4"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.4/guides-references/hauler-content/charts",component:d("/hauler-docs/docs/0.4.4/guides-references/hauler-content/charts","303"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.4/guides-references/hauler-content/files",component:d("/hauler-docs/docs/0.4.4/guides-references/hauler-content/files","3fe"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.4/guides-references/hauler-content/images",component:d("/hauler-docs/docs/0.4.4/guides-references/hauler-content/images","37b"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.4/guides-references/hauler-content/overview",component:d("/hauler-docs/docs/0.4.4/guides-references/hauler-content/overview","431"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.4/guides-references/overview",component:d("/hauler-docs/docs/0.4.4/guides-references/overview","dca"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.4/intro",component:d("/hauler-docs/docs/0.4.4/intro","c63"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.4/introduction/install",component:d("/hauler-docs/docs/0.4.4/introduction/install","57f"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.4/introduction/quickstart",component:d("/hauler-docs/docs/0.4.4/introduction/quickstart","64c"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.4/introduction/uninstall",component:d("/hauler-docs/docs/0.4.4/introduction/uninstall","9fa"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/0.4.4/known-limits",component:d("/hauler-docs/docs/0.4.4/known-limits","dbc"),exact:!0,sidebar:"haulerSidebar"}]}]},{path:"/hauler-docs/docs/1.0.0",component:d("/hauler-docs/docs/1.0.0","020"),routes:[{path:"/hauler-docs/docs/1.0.0",component:d("/hauler-docs/docs/1.0.0","96d"),routes:[{path:"/hauler-docs/docs/1.0.0/airgap-workflow",component:d("/hauler-docs/docs/1.0.0/airgap-workflow","a43"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/1.0.0/core-concepts",component:d("/hauler-docs/docs/1.0.0/core-concepts","6e3"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/1.0.0/feedback",component:d("/hauler-docs/docs/1.0.0/feedback","d0f"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/1.0.0/guides-references/carbide-customers",component:d("/hauler-docs/docs/1.0.0/guides-references/carbide-customers","273"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/1.0.0/guides-references/cluster-images",component:d("/hauler-docs/docs/1.0.0/guides-references/cluster-images","9ae"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/1.0.0/guides-references/command-line/hauler",component:d("/hauler-docs/docs/1.0.0/guides-references/command-line/hauler","461"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/1.0.0/guides-references/command-line/hauler-completion",component:d("/hauler-docs/docs/1.0.0/guides-references/command-line/hauler-completion","b24"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/1.0.0/guides-references/command-line/hauler-store",component:d("/hauler-docs/docs/1.0.0/guides-references/command-line/hauler-store","dbf"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/1.0.0/guides-references/command-line/hauler-version",component:d("/hauler-docs/docs/1.0.0/guides-references/command-line/hauler-version","72c"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/1.0.0/guides-references/hauler-collections/community-collections",component:d("/hauler-docs/docs/1.0.0/guides-references/hauler-collections/community-collections","596"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/1.0.0/guides-references/hauler-content/charts",component:d("/hauler-docs/docs/1.0.0/guides-references/hauler-content/charts","981"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/1.0.0/guides-references/hauler-content/files",component:d("/hauler-docs/docs/1.0.0/guides-references/hauler-content/files","654"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/1.0.0/guides-references/hauler-content/images",component:d("/hauler-docs/docs/1.0.0/guides-references/hauler-content/images","20e"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/1.0.0/guides-references/manifests",component:d("/hauler-docs/docs/1.0.0/guides-references/manifests","269"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/1.0.0/guides-references/overview",component:d("/hauler-docs/docs/1.0.0/guides-references/overview","db5"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/1.0.0/intro",component:d("/hauler-docs/docs/1.0.0/intro","1ce"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/1.0.0/introduction/install",component:d("/hauler-docs/docs/1.0.0/introduction/install","e9a"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/1.0.0/introduction/quickstart",component:d("/hauler-docs/docs/1.0.0/introduction/quickstart","343"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/1.0.0/introduction/uninstall",component:d("/hauler-docs/docs/1.0.0/introduction/uninstall","bc7"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/1.0.0/known-limits",component:d("/hauler-docs/docs/1.0.0/known-limits","53f"),exact:!0,sidebar:"haulerSidebar"}]}]},{path:"/hauler-docs/docs/next",component:d("/hauler-docs/docs/next","07e"),routes:[{path:"/hauler-docs/docs/next",component:d("/hauler-docs/docs/next","ef0"),routes:[{path:"/hauler-docs/docs/next/airgap-workflow",component:d("/hauler-docs/docs/next/airgap-workflow","64d"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/next/core-concepts",component:d("/hauler-docs/docs/next/core-concepts","b6f"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/next/feedback",component:d("/hauler-docs/docs/next/feedback","e12"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/next/guides-references/carbide-customers",component:d("/hauler-docs/docs/next/guides-references/carbide-customers","41d"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/next/guides-references/cluster-images",component:d("/hauler-docs/docs/next/guides-references/cluster-images","d1c"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/next/guides-references/command-line/hauler",component:d("/hauler-docs/docs/next/guides-references/command-line/hauler","ac0"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/next/guides-references/command-line/hauler-completion",component:d("/hauler-docs/docs/next/guides-references/command-line/hauler-completion","faf"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/next/guides-references/command-line/hauler-login",component:d("/hauler-docs/docs/next/guides-references/command-line/hauler-login","a48"),exact:!0},{path:"/hauler-docs/docs/next/guides-references/command-line/hauler-store",component:d("/hauler-docs/docs/next/guides-references/command-line/hauler-store","c38"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/next/guides-references/command-line/hauler-version",component:d("/hauler-docs/docs/next/guides-references/command-line/hauler-version","e29"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/next/guides-references/hauler-collections/community-collections",component:d("/hauler-docs/docs/next/guides-references/hauler-collections/community-collections","9ff"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/next/guides-references/hauler-content/charts",component:d("/hauler-docs/docs/next/guides-references/hauler-content/charts","bcc"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/next/guides-references/hauler-content/files",component:d("/hauler-docs/docs/next/guides-references/hauler-content/files","101"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/next/guides-references/hauler-content/images",component:d("/hauler-docs/docs/next/guides-references/hauler-content/images","a53"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/next/guides-references/manifests",component:d("/hauler-docs/docs/next/guides-references/manifests","807"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/next/guides-references/overview",component:d("/hauler-docs/docs/next/guides-references/overview","d4d"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/next/guides-references/utilities/fileserver",component:d("/hauler-docs/docs/next/guides-references/utilities/fileserver","dcd"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/next/guides-references/utilities/registry",component:d("/hauler-docs/docs/next/guides-references/utilities/registry","87c"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/next/intro",component:d("/hauler-docs/docs/next/intro","d3c"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/next/introduction/install",component:d("/hauler-docs/docs/next/introduction/install","73a"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/next/introduction/quickstart",component:d("/hauler-docs/docs/next/introduction/quickstart","8c7"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/next/introduction/uninstall",component:d("/hauler-docs/docs/next/introduction/uninstall","553"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/next/known-limits",component:d("/hauler-docs/docs/next/known-limits","1f6"),exact:!0,sidebar:"haulerSidebar"}]}]},{path:"/hauler-docs/docs",component:d("/hauler-docs/docs","a61"),routes:[{path:"/hauler-docs/docs",component:d("/hauler-docs/docs","f3e"),routes:[{path:"/hauler-docs/docs/airgap-workflow",component:d("/hauler-docs/docs/airgap-workflow","202"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/core-concepts",component:d("/hauler-docs/docs/core-concepts","589"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/feedback",component:d("/hauler-docs/docs/feedback","a00"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/guides-references/carbide-customers",component:d("/hauler-docs/docs/guides-references/carbide-customers","949"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/guides-references/cluster-images",component:d("/hauler-docs/docs/guides-references/cluster-images","fa6"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/guides-references/command-line/hauler",component:d("/hauler-docs/docs/guides-references/command-line/hauler","4ef"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/guides-references/command-line/hauler-completion",component:d("/hauler-docs/docs/guides-references/command-line/hauler-completion","89e"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/guides-references/command-line/hauler-login",component:d("/hauler-docs/docs/guides-references/command-line/hauler-login","8a6"),exact:!0},{path:"/hauler-docs/docs/guides-references/command-line/hauler-store",component:d("/hauler-docs/docs/guides-references/command-line/hauler-store","611"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/guides-references/command-line/hauler-version",component:d("/hauler-docs/docs/guides-references/command-line/hauler-version","8c1"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/guides-references/hauler-collections/community-collections",component:d("/hauler-docs/docs/guides-references/hauler-collections/community-collections","10f"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/guides-references/hauler-content/charts",component:d("/hauler-docs/docs/guides-references/hauler-content/charts","149"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/guides-references/hauler-content/files",component:d("/hauler-docs/docs/guides-references/hauler-content/files","eae"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/guides-references/hauler-content/images",component:d("/hauler-docs/docs/guides-references/hauler-content/images","91a"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/guides-references/manifests",component:d("/hauler-docs/docs/guides-references/manifests","aa3"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/guides-references/overview",component:d("/hauler-docs/docs/guides-references/overview","96b"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/guides-references/utilities/fileserver",component:d("/hauler-docs/docs/guides-references/utilities/fileserver","e21"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/guides-references/utilities/registry",component:d("/hauler-docs/docs/guides-references/utilities/registry","681"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/intro",component:d("/hauler-docs/docs/intro","b5a"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/introduction/install",component:d("/hauler-docs/docs/introduction/install","9be"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/introduction/quickstart",component:d("/hauler-docs/docs/introduction/quickstart","e7e"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/introduction/uninstall",component:d("/hauler-docs/docs/introduction/uninstall","f13"),exact:!0,sidebar:"haulerSidebar"},{path:"/hauler-docs/docs/known-limits",component:d("/hauler-docs/docs/known-limits","94d"),exact:!0,sidebar:"haulerSidebar"}]}]}]},{path:"/hauler-docs/",component:d("/hauler-docs/","331"),exact:!0},{path:"*",component:d("*")}]},6125:(e,t,n)=>{"use strict";n.d(t,{o:()=>a,x:()=>i});var r=n(6540),o=n(4848);const a=r.createContext(!1);function i(e){let{children:t}=e;const[n,i]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{i(!0)}),[]),(0,o.jsx)(a.Provider,{value:n,children:t})}},8536:(e,t,n)=>{"use strict";var r=n(6540),o=n(5338),a=n(4625),i=n(545),s=n(8193);const l=[n(119),n(6134),n(6294),n(1043)];var c=n(8328),u=n(6347),d=n(2831),f=n(4848);function p(e){let{children:t}=e;return(0,f.jsx)(f.Fragment,{children:t})}var h=n(5260),m=n(4586),g=n(6025),b=n(6342),v=n(1003),y=n(2131),w=n(4090),k=n(2967),x=n(440),S=n(1463);function _(){const{i18n:{currentLocale:e,defaultLocale:t,localeConfigs:n}}=(0,m.A)(),r=(0,y.o)(),o=n[e].htmlLang,a=e=>e.replace("-","_");return(0,f.jsxs)(h.A,{children:[Object.entries(n).map((e=>{let[t,{htmlLang:n}]=e;return(0,f.jsx)("link",{rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:n},t)})),(0,f.jsx)("link",{rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:"x-default"}),(0,f.jsx)("meta",{property:"og:locale",content:a(o)}),Object.values(n).filter((e=>o!==e.htmlLang)).map((e=>(0,f.jsx)("meta",{property:"og:locale:alternate",content:a(e.htmlLang)},`meta-og-${e.htmlLang}`)))]})}function E(e){let{permalink:t}=e;const{siteConfig:{url:n}}=(0,m.A)(),r=function(){const{siteConfig:{url:e,baseUrl:t,trailingSlash:n}}=(0,m.A)(),{pathname:r}=(0,u.zy)();return e+(0,x.applyTrailingSlash)((0,g.A)(r),{trailingSlash:n,baseUrl:t})}(),o=t?`${n}${t}`:r;return(0,f.jsxs)(h.A,{children:[(0,f.jsx)("meta",{property:"og:url",content:o}),(0,f.jsx)("link",{rel:"canonical",href:o})]})}function C(){const{i18n:{currentLocale:e}}=(0,m.A)(),{metadata:t,image:n}=(0,b.p)();return(0,f.jsxs)(f.Fragment,{children:[(0,f.jsxs)(h.A,{children:[(0,f.jsx)("meta",{name:"twitter:card",content:"summary_large_image"}),(0,f.jsx)("body",{className:w.w})]}),n&&(0,f.jsx)(v.be,{image:n}),(0,f.jsx)(E,{}),(0,f.jsx)(_,{}),(0,f.jsx)(S.A,{tag:k.Cy,locale:e}),(0,f.jsx)(h.A,{children:t.map(((e,t)=>(0,f.jsx)("meta",{...e},t)))})]})}const T=new Map;var A=n(6125),j=n(6988),N=n(205);function R(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),r=1;r{const r=t.default?.[e]??t[e];return r?.(...n)}));return()=>o.forEach((e=>e?.()))}const L=function(e){let{children:t,location:n,previousLocation:r}=e;return(0,N.A)((()=>{r!==n&&(!function(e){let{location:t,previousLocation:n}=e;if(!n)return;const r=t.pathname===n.pathname,o=t.hash===n.hash,a=t.search===n.search;if(r&&o&&!a)return;const{hash:i}=t;if(i){const e=decodeURIComponent(i.substring(1)),t=document.getElementById(e);t?.scrollIntoView()}else window.scrollTo(0,0)}({location:n,previousLocation:r}),R("onRouteDidUpdate",{previousLocation:r,location:n}))}),[r,n]),t};function P(e){const t=Array.from(new Set([e,decodeURI(e)])).map((e=>(0,d.u)(c.A,e))).flat();return Promise.all(t.map((e=>e.route.component.preload?.())))}class O extends r.Component{previousLocation;routeUpdateCleanupCb;constructor(e){super(e),this.previousLocation=null,this.routeUpdateCleanupCb=s.A.canUseDOM?R("onRouteUpdate",{previousLocation:null,location:this.props.location}):()=>{},this.state={nextRouteHasLoaded:!0}}shouldComponentUpdate(e,t){if(e.location===this.props.location)return t.nextRouteHasLoaded;const n=e.location;return this.previousLocation=this.props.location,this.setState({nextRouteHasLoaded:!1}),this.routeUpdateCleanupCb=R("onRouteUpdate",{previousLocation:this.previousLocation,location:n}),P(n.pathname).then((()=>{this.routeUpdateCleanupCb(),this.setState({nextRouteHasLoaded:!0})})).catch((e=>{console.warn(e),window.location.reload()})),!1}render(){const{children:e,location:t}=this.props;return(0,f.jsx)(L,{previousLocation:this.previousLocation,location:t,children:(0,f.jsx)(u.qh,{location:t,render:()=>e})})}}const I=O,D="__docusaurus-base-url-issue-banner-container",M="__docusaurus-base-url-issue-banner",F="__docusaurus-base-url-issue-banner-suggestion-container";function z(e){return`\ndocument.addEventListener('DOMContentLoaded', function maybeInsertBanner() {\n var shouldInsert = typeof window['docusaurus'] === 'undefined';\n shouldInsert && insertBanner();\n});\n\nfunction insertBanner() {\n var bannerContainer = document.createElement('div');\n bannerContainer.id = '${D}';\n var bannerHtml = ${JSON.stringify(function(e){return`\n
\n

Your Docusaurus site did not load properly.

\n

A very common reason is a wrong site baseUrl configuration.

\n

Current configured baseUrl = ${e} ${"/"===e?" (default value)":""}

\n

We suggest trying baseUrl =

\n
\n`}(e)).replace(/{let{route:t}=e;return!0===t.exact})))return T.set(e.pathname,e.pathname),e;const t=e.pathname.trim().replace(/(?:\/index)?\.html$/,"")||"/";return T.set(e.pathname,t),{...e,pathname:t}}((0,u.zy)());return(0,f.jsx)(I,{location:e,children:W})}function Q(){return(0,f.jsx)(q.A,{children:(0,f.jsx)(j.l,{children:(0,f.jsxs)(A.x,{children:[(0,f.jsxs)(p,{children:[(0,f.jsx)(U,{}),(0,f.jsx)(C,{}),(0,f.jsx)($,{}),(0,f.jsx)(V,{})]}),(0,f.jsx)(G,{})]})})})}var K=n(4054);const Y=function(e){try{return document.createElement("link").relList.supports(e)}catch{return!1}}("prefetch")?function(e){return new Promise(((t,n)=>{if("undefined"==typeof document)return void n();const r=document.createElement("link");r.setAttribute("rel","prefetch"),r.setAttribute("href",e),r.onload=()=>t(),r.onerror=()=>n();const o=document.getElementsByTagName("head")[0]??document.getElementsByName("script")[0]?.parentNode;o?.appendChild(r)}))}:function(e){return new Promise(((t,n)=>{const r=new XMLHttpRequest;r.open("GET",e,!0),r.withCredentials=!0,r.onload=()=>{200===r.status?t():n()},r.send(null)}))};var J=n(6921);const Z=new Set,X=new Set,ee=()=>navigator.connection?.effectiveType.includes("2g")||navigator.connection?.saveData,te={prefetch:e=>{if(!(e=>!ee()&&!X.has(e)&&!Z.has(e))(e))return!1;Z.add(e);const t=(0,d.u)(c.A,e).flatMap((e=>{return t=e.route.path,Object.entries(K).filter((e=>{let[n]=e;return n.replace(/-[^-]+$/,"")===t})).flatMap((e=>{let[,t]=e;return Object.values((0,J.A)(t))}));var t}));return Promise.all(t.map((e=>{const t=n.gca(e);return t&&!t.includes("undefined")?Y(t).catch((()=>{})):Promise.resolve()})))},preload:e=>!!(e=>!ee()&&!X.has(e))(e)&&(X.add(e),P(e))},ne=Object.freeze(te),re=Boolean(!0);if(s.A.canUseDOM){window.docusaurus=ne;const e=document.getElementById("__docusaurus"),t=(0,f.jsx)(i.vd,{children:(0,f.jsx)(a.Kd,{children:(0,f.jsx)(Q,{})})}),n=(e,t)=>{console.error("Docusaurus React Root onRecoverableError:",e,t)},s=()=>{if(window.docusaurusRoot)window.docusaurusRoot.render(t);else if(re)window.docusaurusRoot=o.hydrateRoot(e,t,{onRecoverableError:n});else{const r=o.createRoot(e,{onRecoverableError:n});r.render(t),window.docusaurusRoot=r}};P(window.location.pathname).then((()=>{(0,r.startTransition)(s)}))}},6988:(e,t,n)=>{"use strict";n.d(t,{o:()=>d,l:()=>f});var r=n(6540),o=n(4784);const a=JSON.parse('{"docusaurus-plugin-content-docs":{"default":{"path":"/hauler-docs/docs","versions":[{"name":"current","label":"Next \ud83d\udea7","isLast":false,"path":"/hauler-docs/docs/next","mainDocId":"intro","docs":[{"id":"airgap-workflow","path":"/hauler-docs/docs/next/airgap-workflow","sidebar":"haulerSidebar"},{"id":"core-concepts","path":"/hauler-docs/docs/next/core-concepts","sidebar":"haulerSidebar"},{"id":"feedback","path":"/hauler-docs/docs/next/feedback","sidebar":"haulerSidebar"},{"id":"guides-references/carbide-customers","path":"/hauler-docs/docs/next/guides-references/carbide-customers","sidebar":"haulerSidebar"},{"id":"guides-references/cluster-images","path":"/hauler-docs/docs/next/guides-references/cluster-images","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler","path":"/hauler-docs/docs/next/guides-references/command-line/hauler","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler-completion","path":"/hauler-docs/docs/next/guides-references/command-line/hauler-completion","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler-login","path":"/hauler-docs/docs/next/guides-references/command-line/hauler-login"},{"id":"guides-references/command-line/hauler-store","path":"/hauler-docs/docs/next/guides-references/command-line/hauler-store","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler-version","path":"/hauler-docs/docs/next/guides-references/command-line/hauler-version","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-collections/community-collections","path":"/hauler-docs/docs/next/guides-references/hauler-collections/community-collections","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/charts","path":"/hauler-docs/docs/next/guides-references/hauler-content/charts","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/files","path":"/hauler-docs/docs/next/guides-references/hauler-content/files","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/images","path":"/hauler-docs/docs/next/guides-references/hauler-content/images","sidebar":"haulerSidebar"},{"id":"guides-references/manifests","path":"/hauler-docs/docs/next/guides-references/manifests","sidebar":"haulerSidebar"},{"id":"guides-references/overview","path":"/hauler-docs/docs/next/guides-references/overview","sidebar":"haulerSidebar"},{"id":"guides-references/utilities/fileserver","path":"/hauler-docs/docs/next/guides-references/utilities/fileserver","sidebar":"haulerSidebar"},{"id":"guides-references/utilities/registry","path":"/hauler-docs/docs/next/guides-references/utilities/registry","sidebar":"haulerSidebar"},{"id":"intro","path":"/hauler-docs/docs/next/intro","sidebar":"haulerSidebar"},{"id":"introduction/install","path":"/hauler-docs/docs/next/introduction/install","sidebar":"haulerSidebar"},{"id":"introduction/quickstart","path":"/hauler-docs/docs/next/introduction/quickstart","sidebar":"haulerSidebar"},{"id":"introduction/uninstall","path":"/hauler-docs/docs/next/introduction/uninstall","sidebar":"haulerSidebar"},{"id":"known-limits","path":"/hauler-docs/docs/next/known-limits","sidebar":"haulerSidebar"}],"draftIds":[],"sidebars":{"haulerSidebar":{"link":{"path":"/hauler-docs/docs/next/intro","label":"intro"}}}},{"name":"1.0.x","label":"1.0.x","isLast":true,"path":"/hauler-docs/docs","mainDocId":"intro","docs":[{"id":"airgap-workflow","path":"/hauler-docs/docs/airgap-workflow","sidebar":"haulerSidebar"},{"id":"core-concepts","path":"/hauler-docs/docs/core-concepts","sidebar":"haulerSidebar"},{"id":"feedback","path":"/hauler-docs/docs/feedback","sidebar":"haulerSidebar"},{"id":"guides-references/carbide-customers","path":"/hauler-docs/docs/guides-references/carbide-customers","sidebar":"haulerSidebar"},{"id":"guides-references/cluster-images","path":"/hauler-docs/docs/guides-references/cluster-images","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler","path":"/hauler-docs/docs/guides-references/command-line/hauler","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler-completion","path":"/hauler-docs/docs/guides-references/command-line/hauler-completion","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler-login","path":"/hauler-docs/docs/guides-references/command-line/hauler-login"},{"id":"guides-references/command-line/hauler-store","path":"/hauler-docs/docs/guides-references/command-line/hauler-store","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler-version","path":"/hauler-docs/docs/guides-references/command-line/hauler-version","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-collections/community-collections","path":"/hauler-docs/docs/guides-references/hauler-collections/community-collections","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/charts","path":"/hauler-docs/docs/guides-references/hauler-content/charts","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/files","path":"/hauler-docs/docs/guides-references/hauler-content/files","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/images","path":"/hauler-docs/docs/guides-references/hauler-content/images","sidebar":"haulerSidebar"},{"id":"guides-references/manifests","path":"/hauler-docs/docs/guides-references/manifests","sidebar":"haulerSidebar"},{"id":"guides-references/overview","path":"/hauler-docs/docs/guides-references/overview","sidebar":"haulerSidebar"},{"id":"guides-references/utilities/fileserver","path":"/hauler-docs/docs/guides-references/utilities/fileserver","sidebar":"haulerSidebar"},{"id":"guides-references/utilities/registry","path":"/hauler-docs/docs/guides-references/utilities/registry","sidebar":"haulerSidebar"},{"id":"intro","path":"/hauler-docs/docs/intro","sidebar":"haulerSidebar"},{"id":"introduction/install","path":"/hauler-docs/docs/introduction/install","sidebar":"haulerSidebar"},{"id":"introduction/quickstart","path":"/hauler-docs/docs/introduction/quickstart","sidebar":"haulerSidebar"},{"id":"introduction/uninstall","path":"/hauler-docs/docs/introduction/uninstall","sidebar":"haulerSidebar"},{"id":"known-limits","path":"/hauler-docs/docs/known-limits","sidebar":"haulerSidebar"}],"draftIds":[],"sidebars":{"haulerSidebar":{"link":{"path":"/hauler-docs/docs/intro","label":"intro"}}}},{"name":"1.0.0","label":"1.0.0","isLast":false,"path":"/hauler-docs/docs/1.0.0","mainDocId":"intro","docs":[{"id":"airgap-workflow","path":"/hauler-docs/docs/1.0.0/airgap-workflow","sidebar":"haulerSidebar"},{"id":"core-concepts","path":"/hauler-docs/docs/1.0.0/core-concepts","sidebar":"haulerSidebar"},{"id":"feedback","path":"/hauler-docs/docs/1.0.0/feedback","sidebar":"haulerSidebar"},{"id":"guides-references/carbide-customers","path":"/hauler-docs/docs/1.0.0/guides-references/carbide-customers","sidebar":"haulerSidebar"},{"id":"guides-references/cluster-images","path":"/hauler-docs/docs/1.0.0/guides-references/cluster-images","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler","path":"/hauler-docs/docs/1.0.0/guides-references/command-line/hauler","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler-completion","path":"/hauler-docs/docs/1.0.0/guides-references/command-line/hauler-completion","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler-store","path":"/hauler-docs/docs/1.0.0/guides-references/command-line/hauler-store","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler-version","path":"/hauler-docs/docs/1.0.0/guides-references/command-line/hauler-version","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-collections/community-collections","path":"/hauler-docs/docs/1.0.0/guides-references/hauler-collections/community-collections","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/charts","path":"/hauler-docs/docs/1.0.0/guides-references/hauler-content/charts","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/files","path":"/hauler-docs/docs/1.0.0/guides-references/hauler-content/files","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/images","path":"/hauler-docs/docs/1.0.0/guides-references/hauler-content/images","sidebar":"haulerSidebar"},{"id":"guides-references/manifests","path":"/hauler-docs/docs/1.0.0/guides-references/manifests","sidebar":"haulerSidebar"},{"id":"guides-references/overview","path":"/hauler-docs/docs/1.0.0/guides-references/overview","sidebar":"haulerSidebar"},{"id":"intro","path":"/hauler-docs/docs/1.0.0/intro","sidebar":"haulerSidebar"},{"id":"introduction/install","path":"/hauler-docs/docs/1.0.0/introduction/install","sidebar":"haulerSidebar"},{"id":"introduction/quickstart","path":"/hauler-docs/docs/1.0.0/introduction/quickstart","sidebar":"haulerSidebar"},{"id":"introduction/uninstall","path":"/hauler-docs/docs/1.0.0/introduction/uninstall","sidebar":"haulerSidebar"},{"id":"known-limits","path":"/hauler-docs/docs/1.0.0/known-limits","sidebar":"haulerSidebar"}],"draftIds":[],"sidebars":{"haulerSidebar":{"link":{"path":"/hauler-docs/docs/1.0.0/intro","label":"intro"}}}},{"name":"0.4.4","label":"0.4.4","isLast":false,"path":"/hauler-docs/docs/0.4.4","mainDocId":"intro","docs":[{"id":"airgap-workflow","path":"/hauler-docs/docs/0.4.4/airgap-workflow","sidebar":"haulerSidebar"},{"id":"core-concepts","path":"/hauler-docs/docs/0.4.4/core-concepts","sidebar":"haulerSidebar"},{"id":"guides-references/carbide-customers","path":"/hauler-docs/docs/0.4.4/guides-references/carbide-customers","sidebar":"haulerSidebar"},{"id":"guides-references/cluster-images","path":"/hauler-docs/docs/0.4.4/guides-references/cluster-images","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler","path":"/hauler-docs/docs/0.4.4/guides-references/command-line/hauler","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler-completion","path":"/hauler-docs/docs/0.4.4/guides-references/command-line/hauler-completion","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler-store","path":"/hauler-docs/docs/0.4.4/guides-references/command-line/hauler-store","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler-version","path":"/hauler-docs/docs/0.4.4/guides-references/command-line/hauler-version","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-collections/overview","path":"/hauler-docs/docs/0.4.4/guides-references/hauler-collections/overview","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/charts","path":"/hauler-docs/docs/0.4.4/guides-references/hauler-content/charts","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/files","path":"/hauler-docs/docs/0.4.4/guides-references/hauler-content/files","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/images","path":"/hauler-docs/docs/0.4.4/guides-references/hauler-content/images","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/overview","path":"/hauler-docs/docs/0.4.4/guides-references/hauler-content/overview","sidebar":"haulerSidebar"},{"id":"guides-references/overview","path":"/hauler-docs/docs/0.4.4/guides-references/overview","sidebar":"haulerSidebar"},{"id":"intro","path":"/hauler-docs/docs/0.4.4/intro","sidebar":"haulerSidebar"},{"id":"introduction/install","path":"/hauler-docs/docs/0.4.4/introduction/install","sidebar":"haulerSidebar"},{"id":"introduction/quickstart","path":"/hauler-docs/docs/0.4.4/introduction/quickstart","sidebar":"haulerSidebar"},{"id":"introduction/uninstall","path":"/hauler-docs/docs/0.4.4/introduction/uninstall","sidebar":"haulerSidebar"},{"id":"known-limits","path":"/hauler-docs/docs/0.4.4/known-limits","sidebar":"haulerSidebar"}],"draftIds":[],"sidebars":{"haulerSidebar":{"link":{"path":"/hauler-docs/docs/0.4.4/intro","label":"intro"}}}},{"name":"0.4.3","label":"0.4.3","isLast":false,"path":"/hauler-docs/docs/0.4.3","mainDocId":"intro","docs":[{"id":"airgap-workflow","path":"/hauler-docs/docs/0.4.3/airgap-workflow","sidebar":"haulerSidebar"},{"id":"core-concepts","path":"/hauler-docs/docs/0.4.3/core-concepts","sidebar":"haulerSidebar"},{"id":"guides-references/carbide-customers","path":"/hauler-docs/docs/0.4.3/guides-references/carbide-customers","sidebar":"haulerSidebar"},{"id":"guides-references/cluster-images","path":"/hauler-docs/docs/0.4.3/guides-references/cluster-images","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler","path":"/hauler-docs/docs/0.4.3/guides-references/command-line/hauler","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler-completion","path":"/hauler-docs/docs/0.4.3/guides-references/command-line/hauler-completion","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler-store","path":"/hauler-docs/docs/0.4.3/guides-references/command-line/hauler-store","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler-version","path":"/hauler-docs/docs/0.4.3/guides-references/command-line/hauler-version","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-collections/overview","path":"/hauler-docs/docs/0.4.3/guides-references/hauler-collections/overview","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/charts","path":"/hauler-docs/docs/0.4.3/guides-references/hauler-content/charts","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/files","path":"/hauler-docs/docs/0.4.3/guides-references/hauler-content/files","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/images","path":"/hauler-docs/docs/0.4.3/guides-references/hauler-content/images","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/overview","path":"/hauler-docs/docs/0.4.3/guides-references/hauler-content/overview","sidebar":"haulerSidebar"},{"id":"guides-references/overview","path":"/hauler-docs/docs/0.4.3/guides-references/overview","sidebar":"haulerSidebar"},{"id":"intro","path":"/hauler-docs/docs/0.4.3/intro","sidebar":"haulerSidebar"},{"id":"introduction/install","path":"/hauler-docs/docs/0.4.3/introduction/install","sidebar":"haulerSidebar"},{"id":"introduction/quickstart","path":"/hauler-docs/docs/0.4.3/introduction/quickstart","sidebar":"haulerSidebar"},{"id":"introduction/uninstall","path":"/hauler-docs/docs/0.4.3/introduction/uninstall","sidebar":"haulerSidebar"},{"id":"known-limits","path":"/hauler-docs/docs/0.4.3/known-limits","sidebar":"haulerSidebar"}],"draftIds":[],"sidebars":{"haulerSidebar":{"link":{"path":"/hauler-docs/docs/0.4.3/intro","label":"intro"}}}},{"name":"0.4.2","label":"0.4.2","isLast":false,"path":"/hauler-docs/docs/0.4.2","mainDocId":"intro","docs":[{"id":"airgap-workflow","path":"/hauler-docs/docs/0.4.2/airgap-workflow","sidebar":"haulerSidebar"},{"id":"core-concepts","path":"/hauler-docs/docs/0.4.2/core-concepts","sidebar":"haulerSidebar"},{"id":"guides-references/carbide-customers","path":"/hauler-docs/docs/0.4.2/guides-references/carbide-customers","sidebar":"haulerSidebar"},{"id":"guides-references/cluster-images","path":"/hauler-docs/docs/0.4.2/guides-references/cluster-images","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler","path":"/hauler-docs/docs/0.4.2/guides-references/command-line/hauler","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler-completion","path":"/hauler-docs/docs/0.4.2/guides-references/command-line/hauler-completion","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler-store","path":"/hauler-docs/docs/0.4.2/guides-references/command-line/hauler-store","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler-version","path":"/hauler-docs/docs/0.4.2/guides-references/command-line/hauler-version","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-collections/overview","path":"/hauler-docs/docs/0.4.2/guides-references/hauler-collections/overview","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/charts","path":"/hauler-docs/docs/0.4.2/guides-references/hauler-content/charts","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/files","path":"/hauler-docs/docs/0.4.2/guides-references/hauler-content/files","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/images","path":"/hauler-docs/docs/0.4.2/guides-references/hauler-content/images","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/overview","path":"/hauler-docs/docs/0.4.2/guides-references/hauler-content/overview","sidebar":"haulerSidebar"},{"id":"guides-references/overview","path":"/hauler-docs/docs/0.4.2/guides-references/overview","sidebar":"haulerSidebar"},{"id":"intro","path":"/hauler-docs/docs/0.4.2/intro","sidebar":"haulerSidebar"},{"id":"introduction/install","path":"/hauler-docs/docs/0.4.2/introduction/install","sidebar":"haulerSidebar"},{"id":"introduction/quickstart","path":"/hauler-docs/docs/0.4.2/introduction/quickstart","sidebar":"haulerSidebar"},{"id":"introduction/uninstall","path":"/hauler-docs/docs/0.4.2/introduction/uninstall","sidebar":"haulerSidebar"},{"id":"known-limits","path":"/hauler-docs/docs/0.4.2/known-limits","sidebar":"haulerSidebar"}],"draftIds":[],"sidebars":{"haulerSidebar":{"link":{"path":"/hauler-docs/docs/0.4.2/intro","label":"intro"}}}},{"name":"0.4.1","label":"0.4.1","isLast":false,"path":"/hauler-docs/docs/0.4.1","mainDocId":"intro","docs":[{"id":"airgap-workflow","path":"/hauler-docs/docs/0.4.1/airgap-workflow","sidebar":"haulerSidebar"},{"id":"core-concepts","path":"/hauler-docs/docs/0.4.1/core-concepts","sidebar":"haulerSidebar"},{"id":"guides-references/cluster-images","path":"/hauler-docs/docs/0.4.1/guides-references/cluster-images","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler","path":"/hauler-docs/docs/0.4.1/guides-references/command-line/hauler","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler-completion","path":"/hauler-docs/docs/0.4.1/guides-references/command-line/hauler-completion","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler-store","path":"/hauler-docs/docs/0.4.1/guides-references/command-line/hauler-store","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler-version","path":"/hauler-docs/docs/0.4.1/guides-references/command-line/hauler-version","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-collections/overview","path":"/hauler-docs/docs/0.4.1/guides-references/hauler-collections/overview","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/charts","path":"/hauler-docs/docs/0.4.1/guides-references/hauler-content/charts","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/files","path":"/hauler-docs/docs/0.4.1/guides-references/hauler-content/files","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/images","path":"/hauler-docs/docs/0.4.1/guides-references/hauler-content/images","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/overview","path":"/hauler-docs/docs/0.4.1/guides-references/hauler-content/overview","sidebar":"haulerSidebar"},{"id":"guides-references/overview","path":"/hauler-docs/docs/0.4.1/guides-references/overview","sidebar":"haulerSidebar"},{"id":"intro","path":"/hauler-docs/docs/0.4.1/intro","sidebar":"haulerSidebar"},{"id":"introduction/install","path":"/hauler-docs/docs/0.4.1/introduction/install","sidebar":"haulerSidebar"},{"id":"introduction/quickstart","path":"/hauler-docs/docs/0.4.1/introduction/quickstart","sidebar":"haulerSidebar"},{"id":"introduction/uninstall","path":"/hauler-docs/docs/0.4.1/introduction/uninstall","sidebar":"haulerSidebar"},{"id":"known-limits","path":"/hauler-docs/docs/0.4.1/known-limits","sidebar":"haulerSidebar"}],"draftIds":[],"sidebars":{"haulerSidebar":{"link":{"path":"/hauler-docs/docs/0.4.1/intro","label":"intro"}}}},{"name":"0.4.0","label":"0.4.0","isLast":false,"path":"/hauler-docs/docs/0.4.0","mainDocId":"intro","docs":[{"id":"airgap-workflow","path":"/hauler-docs/docs/0.4.0/airgap-workflow","sidebar":"haulerSidebar"},{"id":"core-concepts","path":"/hauler-docs/docs/0.4.0/core-concepts","sidebar":"haulerSidebar"},{"id":"guides-references/cluster-images","path":"/hauler-docs/docs/0.4.0/guides-references/cluster-images","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler","path":"/hauler-docs/docs/0.4.0/guides-references/command-line/hauler","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler-completion","path":"/hauler-docs/docs/0.4.0/guides-references/command-line/hauler-completion","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler-store","path":"/hauler-docs/docs/0.4.0/guides-references/command-line/hauler-store","sidebar":"haulerSidebar"},{"id":"guides-references/command-line/hauler-version","path":"/hauler-docs/docs/0.4.0/guides-references/command-line/hauler-version","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-collections/overview","path":"/hauler-docs/docs/0.4.0/guides-references/hauler-collections/overview","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/charts","path":"/hauler-docs/docs/0.4.0/guides-references/hauler-content/charts","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/files","path":"/hauler-docs/docs/0.4.0/guides-references/hauler-content/files","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/images","path":"/hauler-docs/docs/0.4.0/guides-references/hauler-content/images","sidebar":"haulerSidebar"},{"id":"guides-references/hauler-content/overview","path":"/hauler-docs/docs/0.4.0/guides-references/hauler-content/overview","sidebar":"haulerSidebar"},{"id":"guides-references/overview","path":"/hauler-docs/docs/0.4.0/guides-references/overview","sidebar":"haulerSidebar"},{"id":"intro","path":"/hauler-docs/docs/0.4.0/intro","sidebar":"haulerSidebar"},{"id":"introduction/install","path":"/hauler-docs/docs/0.4.0/introduction/install","sidebar":"haulerSidebar"},{"id":"introduction/quickstart","path":"/hauler-docs/docs/0.4.0/introduction/quickstart","sidebar":"haulerSidebar"},{"id":"introduction/uninstall","path":"/hauler-docs/docs/0.4.0/introduction/uninstall","sidebar":"haulerSidebar"},{"id":"known-limits","path":"/hauler-docs/docs/0.4.0/known-limits","sidebar":"haulerSidebar"}],"draftIds":[],"sidebars":{"haulerSidebar":{"link":{"path":"/hauler-docs/docs/0.4.0/intro","label":"intro"}}}}],"breadcrumbs":true}},"docusaurus-lunr-search":{"default":{"fileNames":{"searchDoc":"search-doc-1723747040371.json","lunrIndex":"lunr-index-1723747040371.json"}}}}'),i=JSON.parse('{"defaultLocale":"en","locales":["en"],"path":"i18n","currentLocale":"en","localeConfigs":{"en":{"label":"English","direction":"ltr","htmlLang":"en","calendar":"gregory","path":"en"}}}');var s=n(2654);const l=JSON.parse('{"docusaurusVersion":"3.3.2","siteVersion":"1.0.x","pluginVersions":{"docusaurus-plugin-content-docs":{"type":"package","name":"@docusaurus/plugin-content-docs","version":"3.3.2"},"docusaurus-plugin-content-blog":{"type":"package","name":"@docusaurus/plugin-content-blog","version":"3.3.2"},"docusaurus-plugin-content-pages":{"type":"package","name":"@docusaurus/plugin-content-pages","version":"3.3.2"},"docusaurus-plugin-sitemap":{"type":"package","name":"@docusaurus/plugin-sitemap","version":"3.3.2"},"docusaurus-theme-classic":{"type":"package","name":"@docusaurus/theme-classic","version":"3.3.2"},"docusaurus-lunr-search":{"type":"package","name":"docusaurus-lunr-search","version":"3.3.2"}}}');var c=n(4848);const u={siteConfig:o.default,siteMetadata:l,globalData:a,i18n:i,codeTranslations:s},d=r.createContext(u);function f(e){let{children:t}=e;return(0,c.jsx)(d.Provider,{value:u,children:t})}},7489:(e,t,n)=>{"use strict";n.d(t,{A:()=>m});var r=n(6540),o=n(8193),a=n(5260),i=n(440),s=n(7907),l=n(3102),c=n(4848);function u(e){let{error:t,tryAgain:n}=e;return(0,c.jsxs)("div",{style:{display:"flex",flexDirection:"column",justifyContent:"center",alignItems:"flex-start",minHeight:"100vh",width:"100%",maxWidth:"80ch",fontSize:"20px",margin:"0 auto",padding:"1rem"},children:[(0,c.jsx)("h1",{style:{fontSize:"3rem"},children:"This page crashed"}),(0,c.jsx)("button",{type:"button",onClick:n,style:{margin:"1rem 0",fontSize:"2rem",cursor:"pointer",borderRadius:20,padding:"1rem"},children:"Try again"}),(0,c.jsx)(d,{error:t})]})}function d(e){let{error:t}=e;const n=(0,i.getErrorCausalChain)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,c.jsx)("p",{style:{whiteSpace:"pre-wrap"},children:n})}function f(e){let{children:t}=e;return(0,c.jsx)(l.W,{value:{plugin:{name:"docusaurus-core-error-boundary",id:"default"}},children:t})}function p(e){let{error:t,tryAgain:n}=e;return(0,c.jsx)(f,{children:(0,c.jsxs)(m,{fallback:()=>(0,c.jsx)(u,{error:t,tryAgain:n}),children:[(0,c.jsx)(a.A,{children:(0,c.jsx)("title",{children:"Page Error"})}),(0,c.jsx)(s.A,{children:(0,c.jsx)(u,{error:t,tryAgain:n})})]})})}const h=e=>(0,c.jsx)(p,{...e});class m extends r.Component{constructor(e){super(e),this.state={error:null}}componentDidCatch(e){o.A.canUseDOM&&this.setState({error:e})}render(){const{children:e}=this.props,{error:t}=this.state;if(t){const e={error:t,tryAgain:()=>this.setState({error:null})};return(this.props.fallback??h)(e)}return e??null}}},8193:(e,t,n)=>{"use strict";n.d(t,{A:()=>o});const r="undefined"!=typeof window&&"document"in window&&"createElement"in window.document,o={canUseDOM:r,canUseEventListeners:r&&("addEventListener"in window||"attachEvent"in window),canUseIntersectionObserver:r&&"IntersectionObserver"in window,canUseViewport:r&&"screen"in window}},5260:(e,t,n)=>{"use strict";n.d(t,{A:()=>a});n(6540);var r=n(545),o=n(4848);function a(e){return(0,o.jsx)(r.mg,{...e})}},8774:(e,t,n)=>{"use strict";n.d(t,{A:()=>p});var r=n(6540),o=n(4625),a=n(440),i=n(4586),s=n(6654),l=n(8193),c=n(3427),u=n(6025),d=n(4848);function f(e,t){let{isNavLink:n,to:f,href:p,activeClassName:h,isActive:m,"data-noBrokenLinkCheck":g,autoAddBaseUrl:b=!0,...v}=e;const{siteConfig:{trailingSlash:y,baseUrl:w}}=(0,i.A)(),{withBaseUrl:k}=(0,u.h)(),x=(0,c.A)(),S=(0,r.useRef)(null);(0,r.useImperativeHandle)(t,(()=>S.current));const _=f||p;const E=(0,s.A)(_),C=_?.replace("pathname://","");let T=void 0!==C?(A=C,b&&(e=>e.startsWith("/"))(A)?k(A):A):void 0;var A;T&&E&&(T=(0,a.applyTrailingSlash)(T,{trailingSlash:y,baseUrl:w}));const j=(0,r.useRef)(!1),N=n?o.k2:o.N_,R=l.A.canUseIntersectionObserver,L=(0,r.useRef)(),P=()=>{j.current||null==T||(window.docusaurus.preload(T),j.current=!0)};(0,r.useEffect)((()=>(!R&&E&&null!=T&&window.docusaurus.prefetch(T),()=>{R&&L.current&&L.current.disconnect()})),[L,T,R,E]);const O=T?.startsWith("#")??!1,I=!v.target||"_self"===v.target,D=!T||!E||!I||O;return g||!O&&D||x.collectLink(T),v.id&&x.collectAnchor(v.id),D?(0,d.jsx)("a",{ref:S,href:T,..._&&!E&&{target:"_blank",rel:"noopener noreferrer"},...v}):(0,d.jsx)(N,{...v,onMouseEnter:P,onTouchStart:P,innerRef:e=>{S.current=e,R&&e&&E&&(L.current=new window.IntersectionObserver((t=>{t.forEach((t=>{e===t.target&&(t.isIntersecting||t.intersectionRatio>0)&&(L.current.unobserve(e),L.current.disconnect(),null!=T&&window.docusaurus.prefetch(T))}))})),L.current.observe(e))},to:T,...n&&{isActive:m,activeClassName:h}})}const p=r.forwardRef(f)},1312:(e,t,n)=>{"use strict";n.d(t,{A:()=>c,T:()=>l});var r=n(6540),o=n(4848);function a(e,t){const n=e.split(/(\{\w+\})/).map(((e,n)=>{if(n%2==1){const n=t?.[e.slice(1,-1)];if(void 0!==n)return n}return e}));return n.some((e=>(0,r.isValidElement)(e)))?n.map(((e,t)=>(0,r.isValidElement)(e)?r.cloneElement(e,{key:t}):e)).filter((e=>""!==e)):n.join("")}var i=n(2654);function s(e){let{id:t,message:n}=e;if(void 0===t&&void 0===n)throw new Error("Docusaurus translation declarations must have at least a translation id or a default translation message");return i[t??n]??n??t}function l(e,t){let{message:n,id:r}=e;return a(s({message:n,id:r}),t)}function c(e){let{children:t,id:n,values:r}=e;if(t&&"string"!=typeof t)throw console.warn("Illegal children",t),new Error("The Docusaurus component only accept simple string values");const i=s({message:t,id:n});return(0,o.jsx)(o.Fragment,{children:a(i,r)})}},7065:(e,t,n)=>{"use strict";n.d(t,{W:()=>r});const r="default"},6654:(e,t,n)=>{"use strict";function r(e){return/^(?:\w*:|\/\/)/.test(e)}function o(e){return void 0!==e&&!r(e)}n.d(t,{A:()=>o,z:()=>r})},6025:(e,t,n)=>{"use strict";n.d(t,{A:()=>s,h:()=>i});var r=n(6540),o=n(4586),a=n(6654);function i(){const{siteConfig:{baseUrl:e,url:t}}=(0,o.A)(),n=(0,r.useCallback)(((n,r)=>function(e,t,n,r){let{forcePrependBaseUrl:o=!1,absolute:i=!1}=void 0===r?{}:r;if(!n||n.startsWith("#")||(0,a.z)(n))return n;if(o)return t+n.replace(/^\//,"");if(n===t.replace(/\/$/,""))return t;const s=n.startsWith(t)?n:t+n.replace(/^\//,"");return i?e+s:s}(t,e,n,r)),[t,e]);return{withBaseUrl:n}}function s(e,t){void 0===t&&(t={});const{withBaseUrl:n}=i();return n(e,t)}},3427:(e,t,n)=>{"use strict";n.d(t,{A:()=>i});var r=n(6540);n(4848);const o=r.createContext({collectAnchor:()=>{},collectLink:()=>{}}),a=()=>(0,r.useContext)(o);function i(){return a()}},4586:(e,t,n)=>{"use strict";n.d(t,{A:()=>a});var r=n(6540),o=n(6988);function a(){return(0,r.useContext)(o.o)}},6588:(e,t,n)=>{"use strict";n.d(t,{P_:()=>i,kh:()=>a});var r=n(4586),o=n(7065);function a(e,t){void 0===t&&(t={});const n=function(){const{globalData:e}=(0,r.A)();return e}()[e];if(!n&&t.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin.`);return n}function i(e,t,n){void 0===t&&(t=o.W),void 0===n&&(n={});const r=a(e),i=r?.[t];if(!i&&n.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin with id "${t}".`);return i}},2303:(e,t,n)=>{"use strict";n.d(t,{A:()=>a});var r=n(6540),o=n(6125);function a(){return(0,r.useContext)(o.o)}},205:(e,t,n)=>{"use strict";n.d(t,{A:()=>o});var r=n(6540);const o=n(8193).A.canUseDOM?r.useLayoutEffect:r.useEffect},6921:(e,t,n)=>{"use strict";n.d(t,{A:()=>o});const r=e=>"object"==typeof e&&!!e&&Object.keys(e).length>0;function o(e){const t={};return function e(n,o){Object.entries(n).forEach((n=>{let[a,i]=n;const s=o?`${o}.${a}`:a;r(i)?e(i,s):t[s]=i}))}(e),t}},3102:(e,t,n)=>{"use strict";n.d(t,{W:()=>i,o:()=>a});var r=n(6540),o=n(4848);const a=r.createContext(null);function i(e){let{children:t,value:n}=e;const i=r.useContext(a),s=(0,r.useMemo)((()=>function(e){let{parent:t,value:n}=e;if(!t){if(!n)throw new Error("Unexpected: no Docusaurus route context found");if(!("plugin"in n))throw new Error("Unexpected: Docusaurus topmost route context has no `plugin` attribute");return n}const r={...t.data,...n?.data};return{plugin:t.plugin,data:r}}({parent:i,value:n})),[i,n]);return(0,o.jsx)(a.Provider,{value:s,children:t})}},8295:(e,t,n)=>{"use strict";n.d(t,{zK:()=>p,vT:()=>u,Gy:()=>l,HW:()=>h,ht:()=>c,r7:()=>f,jh:()=>d});var r=n(6347),o=n(6588);const a=e=>e.versions.find((e=>e.isLast));function i(e,t){const n=function(e,t){const n=a(e);return[...e.versions.filter((e=>e!==n)),n].find((e=>!!(0,r.B6)(t,{path:e.path,exact:!1,strict:!1})))}(e,t),o=n?.docs.find((e=>!!(0,r.B6)(t,{path:e.path,exact:!0,strict:!1})));return{activeVersion:n,activeDoc:o,alternateDocVersions:o?function(t){const n={};return e.versions.forEach((e=>{e.docs.forEach((r=>{r.id===t&&(n[e.name]=r)}))})),n}(o.id):{}}}const s={},l=()=>(0,o.kh)("docusaurus-plugin-content-docs")??s,c=e=>{try{return(0,o.P_)("docusaurus-plugin-content-docs",e,{failfast:!0})}catch(t){throw new Error("You are using a feature of the Docusaurus docs plugin, but this plugin does not seem to be enabled"+("Default"===e?"":` (pluginId=${e}`),{cause:t})}};function u(e){void 0===e&&(e={});const t=l(),{pathname:n}=(0,r.zy)();return function(e,t,n){void 0===n&&(n={});const o=Object.entries(e).sort(((e,t)=>t[1].path.localeCompare(e[1].path))).find((e=>{let[,n]=e;return!!(0,r.B6)(t,{path:n.path,exact:!1,strict:!1})})),a=o?{pluginId:o[0],pluginData:o[1]}:void 0;if(!a&&n.failfast)throw new Error(`Can't find active docs plugin for "${t}" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: ${Object.values(e).map((e=>e.path)).join(", ")}`);return a}(t,n,e)}function d(e){return c(e).versions}function f(e){const t=c(e);return a(t)}function p(e){const t=c(e),{pathname:n}=(0,r.zy)();return i(t,n)}function h(e){const t=c(e),{pathname:n}=(0,r.zy)();return function(e,t){const n=a(e);return{latestDocSuggestion:i(e,t).alternateDocVersions[n.name],latestVersionSuggestion:n}}(t,n)}},6294:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>a});var r=n(5947),o=n.n(r);o().configure({showSpinner:!1});const a={onRouteUpdate(e){let{location:t,previousLocation:n}=e;if(n&&t.pathname!==n.pathname){const e=window.setTimeout((()=>{o().start()}),200);return()=>window.clearTimeout(e)}},onRouteDidUpdate(){o().done()}}},6134:(e,t,n)=>{"use strict";n.r(t);var r=n(1765),o=n(4784);!function(e){const{themeConfig:{prism:t}}=o.default,{additionalLanguages:r}=t;globalThis.Prism=e,r.forEach((e=>{"php"===e&&n(9700),n(8692)(`./prism-${e}`)})),delete globalThis.Prism}(r.My)},1107:(e,t,n)=>{"use strict";n.d(t,{A:()=>u});n(6540);var r=n(4164),o=n(1312),a=n(6342),i=n(8774),s=n(3427);const l={anchorWithStickyNavbar:"anchorWithStickyNavbar_LWe7",anchorWithHideOnScrollNavbar:"anchorWithHideOnScrollNavbar_WYt5"};var c=n(4848);function u(e){let{as:t,id:n,...u}=e;const d=(0,s.A)(),{navbar:{hideOnScroll:f}}=(0,a.p)();if("h1"===t||!n)return(0,c.jsx)(t,{...u,id:void 0});d.collectAnchor(n);const p=(0,o.T)({id:"theme.common.headingLinkTitle",message:"Direct link to {heading}",description:"Title for link to heading"},{heading:"string"==typeof u.children?u.children:n});return(0,c.jsxs)(t,{...u,className:(0,r.A)("anchor",f?l.anchorWithHideOnScrollNavbar:l.anchorWithStickyNavbar,u.className),id:n,children:[u.children,(0,c.jsx)(i.A,{className:"hash-link",to:`#${n}`,"aria-label":p,title:p,children:"\u200b"})]})}},3186:(e,t,n)=>{"use strict";n.d(t,{A:()=>a});n(6540);const r={iconExternalLink:"iconExternalLink_nPIU"};var o=n(4848);function a(e){let{width:t=13.5,height:n=13.5}=e;return(0,o.jsx)("svg",{width:t,height:n,"aria-hidden":"true",viewBox:"0 0 24 24",className:r.iconExternalLink,children:(0,o.jsx)("path",{fill:"currentColor",d:"M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"})})}},7907:(e,t,n)=>{"use strict";n.d(t,{A:()=>yt});var r=n(6540),o=n(4164),a=n(7489),i=n(1003),s=n(6347),l=n(1312),c=n(5062),u=n(4848);const d="__docusaurus_skipToContent_fallback";function f(e){e.setAttribute("tabindex","-1"),e.focus(),e.removeAttribute("tabindex")}function p(){const e=(0,r.useRef)(null),{action:t}=(0,s.W6)(),n=(0,r.useCallback)((e=>{e.preventDefault();const t=document.querySelector("main:first-of-type")??document.getElementById(d);t&&f(t)}),[]);return(0,c.$)((n=>{let{location:r}=n;e.current&&!r.hash&&"PUSH"===t&&f(e.current)})),{containerRef:e,onClick:n}}const h=(0,l.T)({id:"theme.common.skipToMainContent",description:"The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation",message:"Skip to main content"});function m(e){const t=e.children??h,{containerRef:n,onClick:r}=p();return(0,u.jsx)("div",{ref:n,role:"region","aria-label":h,children:(0,u.jsx)("a",{...e,href:`#${d}`,onClick:r,children:t})})}var g=n(7559),b=n(4090);const v={skipToContent:"skipToContent_fXgn"};function y(){return(0,u.jsx)(m,{className:v.skipToContent})}var w=n(6342),k=n(5041);function x(e){let{width:t=21,height:n=21,color:r="currentColor",strokeWidth:o=1.2,className:a,...i}=e;return(0,u.jsx)("svg",{viewBox:"0 0 15 15",width:t,height:n,...i,children:(0,u.jsx)("g",{stroke:r,strokeWidth:o,children:(0,u.jsx)("path",{d:"M.75.75l13.5 13.5M14.25.75L.75 14.25"})})})}const S={closeButton:"closeButton_CVFx"};function _(e){return(0,u.jsx)("button",{type:"button","aria-label":(0,l.T)({id:"theme.AnnouncementBar.closeButtonAriaLabel",message:"Close",description:"The ARIA label for close button of announcement bar"}),...e,className:(0,o.A)("clean-btn close",S.closeButton,e.className),children:(0,u.jsx)(x,{width:14,height:14,strokeWidth:3.1})})}const E={content:"content_knG7"};function C(e){const{announcementBar:t}=(0,w.p)(),{content:n}=t;return(0,u.jsx)("div",{...e,className:(0,o.A)(E.content,e.className),dangerouslySetInnerHTML:{__html:n}})}const T={announcementBar:"announcementBar_mb4j",announcementBarPlaceholder:"announcementBarPlaceholder_vyr4",announcementBarClose:"announcementBarClose_gvF7",announcementBarContent:"announcementBarContent_xLdY"};function A(){const{announcementBar:e}=(0,w.p)(),{isActive:t,close:n}=(0,k.Mj)();if(!t)return null;const{backgroundColor:r,textColor:o,isCloseable:a}=e;return(0,u.jsxs)("div",{className:T.announcementBar,style:{backgroundColor:r,color:o},role:"banner",children:[a&&(0,u.jsx)("div",{className:T.announcementBarPlaceholder}),(0,u.jsx)(C,{className:T.announcementBarContent}),a&&(0,u.jsx)(_,{onClick:n,className:T.announcementBarClose})]})}var j=n(9876),N=n(3104);var R=n(9532),L=n(5600);const P=r.createContext(null);function O(e){let{children:t}=e;const n=function(){const e=(0,j.M)(),t=(0,L.YL)(),[n,o]=(0,r.useState)(!1),a=null!==t.component,i=(0,R.ZC)(a);return(0,r.useEffect)((()=>{a&&!i&&o(!0)}),[a,i]),(0,r.useEffect)((()=>{a?e.shown||o(!0):o(!1)}),[e.shown,a]),(0,r.useMemo)((()=>[n,o]),[n])}();return(0,u.jsx)(P.Provider,{value:n,children:t})}function I(e){if(e.component){const t=e.component;return(0,u.jsx)(t,{...e.props})}}function D(){const e=(0,r.useContext)(P);if(!e)throw new R.dV("NavbarSecondaryMenuDisplayProvider");const[t,n]=e,o=(0,r.useCallback)((()=>n(!1)),[n]),a=(0,L.YL)();return(0,r.useMemo)((()=>({shown:t,hide:o,content:I(a)})),[o,a,t])}function M(e){let{header:t,primaryMenu:n,secondaryMenu:r}=e;const{shown:a}=D();return(0,u.jsxs)("div",{className:"navbar-sidebar",children:[t,(0,u.jsxs)("div",{className:(0,o.A)("navbar-sidebar__items",{"navbar-sidebar__items--show-secondary":a}),children:[(0,u.jsx)("div",{className:"navbar-sidebar__item menu",children:n}),(0,u.jsx)("div",{className:"navbar-sidebar__item menu",children:r})]})]})}var F=n(5293),z=n(2303);function B(e){return(0,u.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,u.jsx)("path",{fill:"currentColor",d:"M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"})})}function $(e){return(0,u.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,u.jsx)("path",{fill:"currentColor",d:"M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"})})}const U={toggle:"toggle_vylO",toggleButton:"toggleButton_gllP",darkToggleIcon:"darkToggleIcon_wfgR",lightToggleIcon:"lightToggleIcon_pyhR",toggleButtonDisabled:"toggleButtonDisabled_aARS"};function q(e){let{className:t,buttonClassName:n,value:r,onChange:a}=e;const i=(0,z.A)(),s=(0,l.T)({message:"Switch between dark and light mode (currently {mode})",id:"theme.colorToggle.ariaLabel",description:"The ARIA label for the navbar color mode toggle"},{mode:"dark"===r?(0,l.T)({message:"dark mode",id:"theme.colorToggle.ariaLabel.mode.dark",description:"The name for the dark color mode"}):(0,l.T)({message:"light mode",id:"theme.colorToggle.ariaLabel.mode.light",description:"The name for the light color mode"})});return(0,u.jsx)("div",{className:(0,o.A)(U.toggle,t),children:(0,u.jsxs)("button",{className:(0,o.A)("clean-btn",U.toggleButton,!i&&U.toggleButtonDisabled,n),type:"button",onClick:()=>a("dark"===r?"light":"dark"),disabled:!i,title:s,"aria-label":s,"aria-live":"polite",children:[(0,u.jsx)(B,{className:(0,o.A)(U.toggleIcon,U.lightToggleIcon)}),(0,u.jsx)($,{className:(0,o.A)(U.toggleIcon,U.darkToggleIcon)})]})})}const H=r.memo(q),G={darkNavbarColorModeToggle:"darkNavbarColorModeToggle_X3D1"};function W(e){let{className:t}=e;const n=(0,w.p)().navbar.style,r=(0,w.p)().colorMode.disableSwitch,{colorMode:o,setColorMode:a}=(0,F.G)();return r?null:(0,u.jsx)(H,{className:t,buttonClassName:"dark"===n?G.darkNavbarColorModeToggle:void 0,value:o,onChange:a})}var V=n(3465);function Q(){return(0,u.jsx)(V.A,{className:"navbar__brand",imageClassName:"navbar__logo",titleClassName:"navbar__title text--truncate"})}function K(){const e=(0,j.M)();return(0,u.jsx)("button",{type:"button","aria-label":(0,l.T)({id:"theme.docs.sidebar.closeSidebarButtonAriaLabel",message:"Close navigation bar",description:"The ARIA label for close button of mobile sidebar"}),className:"clean-btn navbar-sidebar__close",onClick:()=>e.toggle(),children:(0,u.jsx)(x,{color:"var(--ifm-color-emphasis-600)"})})}function Y(){return(0,u.jsxs)("div",{className:"navbar-sidebar__brand",children:[(0,u.jsx)(Q,{}),(0,u.jsx)(W,{className:"margin-right--md"}),(0,u.jsx)(K,{})]})}var J=n(8774),Z=n(6025),X=n(6654);function ee(e,t){return void 0!==e&&void 0!==t&&new RegExp(e,"gi").test(t)}var te=n(3186);function ne(e){let{activeBasePath:t,activeBaseRegex:n,to:r,href:o,label:a,html:i,isDropdownLink:s,prependBaseUrlToHref:l,...c}=e;const d=(0,Z.A)(r),f=(0,Z.A)(t),p=(0,Z.A)(o,{forcePrependBaseUrl:!0}),h=a&&o&&!(0,X.A)(o),m=i?{dangerouslySetInnerHTML:{__html:i}}:{children:(0,u.jsxs)(u.Fragment,{children:[a,h&&(0,u.jsx)(te.A,{...s&&{width:12,height:12}})]})};return o?(0,u.jsx)(J.A,{href:l?p:o,...c,...m}):(0,u.jsx)(J.A,{to:d,isNavLink:!0,...(t||n)&&{isActive:(e,t)=>n?ee(n,t.pathname):t.pathname.startsWith(f)},...c,...m})}function re(e){let{className:t,isDropdownItem:n=!1,...r}=e;const a=(0,u.jsx)(ne,{className:(0,o.A)(n?"dropdown__link":"navbar__item navbar__link",t),isDropdownLink:n,...r});return n?(0,u.jsx)("li",{children:a}):a}function oe(e){let{className:t,isDropdownItem:n,...r}=e;return(0,u.jsx)("li",{className:"menu__list-item",children:(0,u.jsx)(ne,{className:(0,o.A)("menu__link",t),...r})})}function ae(e){let{mobile:t=!1,position:n,...r}=e;const o=t?oe:re;return(0,u.jsx)(o,{...r,activeClassName:r.activeClassName??(t?"menu__link--active":"navbar__link--active")})}var ie=n(1422),se=n(9169),le=n(4586);const ce={dropdownNavbarItemMobile:"dropdownNavbarItemMobile_S0Fm"};function ue(e,t){return e.some((e=>function(e,t){return!!(0,se.ys)(e.to,t)||!!ee(e.activeBaseRegex,t)||!(!e.activeBasePath||!t.startsWith(e.activeBasePath))}(e,t)))}function de(e){let{items:t,position:n,className:a,onClick:i,...s}=e;const l=(0,r.useRef)(null),[c,d]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{const e=e=>{l.current&&!l.current.contains(e.target)&&d(!1)};return document.addEventListener("mousedown",e),document.addEventListener("touchstart",e),document.addEventListener("focusin",e),()=>{document.removeEventListener("mousedown",e),document.removeEventListener("touchstart",e),document.removeEventListener("focusin",e)}}),[l]),(0,u.jsxs)("div",{ref:l,className:(0,o.A)("navbar__item","dropdown","dropdown--hoverable",{"dropdown--right":"right"===n,"dropdown--show":c}),children:[(0,u.jsx)(ne,{"aria-haspopup":"true","aria-expanded":c,role:"button",href:s.to?void 0:"#",className:(0,o.A)("navbar__link",a),...s,onClick:s.to?void 0:e=>e.preventDefault(),onKeyDown:e=>{"Enter"===e.key&&(e.preventDefault(),d(!c))},children:s.children??s.label}),(0,u.jsx)("ul",{className:"dropdown__menu",children:t.map(((e,t)=>(0,r.createElement)(Re,{isDropdownItem:!0,activeClassName:"dropdown__link--active",...e,key:t})))})]})}function fe(e){let{items:t,className:n,position:a,onClick:i,...l}=e;const c=function(){const{siteConfig:{baseUrl:e}}=(0,le.A)(),{pathname:t}=(0,s.zy)();return t.replace(e,"/")}(),d=ue(t,c),{collapsed:f,toggleCollapsed:p,setCollapsed:h}=(0,ie.u)({initialState:()=>!d});return(0,r.useEffect)((()=>{d&&h(!d)}),[c,d,h]),(0,u.jsxs)("li",{className:(0,o.A)("menu__list-item",{"menu__list-item--collapsed":f}),children:[(0,u.jsx)(ne,{role:"button",className:(0,o.A)(ce.dropdownNavbarItemMobile,"menu__link menu__link--sublist menu__link--sublist-caret",n),...l,onClick:e=>{e.preventDefault(),p()},children:l.children??l.label}),(0,u.jsx)(ie.N,{lazy:!0,as:"ul",className:"menu__list",collapsed:f,children:t.map(((e,t)=>(0,r.createElement)(Re,{mobile:!0,isDropdownItem:!0,onClick:i,activeClassName:"menu__link--active",...e,key:t})))})]})}function pe(e){let{mobile:t=!1,...n}=e;const r=t?fe:de;return(0,u.jsx)(r,{...n})}var he=n(2131);function me(e){let{width:t=20,height:n=20,...r}=e;return(0,u.jsx)("svg",{viewBox:"0 0 24 24",width:t,height:n,"aria-hidden":!0,...r,children:(0,u.jsx)("path",{fill:"currentColor",d:"M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"})})}const ge="iconLanguage_nlXk";function be(e){var t,n,r="";if("string"==typeof e||"number"==typeof e)r+=e;else if("object"==typeof e)if(Array.isArray(e))for(t=0;t{if(!e.state?.highlightState||0===e.state.highlightState.wordToHighlight.length)return;a(e.state.highlightState);const{highlightState:n,...r}=e.state;t.replace({...e,state:r})}),[e.state?.highlightState,t,e]),(0,r.useEffect)((()=>{if(0===o.wordToHighlight.length)return;const e=document.getElementsByTagName("article")[0]??document.getElementsByTagName("main")[0];if(!e)return;const t=new(ke())(e),n={ignoreJoiners:!0};return t.mark(o.wordToHighlight,n),()=>t.unmark(n)}),[o,n]),null}const Se=e=>{const t=(0,r.useRef)(!1),o=(0,r.useRef)(null),[a,i]=(0,r.useState)(!1),l=(0,s.W6)(),{siteConfig:c={}}=(0,le.A)(),d=(c.plugins||[]).find((e=>Array.isArray(e)&&"string"==typeof e[0]&&e[0].includes("docusaurus-lunr-search"))),f=(0,z.A)(),{baseUrl:p}=c,h=d&&d[1]?.assetUrl||p,m=(0,ye.P_)("docusaurus-lunr-search"),g=()=>{t.current||(Promise.all([fetch(`${h}${m.fileNames.searchDoc}`).then((e=>e.json())),fetch(`${h}${m.fileNames.lunrIndex}`).then((e=>e.json())),Promise.all([n.e(8591),n.e(8577)]).then(n.bind(n,5765)),Promise.all([n.e(1869),n.e(9278)]).then(n.bind(n,9278))]).then((e=>{let[t,n,{default:r}]=e;const{searchDocs:o,options:a}=t;o&&0!==o.length&&(((e,t,n,r)=>{new n({searchDocs:e,searchIndex:t,baseUrl:p,inputSelector:"#search_input_react",handleSelected:(e,t,n)=>{const o=n.url||"/";document.createElement("a").href=o,e.setVal(""),t.target.blur();let a="";if(r.highlightResult)try{const e=(n.text||n.subcategory||n.title).match(new RegExp("\\w*","g"));if(e&&e.length>0){const t=document.createElement("div");t.innerHTML=e[0],a=t.textContent}}catch(i){console.log(i)}l.push(o,{highlightState:{wordToHighlight:a}})},maxHits:r.maxHits})})(o,n,r,a),i(!0))})),t.current=!0)},b=(0,r.useCallback)((t=>{o.current.contains(t.target)||o.current.focus(),e.handleSearchBarToggle&&e.handleSearchBarToggle(!e.isSearchBarExpanded)}),[e.isSearchBarExpanded]);let v;return f&&(g(),v=window.navigator.platform.startsWith("Mac")?"Search \u2318+K":"Search Ctrl+K"),(0,u.jsxs)("div",{className:"navbar__search",children:[(0,u.jsx)("span",{"aria-label":"expand searchbar",role:"button",className:ve("search-icon",{"search-icon-hidden":e.isSearchBarExpanded}),onClick:b,onKeyDown:b,tabIndex:0}),(0,u.jsx)("input",{id:"search_input_react",type:"search",placeholder:a?v:"Loading...","aria-label":"Search",className:ve("navbar__search-input",{"search-bar-expanded":e.isSearchBarExpanded},{"search-bar":!e.isSearchBarExpanded}),onClick:g,onMouseOver:g,onFocus:b,onBlur:b,ref:o,disabled:!a}),(0,u.jsx)(xe,{})]},"search-box")},_e={navbarSearchContainer:"navbarSearchContainer_Bca1"};function Ee(e){let{children:t,className:n}=e;return(0,u.jsx)("div",{className:(0,o.A)(n,_e.navbarSearchContainer),children:t})}var Ce=n(8295),Te=n(1754);var Ae=n(5597);const je=e=>e.docs.find((t=>t.id===e.mainDocId));const Ne={default:ae,localeDropdown:function(e){let{mobile:t,dropdownItemsBefore:n,dropdownItemsAfter:r,queryString:o="",...a}=e;const{i18n:{currentLocale:i,locales:c,localeConfigs:d}}=(0,le.A)(),f=(0,he.o)(),{search:p,hash:h}=(0,s.zy)(),m=[...n,...c.map((e=>{const n=`${`pathname://${f.createUrl({locale:e,fullyQualified:!1})}`}${p}${h}${o}`;return{label:d[e].label,lang:d[e].htmlLang,to:n,target:"_self",autoAddBaseUrl:!1,className:e===i?t?"menu__link--active":"dropdown__link--active":""}})),...r],g=t?(0,l.T)({message:"Languages",id:"theme.navbar.mobileLanguageDropdown.label",description:"The label for the mobile language switcher dropdown"}):d[i].label;return(0,u.jsx)(pe,{...a,mobile:t,label:(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(me,{className:ge}),g]}),items:m})},search:function(e){let{mobile:t,className:n}=e;return t?null:(0,u.jsx)(Ee,{className:n,children:(0,u.jsx)(Se,{})})},dropdown:pe,html:function(e){let{value:t,className:n,mobile:r=!1,isDropdownItem:a=!1}=e;const i=a?"li":"div";return(0,u.jsx)(i,{className:(0,o.A)({navbar__item:!r&&!a,"menu__list-item":r},n),dangerouslySetInnerHTML:{__html:t}})},doc:function(e){let{docId:t,label:n,docsPluginId:r,...o}=e;const{activeDoc:a}=(0,Ce.zK)(r),i=(0,Te.QB)(t,r),s=a?.path===i?.path;return null===i||i.unlisted&&!s?null:(0,u.jsx)(ae,{exact:!0,...o,isActive:()=>s||!!a?.sidebar&&a.sidebar===i.sidebar,label:n??i.id,to:i.path})},docSidebar:function(e){let{sidebarId:t,label:n,docsPluginId:r,...o}=e;const{activeDoc:a}=(0,Ce.zK)(r),i=(0,Te.fW)(t,r).link;if(!i)throw new Error(`DocSidebarNavbarItem: Sidebar with ID "${t}" doesn't have anything to be linked to.`);return(0,u.jsx)(ae,{exact:!0,...o,isActive:()=>a?.sidebar===t,label:n??i.label,to:i.path})},docsVersion:function(e){let{label:t,to:n,docsPluginId:r,...o}=e;const a=(0,Te.Vd)(r)[0],i=t??a.label,s=n??(e=>e.docs.find((t=>t.id===e.mainDocId)))(a).path;return(0,u.jsx)(ae,{...o,label:i,to:s})},docsVersionDropdown:function(e){let{mobile:t,docsPluginId:n,dropdownActiveClassDisabled:r,dropdownItemsBefore:o,dropdownItemsAfter:a,...i}=e;const{search:c,hash:d}=(0,s.zy)(),f=(0,Ce.zK)(n),p=(0,Ce.jh)(n),{savePreferredVersionName:h}=(0,Ae.g1)(n),m=[...o,...p.map((e=>{const t=f.alternateDocVersions[e.name]??je(e);return{label:e.label,to:`${t.path}${c}${d}`,isActive:()=>e===f.activeVersion,onClick:()=>h(e.name)}})),...a],g=(0,Te.Vd)(n)[0],b=t&&m.length>1?(0,l.T)({id:"theme.navbar.mobileVersionsDropdown.label",message:"Versions",description:"The label for the navbar versions dropdown on mobile view"}):g.label,v=t&&m.length>1?void 0:je(g).path;return m.length<=1?(0,u.jsx)(ae,{...i,mobile:t,label:b,to:v,isActive:r?()=>!1:void 0}):(0,u.jsx)(pe,{...i,mobile:t,label:b,to:v,items:m,isActive:r?()=>!1:void 0})}};function Re(e){let{type:t,...n}=e;const r=function(e,t){return e&&"default"!==e?e:"items"in t?"dropdown":"default"}(t,n),o=Ne[r];if(!o)throw new Error(`No NavbarItem component found for type "${t}".`);return(0,u.jsx)(o,{...n})}function Le(){const e=(0,j.M)(),t=(0,w.p)().navbar.items;return(0,u.jsx)("ul",{className:"menu__list",children:t.map(((t,n)=>(0,r.createElement)(Re,{mobile:!0,...t,onClick:()=>e.toggle(),key:n})))})}function Pe(e){return(0,u.jsx)("button",{...e,type:"button",className:"clean-btn navbar-sidebar__back",children:(0,u.jsx)(l.A,{id:"theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel",description:"The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)",children:"\u2190 Back to main menu"})})}function Oe(){const e=0===(0,w.p)().navbar.items.length,t=D();return(0,u.jsxs)(u.Fragment,{children:[!e&&(0,u.jsx)(Pe,{onClick:()=>t.hide()}),t.content]})}function Ie(){const e=(0,j.M)();var t;return void 0===(t=e.shown)&&(t=!0),(0,r.useEffect)((()=>(document.body.style.overflow=t?"hidden":"visible",()=>{document.body.style.overflow="visible"})),[t]),e.shouldRender?(0,u.jsx)(M,{header:(0,u.jsx)(Y,{}),primaryMenu:(0,u.jsx)(Le,{}),secondaryMenu:(0,u.jsx)(Oe,{})}):null}const De={navbarHideable:"navbarHideable_m1mJ",navbarHidden:"navbarHidden_jGov"};function Me(e){return(0,u.jsx)("div",{role:"presentation",...e,className:(0,o.A)("navbar-sidebar__backdrop",e.className)})}function Fe(e){let{children:t}=e;const{navbar:{hideOnScroll:n,style:a}}=(0,w.p)(),i=(0,j.M)(),{navbarRef:s,isNavbarVisible:d}=function(e){const[t,n]=(0,r.useState)(e),o=(0,r.useRef)(!1),a=(0,r.useRef)(0),i=(0,r.useCallback)((e=>{null!==e&&(a.current=e.getBoundingClientRect().height)}),[]);return(0,N.Mq)(((t,r)=>{let{scrollY:i}=t;if(!e)return;if(i=s?n(!1):i+c{if(!e)return;const r=t.location.hash;if(r?document.getElementById(r.substring(1)):void 0)return o.current=!0,void n(!1);n(!0)})),{navbarRef:i,isNavbarVisible:t}}(n);return(0,u.jsxs)("nav",{ref:s,"aria-label":(0,l.T)({id:"theme.NavBar.navAriaLabel",message:"Main",description:"The ARIA label for the main navigation"}),className:(0,o.A)("navbar","navbar--fixed-top",n&&[De.navbarHideable,!d&&De.navbarHidden],{"navbar--dark":"dark"===a,"navbar--primary":"primary"===a,"navbar-sidebar--show":i.shown}),children:[t,(0,u.jsx)(Me,{onClick:i.toggle}),(0,u.jsx)(Ie,{})]})}var ze=n(440);const Be={errorBoundaryError:"errorBoundaryError_a6uf",errorBoundaryFallback:"errorBoundaryFallback_VBag"};function $e(e){return(0,u.jsx)("button",{type:"button",...e,children:(0,u.jsx)(l.A,{id:"theme.ErrorPageContent.tryAgain",description:"The label of the button to try again rendering when the React error boundary captures an error",children:"Try again"})})}function Ue(e){let{error:t}=e;const n=(0,ze.getErrorCausalChain)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,u.jsx)("p",{className:Be.errorBoundaryError,children:n})}class qe extends r.Component{componentDidCatch(e,t){throw this.props.onError(e,t)}render(){return this.props.children}}const He="right";function Ge(e){let{width:t=30,height:n=30,className:r,...o}=e;return(0,u.jsx)("svg",{className:r,width:t,height:n,viewBox:"0 0 30 30","aria-hidden":"true",...o,children:(0,u.jsx)("path",{stroke:"currentColor",strokeLinecap:"round",strokeMiterlimit:"10",strokeWidth:"2",d:"M4 7h22M4 15h22M4 23h22"})})}function We(){const{toggle:e,shown:t}=(0,j.M)();return(0,u.jsx)("button",{onClick:e,"aria-label":(0,l.T)({id:"theme.docs.sidebar.toggleSidebarButtonAriaLabel",message:"Toggle navigation bar",description:"The ARIA label for hamburger menu button of mobile navigation"}),"aria-expanded":t,className:"navbar__toggle clean-btn",type:"button",children:(0,u.jsx)(Ge,{})})}const Ve={colorModeToggle:"colorModeToggle_DEke"};function Qe(e){let{items:t}=e;return(0,u.jsx)(u.Fragment,{children:t.map(((e,t)=>(0,u.jsx)(qe,{onError:t=>new Error(`A theme navbar item failed to render.\nPlease double-check the following navbar item (themeConfig.navbar.items) of your Docusaurus config:\n${JSON.stringify(e,null,2)}`,{cause:t}),children:(0,u.jsx)(Re,{...e})},t)))})}function Ke(e){let{left:t,right:n}=e;return(0,u.jsxs)("div",{className:"navbar__inner",children:[(0,u.jsx)("div",{className:"navbar__items",children:t}),(0,u.jsx)("div",{className:"navbar__items navbar__items--right",children:n})]})}function Ye(){const e=(0,j.M)(),t=(0,w.p)().navbar.items,[n,r]=function(e){function t(e){return"left"===(e.position??He)}return[e.filter(t),e.filter((e=>!t(e)))]}(t),o=t.find((e=>"search"===e.type));return(0,u.jsx)(Ke,{left:(0,u.jsxs)(u.Fragment,{children:[!e.disabled&&(0,u.jsx)(We,{}),(0,u.jsx)(Q,{}),(0,u.jsx)(Qe,{items:n})]}),right:(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(Qe,{items:r}),(0,u.jsx)(W,{className:Ve.colorModeToggle}),!o&&(0,u.jsx)(Ee,{children:(0,u.jsx)(Se,{})})]})})}function Je(){return(0,u.jsx)(Fe,{children:(0,u.jsx)(Ye,{})})}function Ze(e){let{item:t}=e;const{to:n,href:r,label:o,prependBaseUrlToHref:a,...i}=t,s=(0,Z.A)(n),l=(0,Z.A)(r,{forcePrependBaseUrl:!0});return(0,u.jsxs)(J.A,{className:"footer__link-item",...r?{href:a?l:r}:{to:s},...i,children:[o,r&&!(0,X.A)(r)&&(0,u.jsx)(te.A,{})]})}function Xe(e){let{item:t}=e;return t.html?(0,u.jsx)("li",{className:"footer__item",dangerouslySetInnerHTML:{__html:t.html}}):(0,u.jsx)("li",{className:"footer__item",children:(0,u.jsx)(Ze,{item:t})},t.href??t.to)}function et(e){let{column:t}=e;return(0,u.jsxs)("div",{className:"col footer__col",children:[(0,u.jsx)("div",{className:"footer__title",children:t.title}),(0,u.jsx)("ul",{className:"footer__items clean-list",children:t.items.map(((e,t)=>(0,u.jsx)(Xe,{item:e},t)))})]})}function tt(e){let{columns:t}=e;return(0,u.jsx)("div",{className:"row footer__links",children:t.map(((e,t)=>(0,u.jsx)(et,{column:e},t)))})}function nt(){return(0,u.jsx)("span",{className:"footer__link-separator",children:"\xb7"})}function rt(e){let{item:t}=e;return t.html?(0,u.jsx)("span",{className:"footer__link-item",dangerouslySetInnerHTML:{__html:t.html}}):(0,u.jsx)(Ze,{item:t})}function ot(e){let{links:t}=e;return(0,u.jsx)("div",{className:"footer__links text--center",children:(0,u.jsx)("div",{className:"footer__links",children:t.map(((e,n)=>(0,u.jsxs)(r.Fragment,{children:[(0,u.jsx)(rt,{item:e}),t.length!==n+1&&(0,u.jsx)(nt,{})]},n)))})})}function at(e){let{links:t}=e;return function(e){return"title"in e[0]}(t)?(0,u.jsx)(tt,{columns:t}):(0,u.jsx)(ot,{links:t})}var it=n(1122);const st={footerLogoLink:"footerLogoLink_BH7S"};function lt(e){let{logo:t}=e;const{withBaseUrl:n}=(0,Z.h)(),r={light:n(t.src),dark:n(t.srcDark??t.src)};return(0,u.jsx)(it.A,{className:(0,o.A)("footer__logo",t.className),alt:t.alt,sources:r,width:t.width,height:t.height,style:t.style})}function ct(e){let{logo:t}=e;return t.href?(0,u.jsx)(J.A,{href:t.href,className:st.footerLogoLink,target:t.target,children:(0,u.jsx)(lt,{logo:t})}):(0,u.jsx)(lt,{logo:t})}function ut(e){let{copyright:t}=e;return(0,u.jsx)("div",{className:"footer__copyright",dangerouslySetInnerHTML:{__html:t}})}function dt(e){let{style:t,links:n,logo:r,copyright:a}=e;return(0,u.jsx)("footer",{className:(0,o.A)("footer",{"footer--dark":"dark"===t}),children:(0,u.jsxs)("div",{className:"container container-fluid",children:[n,(r||a)&&(0,u.jsxs)("div",{className:"footer__bottom text--center",children:[r&&(0,u.jsx)("div",{className:"margin-bottom--sm",children:r}),a]})]})})}function ft(){const{footer:e}=(0,w.p)();if(!e)return null;const{copyright:t,links:n,logo:r,style:o}=e;return(0,u.jsx)(dt,{style:o,links:n&&n.length>0&&(0,u.jsx)(at,{links:n}),logo:r&&(0,u.jsx)(ct,{logo:r}),copyright:t&&(0,u.jsx)(ut,{copyright:t})})}const pt=r.memo(ft),ht=(0,R.fM)([F.a,k.oq,N.Tv,Ae.VQ,i.Jx,function(e){let{children:t}=e;return(0,u.jsx)(L.y_,{children:(0,u.jsx)(j.e,{children:(0,u.jsx)(O,{children:t})})})}]);function mt(e){let{children:t}=e;return(0,u.jsx)(ht,{children:t})}var gt=n(1107);function bt(e){let{error:t,tryAgain:n}=e;return(0,u.jsx)("main",{className:"container margin-vert--xl",children:(0,u.jsx)("div",{className:"row",children:(0,u.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,u.jsx)(gt.A,{as:"h1",className:"hero__title",children:(0,u.jsx)(l.A,{id:"theme.ErrorPageContent.title",description:"The title of the fallback page when the page crashed",children:"This page crashed."})}),(0,u.jsx)("div",{className:"margin-vert--lg",children:(0,u.jsx)($e,{onClick:n,className:"button button--primary shadow--lw"})}),(0,u.jsx)("hr",{}),(0,u.jsx)("div",{className:"margin-vert--md",children:(0,u.jsx)(Ue,{error:t})})]})})})}const vt={mainWrapper:"mainWrapper_z2l0"};function yt(e){const{children:t,noFooter:n,wrapperClassName:r,title:s,description:l}=e;return(0,b.J)(),(0,u.jsxs)(mt,{children:[(0,u.jsx)(i.be,{title:s,description:l}),(0,u.jsx)(y,{}),(0,u.jsx)(A,{}),(0,u.jsx)(Je,{}),(0,u.jsx)("div",{id:d,className:(0,o.A)(g.G.wrapper.main,vt.mainWrapper,r),children:(0,u.jsx)(a.A,{fallback:e=>(0,u.jsx)(bt,{...e}),children:t})}),!n&&(0,u.jsx)(pt,{})]})}},3465:(e,t,n)=>{"use strict";n.d(t,{A:()=>u});n(6540);var r=n(8774),o=n(6025),a=n(4586),i=n(6342),s=n(1122),l=n(4848);function c(e){let{logo:t,alt:n,imageClassName:r}=e;const a={light:(0,o.A)(t.src),dark:(0,o.A)(t.srcDark||t.src)},i=(0,l.jsx)(s.A,{className:t.className,sources:a,height:t.height,width:t.width,alt:n,style:t.style});return r?(0,l.jsx)("div",{className:r,children:i}):i}function u(e){const{siteConfig:{title:t}}=(0,a.A)(),{navbar:{title:n,logo:s}}=(0,i.p)(),{imageClassName:u,titleClassName:d,...f}=e,p=(0,o.A)(s?.href||"/"),h=n?"":t,m=s?.alt??h;return(0,l.jsxs)(r.A,{to:p,...f,...s?.target&&{target:s.target},children:[s&&(0,l.jsx)(c,{logo:s,alt:m,imageClassName:u}),null!=n&&(0,l.jsx)("b",{className:d,children:n})]})}},1463:(e,t,n)=>{"use strict";n.d(t,{A:()=>a});n(6540);var r=n(5260),o=n(4848);function a(e){let{locale:t,version:n,tag:a}=e;const i=t;return(0,o.jsxs)(r.A,{children:[t&&(0,o.jsx)("meta",{name:"docusaurus_locale",content:t}),n&&(0,o.jsx)("meta",{name:"docusaurus_version",content:n}),a&&(0,o.jsx)("meta",{name:"docusaurus_tag",content:a}),i&&(0,o.jsx)("meta",{name:"docsearch:language",content:i}),n&&(0,o.jsx)("meta",{name:"docsearch:version",content:n}),a&&(0,o.jsx)("meta",{name:"docsearch:docusaurus_tag",content:a})]})}},1122:(e,t,n)=>{"use strict";n.d(t,{A:()=>u});var r=n(6540),o=n(4164),a=n(2303),i=n(5293);const s={themedComponent:"themedComponent_mlkZ","themedComponent--light":"themedComponent--light_NVdE","themedComponent--dark":"themedComponent--dark_xIcU"};var l=n(4848);function c(e){let{className:t,children:n}=e;const c=(0,a.A)(),{colorMode:u}=(0,i.G)();return(0,l.jsx)(l.Fragment,{children:(c?"dark"===u?["dark"]:["light"]:["light","dark"]).map((e=>{const a=n({theme:e,className:(0,o.A)(t,s.themedComponent,s[`themedComponent--${e}`])});return(0,l.jsx)(r.Fragment,{children:a},e)}))})}function u(e){const{sources:t,className:n,alt:r,...o}=e;return(0,l.jsx)(c,{className:n,children:e=>{let{theme:n,className:a}=e;return(0,l.jsx)("img",{src:t[n],alt:r,className:a,...o})}})}},1422:(e,t,n)=>{"use strict";n.d(t,{N:()=>b,u:()=>c});var r=n(6540),o=n(8193),a=n(205),i=n(3109),s=n(4848);const l="ease-in-out";function c(e){let{initialState:t}=e;const[n,o]=(0,r.useState)(t??!1),a=(0,r.useCallback)((()=>{o((e=>!e))}),[]);return{collapsed:n,setCollapsed:o,toggleCollapsed:a}}const u={display:"none",overflow:"hidden",height:"0px"},d={display:"block",overflow:"visible",height:"auto"};function f(e,t){const n=t?u:d;e.style.display=n.display,e.style.overflow=n.overflow,e.style.height=n.height}function p(e){let{collapsibleRef:t,collapsed:n,animation:o}=e;const a=(0,r.useRef)(!1);(0,r.useEffect)((()=>{const e=t.current;function r(){const t=e.scrollHeight,n=o?.duration??function(e){if((0,i.O)())return 1;const t=e/36;return Math.round(10*(4+15*t**.25+t/5))}(t);return{transition:`height ${n}ms ${o?.easing??l}`,height:`${t}px`}}function s(){const t=r();e.style.transition=t.transition,e.style.height=t.height}if(!a.current)return f(e,n),void(a.current=!0);return e.style.willChange="height",function(){const t=requestAnimationFrame((()=>{n?(s(),requestAnimationFrame((()=>{e.style.height=u.height,e.style.overflow=u.overflow}))):(e.style.display="block",requestAnimationFrame((()=>{s()})))}));return()=>cancelAnimationFrame(t)}()}),[t,n,o])}function h(e){if(!o.A.canUseDOM)return e?u:d}function m(e){let{as:t="div",collapsed:n,children:o,animation:a,onCollapseTransitionEnd:i,className:l,disableSSRStyle:c}=e;const u=(0,r.useRef)(null);return p({collapsibleRef:u,collapsed:n,animation:a}),(0,s.jsx)(t,{ref:u,style:c?void 0:h(n),onTransitionEnd:e=>{"height"===e.propertyName&&(f(u.current,n),i?.(n))},className:l,children:o})}function g(e){let{collapsed:t,...n}=e;const[o,i]=(0,r.useState)(!t),[l,c]=(0,r.useState)(t);return(0,a.A)((()=>{t||i(!0)}),[t]),(0,a.A)((()=>{o&&c(t)}),[o,t]),o?(0,s.jsx)(m,{...n,collapsed:l}):null}function b(e){let{lazy:t,...n}=e;const r=t?g:m;return(0,s.jsx)(r,{...n})}},5041:(e,t,n)=>{"use strict";n.d(t,{Mj:()=>m,oq:()=>h});var r=n(6540),o=n(2303),a=n(9466),i=n(9532),s=n(6342),l=n(4848);const c=(0,a.Wf)("docusaurus.announcement.dismiss"),u=(0,a.Wf)("docusaurus.announcement.id"),d=()=>"true"===c.get(),f=e=>c.set(String(e)),p=r.createContext(null);function h(e){let{children:t}=e;const n=function(){const{announcementBar:e}=(0,s.p)(),t=(0,o.A)(),[n,a]=(0,r.useState)((()=>!!t&&d()));(0,r.useEffect)((()=>{a(d())}),[]);const i=(0,r.useCallback)((()=>{f(!0),a(!0)}),[]);return(0,r.useEffect)((()=>{if(!e)return;const{id:t}=e;let n=u.get();"annoucement-bar"===n&&(n="announcement-bar");const r=t!==n;u.set(t),r&&f(!1),!r&&d()||a(!1)}),[e]),(0,r.useMemo)((()=>({isActive:!!e&&!n,close:i})),[e,n,i])}();return(0,l.jsx)(p.Provider,{value:n,children:t})}function m(){const e=(0,r.useContext)(p);if(!e)throw new i.dV("AnnouncementBarProvider");return e}},5293:(e,t,n)=>{"use strict";n.d(t,{G:()=>b,a:()=>g});var r=n(6540),o=n(8193),a=n(9532),i=n(9466),s=n(6342),l=n(4848);const c=r.createContext(void 0),u="theme",d=(0,i.Wf)(u),f={light:"light",dark:"dark"},p=e=>e===f.dark?f.dark:f.light,h=e=>o.A.canUseDOM?p(document.documentElement.getAttribute("data-theme")):p(e),m=e=>{d.set(p(e))};function g(e){let{children:t}=e;const n=function(){const{colorMode:{defaultMode:e,disableSwitch:t,respectPrefersColorScheme:n}}=(0,s.p)(),[o,a]=(0,r.useState)(h(e));(0,r.useEffect)((()=>{t&&d.del()}),[t]);const i=(0,r.useCallback)((function(t,r){void 0===r&&(r={});const{persist:o=!0}=r;t?(a(t),o&&m(t)):(a(n?window.matchMedia("(prefers-color-scheme: dark)").matches?f.dark:f.light:e),d.del())}),[n,e]);(0,r.useEffect)((()=>{document.documentElement.setAttribute("data-theme",p(o))}),[o]),(0,r.useEffect)((()=>{if(t)return;const e=e=>{if(e.key!==u)return;const t=d.get();null!==t&&i(p(t))};return window.addEventListener("storage",e),()=>window.removeEventListener("storage",e)}),[t,i]);const l=(0,r.useRef)(!1);return(0,r.useEffect)((()=>{if(t&&!n)return;const e=window.matchMedia("(prefers-color-scheme: dark)"),r=()=>{window.matchMedia("print").matches||l.current?l.current=window.matchMedia("print").matches:i(null)};return e.addListener(r),()=>e.removeListener(r)}),[i,t,n]),(0,r.useMemo)((()=>({colorMode:o,setColorMode:i,get isDarkTheme(){return o===f.dark},setLightTheme(){i(f.light)},setDarkTheme(){i(f.dark)}})),[o,i])}();return(0,l.jsx)(c.Provider,{value:n,children:t})}function b(){const e=(0,r.useContext)(c);if(null==e)throw new a.dV("ColorModeProvider","Please see https://docusaurus.io/docs/api/themes/configuration#use-color-mode.");return e}},5597:(e,t,n)=>{"use strict";n.d(t,{VQ:()=>b,g1:()=>y});var r=n(6540),o=n(8295),a=n(7065),i=n(6342),s=n(1754),l=n(9532),c=n(9466),u=n(4848);const d=e=>`docs-preferred-version-${e}`,f={save:(e,t,n)=>{(0,c.Wf)(d(e),{persistence:t}).set(n)},read:(e,t)=>(0,c.Wf)(d(e),{persistence:t}).get(),clear:(e,t)=>{(0,c.Wf)(d(e),{persistence:t}).del()}},p=e=>Object.fromEntries(e.map((e=>[e,{preferredVersionName:null}])));const h=r.createContext(null);function m(){const e=(0,o.Gy)(),t=(0,i.p)().docs.versionPersistence,n=(0,r.useMemo)((()=>Object.keys(e)),[e]),[a,s]=(0,r.useState)((()=>p(n)));(0,r.useEffect)((()=>{s(function(e){let{pluginIds:t,versionPersistence:n,allDocsData:r}=e;function o(e){const t=f.read(e,n);return r[e].versions.some((e=>e.name===t))?{preferredVersionName:t}:(f.clear(e,n),{preferredVersionName:null})}return Object.fromEntries(t.map((e=>[e,o(e)])))}({allDocsData:e,versionPersistence:t,pluginIds:n}))}),[e,t,n]);return[a,(0,r.useMemo)((()=>({savePreferredVersion:function(e,n){f.save(e,t,n),s((t=>({...t,[e]:{preferredVersionName:n}})))}})),[t])]}function g(e){let{children:t}=e;const n=m();return(0,u.jsx)(h.Provider,{value:n,children:t})}function b(e){let{children:t}=e;return s.C5?(0,u.jsx)(g,{children:t}):(0,u.jsx)(u.Fragment,{children:t})}function v(){const e=(0,r.useContext)(h);if(!e)throw new l.dV("DocsPreferredVersionContextProvider");return e}function y(e){void 0===e&&(e=a.W);const t=(0,o.ht)(e),[n,i]=v(),{preferredVersionName:s}=n[e];return{preferredVersion:t.versions.find((e=>e.name===s))??null,savePreferredVersionName:(0,r.useCallback)((t=>{i.savePreferredVersion(e,t)}),[i,e])}}},4207:(e,t,n)=>{"use strict";n.d(t,{V:()=>l,t:()=>c});var r=n(6540),o=n(9532),a=n(4848);const i=Symbol("EmptyContext"),s=r.createContext(i);function l(e){let{children:t,name:n,items:o}=e;const i=(0,r.useMemo)((()=>n&&o?{name:n,items:o}:null),[n,o]);return(0,a.jsx)(s.Provider,{value:i,children:t})}function c(){const e=(0,r.useContext)(s);if(e===i)throw new o.dV("DocsSidebarProvider");return e}},2252:(e,t,n)=>{"use strict";n.d(t,{n:()=>s,r:()=>l});var r=n(6540),o=n(9532),a=n(4848);const i=r.createContext(null);function s(e){let{children:t,version:n}=e;return(0,a.jsx)(i.Provider,{value:n,children:t})}function l(){const e=(0,r.useContext)(i);if(null===e)throw new o.dV("DocsVersionProvider");return e}},9876:(e,t,n)=>{"use strict";n.d(t,{e:()=>p,M:()=>h});var r=n(6540),o=n(5600),a=n(4581),i=n(6347),s=n(9532);function l(e){!function(e){const t=(0,i.W6)(),n=(0,s._q)(e);(0,r.useEffect)((()=>t.block(((e,t)=>n(e,t)))),[t,n])}(((t,n)=>{if("POP"===n)return e(t,n)}))}var c=n(6342),u=n(4848);const d=r.createContext(void 0);function f(){const e=function(){const e=(0,o.YL)(),{items:t}=(0,c.p)().navbar;return 0===t.length&&!e.component}(),t=(0,a.l)(),n=!e&&"mobile"===t,[i,s]=(0,r.useState)(!1);l((()=>{if(i)return s(!1),!1}));const u=(0,r.useCallback)((()=>{s((e=>!e))}),[]);return(0,r.useEffect)((()=>{"desktop"===t&&s(!1)}),[t]),(0,r.useMemo)((()=>({disabled:e,shouldRender:n,toggle:u,shown:i})),[e,n,u,i])}function p(e){let{children:t}=e;const n=f();return(0,u.jsx)(d.Provider,{value:n,children:t})}function h(){const e=r.useContext(d);if(void 0===e)throw new s.dV("NavbarMobileSidebarProvider");return e}},5600:(e,t,n)=>{"use strict";n.d(t,{GX:()=>c,YL:()=>l,y_:()=>s});var r=n(6540),o=n(9532),a=n(4848);const i=r.createContext(null);function s(e){let{children:t}=e;const n=(0,r.useState)({component:null,props:null});return(0,a.jsx)(i.Provider,{value:n,children:t})}function l(){const e=(0,r.useContext)(i);if(!e)throw new o.dV("NavbarSecondaryMenuContentProvider");return e[0]}function c(e){let{component:t,props:n}=e;const a=(0,r.useContext)(i);if(!a)throw new o.dV("NavbarSecondaryMenuContentProvider");const[,s]=a,l=(0,o.Be)(n);return(0,r.useEffect)((()=>{s({component:t,props:l})}),[s,t,l]),(0,r.useEffect)((()=>()=>s({component:null,props:null})),[s]),null}},4090:(e,t,n)=>{"use strict";n.d(t,{w:()=>o,J:()=>a});var r=n(6540);const o="navigation-with-keyboard";function a(){(0,r.useEffect)((()=>{function e(e){"keydown"===e.type&&"Tab"===e.key&&document.body.classList.add(o),"mousedown"===e.type&&document.body.classList.remove(o)}return document.addEventListener("keydown",e),document.addEventListener("mousedown",e),()=>{document.body.classList.remove(o),document.removeEventListener("keydown",e),document.removeEventListener("mousedown",e)}}),[])}},4581:(e,t,n)=>{"use strict";n.d(t,{l:()=>s});var r=n(6540),o=n(8193);const a={desktop:"desktop",mobile:"mobile",ssr:"ssr"},i=996;function s(e){let{desktopBreakpoint:t=i}=void 0===e?{}:e;const[n,s]=(0,r.useState)((()=>"ssr"));return(0,r.useEffect)((()=>{function e(){s(function(e){if(!o.A.canUseDOM)throw new Error("getWindowSize() should only be called after React hydration");return window.innerWidth>e?a.desktop:a.mobile}(t))}return e(),window.addEventListener("resize",e),()=>{window.removeEventListener("resize",e)}}),[t]),n}},7559:(e,t,n)=>{"use strict";n.d(t,{G:()=>r});const r={page:{blogListPage:"blog-list-page",blogPostPage:"blog-post-page",blogTagsListPage:"blog-tags-list-page",blogTagPostListPage:"blog-tags-post-list-page",docsDocPage:"docs-doc-page",docsTagsListPage:"docs-tags-list-page",docsTagDocListPage:"docs-tags-doc-list-page",mdxPage:"mdx-page"},wrapper:{main:"main-wrapper",blogPages:"blog-wrapper",docsPages:"docs-wrapper",mdxPages:"mdx-wrapper"},common:{editThisPage:"theme-edit-this-page",lastUpdated:"theme-last-updated",backToTopButton:"theme-back-to-top-button",codeBlock:"theme-code-block",admonition:"theme-admonition",unlistedBanner:"theme-unlisted-banner",admonitionType:e=>`theme-admonition-${e}`},layout:{},docs:{docVersionBanner:"theme-doc-version-banner",docVersionBadge:"theme-doc-version-badge",docBreadcrumbs:"theme-doc-breadcrumbs",docMarkdown:"theme-doc-markdown",docTocMobile:"theme-doc-toc-mobile",docTocDesktop:"theme-doc-toc-desktop",docFooter:"theme-doc-footer",docFooterTagsRow:"theme-doc-footer-tags-row",docFooterEditMetaRow:"theme-doc-footer-edit-meta-row",docSidebarContainer:"theme-doc-sidebar-container",docSidebarMenu:"theme-doc-sidebar-menu",docSidebarItemCategory:"theme-doc-sidebar-item-category",docSidebarItemLink:"theme-doc-sidebar-item-link",docSidebarItemCategoryLevel:e=>`theme-doc-sidebar-item-category-level-${e}`,docSidebarItemLinkLevel:e=>`theme-doc-sidebar-item-link-level-${e}`},blog:{blogFooterTagsRow:"theme-blog-footer-tags-row",blogFooterEditMetaRow:"theme-blog-footer-edit-meta-row"},pages:{pageFooterEditMetaRow:"theme-pages-footer-edit-meta-row"}}},3109:(e,t,n)=>{"use strict";function r(){return window.matchMedia("(prefers-reduced-motion: reduce)").matches}n.d(t,{O:()=>r})},1754:(e,t,n)=>{"use strict";n.d(t,{Nr:()=>p,w8:()=>g,C5:()=>f,B5:()=>_,Vd:()=>k,QB:()=>S,fW:()=>x,OF:()=>w,Y:()=>v});var r=n(6540),o=n(6347),a=n(2831),i=n(8295),s=n(5597),l=n(2252),c=n(4207);function u(e){return Array.from(new Set(e))}var d=n(9169);const f=!!i.Gy;function p(e){return"link"!==e.type||e.unlisted?"category"===e.type?function(e){if(e.href&&!e.linkUnlisted)return e.href;for(const t of e.items){const e=p(t);if(e)return e}}(e):void 0:e.href}const h=(e,t)=>void 0!==e&&(0,d.ys)(e,t),m=(e,t)=>e.some((e=>g(e,t)));function g(e,t){return"link"===e.type?h(e.href,t):"category"===e.type&&(h(e.href,t)||m(e.items,t))}function b(e,t){switch(e.type){case"category":return g(e,t)||e.items.some((e=>b(e,t)));case"link":return!e.unlisted||g(e,t);default:return!0}}function v(e,t){return(0,r.useMemo)((()=>e.filter((e=>b(e,t)))),[e,t])}function y(e){let{sidebarItems:t,pathname:n,onlyCategories:r=!1}=e;const o=[];return function e(t){for(const a of t)if("category"===a.type&&((0,d.ys)(a.href,n)||e(a.items))||"link"===a.type&&(0,d.ys)(a.href,n)){return r&&"category"!==a.type||o.unshift(a),!0}return!1}(t),o}function w(){const e=(0,c.t)(),{pathname:t}=(0,o.zy)(),n=(0,i.vT)()?.pluginData.breadcrumbs;return!1!==n&&e?y({sidebarItems:e.items,pathname:t}):null}function k(e){const{activeVersion:t}=(0,i.zK)(e),{preferredVersion:n}=(0,s.g1)(e),o=(0,i.r7)(e);return(0,r.useMemo)((()=>u([t,n,o].filter(Boolean))),[t,n,o])}function x(e,t){const n=k(t);return(0,r.useMemo)((()=>{const t=n.flatMap((e=>e.sidebars?Object.entries(e.sidebars):[])),r=t.find((t=>t[0]===e));if(!r)throw new Error(`Can't find any sidebar with id "${e}" in version${n.length>1?"s":""} ${n.map((e=>e.name)).join(", ")}".\nAvailable sidebar ids are:\n- ${t.map((e=>e[0])).join("\n- ")}`);return r[1]}),[e,n])}function S(e,t){const n=k(t);return(0,r.useMemo)((()=>{const t=n.flatMap((e=>e.docs)),r=t.find((t=>t.id===e));if(!r){if(n.flatMap((e=>e.draftIds)).includes(e))return null;throw new Error(`Couldn't find any doc with id "${e}" in version${n.length>1?"s":""} "${n.map((e=>e.name)).join(", ")}".\nAvailable doc ids are:\n- ${u(t.map((e=>e.id))).join("\n- ")}`)}return r}),[e,n])}function _(e){let{route:t}=e;const n=(0,o.zy)(),r=(0,l.r)(),i=t.routes,s=i.find((e=>(0,o.B6)(n.pathname,e)));if(!s)return null;const c=s.sidebar,u=c?r.docsSidebars[c]:void 0;return{docElement:(0,a.v)(i),sidebarName:c,sidebarItems:u}}},1003:(e,t,n)=>{"use strict";n.d(t,{e3:()=>p,be:()=>d,Jx:()=>h});var r=n(6540),o=n(4164),a=n(5260),i=n(3102);function s(){const e=r.useContext(i.o);if(!e)throw new Error("Unexpected: no Docusaurus route context found");return e}var l=n(6025),c=n(4586);var u=n(4848);function d(e){let{title:t,description:n,keywords:r,image:o,children:i}=e;const s=function(e){const{siteConfig:t}=(0,c.A)(),{title:n,titleDelimiter:r}=t;return e?.trim().length?`${e.trim()} ${r} ${n}`:n}(t),{withBaseUrl:d}=(0,l.h)(),f=o?d(o,{absolute:!0}):void 0;return(0,u.jsxs)(a.A,{children:[t&&(0,u.jsx)("title",{children:s}),t&&(0,u.jsx)("meta",{property:"og:title",content:s}),n&&(0,u.jsx)("meta",{name:"description",content:n}),n&&(0,u.jsx)("meta",{property:"og:description",content:n}),r&&(0,u.jsx)("meta",{name:"keywords",content:Array.isArray(r)?r.join(","):r}),f&&(0,u.jsx)("meta",{property:"og:image",content:f}),f&&(0,u.jsx)("meta",{name:"twitter:image",content:f}),i]})}const f=r.createContext(void 0);function p(e){let{className:t,children:n}=e;const i=r.useContext(f),s=(0,o.A)(i,t);return(0,u.jsxs)(f.Provider,{value:s,children:[(0,u.jsx)(a.A,{children:(0,u.jsx)("html",{className:s})}),n]})}function h(e){let{children:t}=e;const n=s(),r=`plugin-${n.plugin.name.replace(/docusaurus-(?:plugin|theme)-(?:content-)?/gi,"")}`;const a=`plugin-id-${n.plugin.id}`;return(0,u.jsx)(p,{className:(0,o.A)(r,a),children:t})}},9532:(e,t,n)=>{"use strict";n.d(t,{Be:()=>c,ZC:()=>s,_q:()=>i,dV:()=>l,fM:()=>u});var r=n(6540),o=n(205),a=n(4848);function i(e){const t=(0,r.useRef)(e);return(0,o.A)((()=>{t.current=e}),[e]),(0,r.useCallback)((function(){return t.current(...arguments)}),[])}function s(e){const t=(0,r.useRef)();return(0,o.A)((()=>{t.current=e})),t.current}class l extends Error{constructor(e,t){super(),this.name="ReactContextError",this.message=`Hook ${this.stack?.split("\n")[1]?.match(/at (?:\w+\.)?(?\w+)/)?.groups.name??""} is called outside the <${e}>. ${t??""}`}}function c(e){const t=Object.entries(e);return t.sort(((e,t)=>e[0].localeCompare(t[0]))),(0,r.useMemo)((()=>e),t.flat())}function u(e){return t=>{let{children:n}=t;return(0,a.jsx)(a.Fragment,{children:e.reduceRight(((e,t)=>(0,a.jsx)(t,{children:e})),n)})}}},9169:(e,t,n)=>{"use strict";n.d(t,{Dt:()=>s,ys:()=>i});var r=n(6540),o=n(8328),a=n(4586);function i(e,t){const n=e=>(!e||e.endsWith("/")?e:`${e}/`)?.toLowerCase();return n(e)===n(t)}function s(){const{baseUrl:e}=(0,a.A)().siteConfig;return(0,r.useMemo)((()=>function(e){let{baseUrl:t,routes:n}=e;function r(e){return e.path===t&&!0===e.exact}function o(e){return e.path===t&&!e.exact}return function e(t){if(0===t.length)return;return t.find(r)||e(t.filter(o).flatMap((e=>e.routes??[])))}(n)}({routes:o.A,baseUrl:e})),[e])}},3104:(e,t,n)=>{"use strict";n.d(t,{Mq:()=>f,Tv:()=>c,gk:()=>p});var r=n(6540),o=n(8193),a=n(2303),i=(n(205),n(9532)),s=n(4848);const l=r.createContext(void 0);function c(e){let{children:t}=e;const n=function(){const e=(0,r.useRef)(!0);return(0,r.useMemo)((()=>({scrollEventsEnabledRef:e,enableScrollEvents:()=>{e.current=!0},disableScrollEvents:()=>{e.current=!1}})),[])}();return(0,s.jsx)(l.Provider,{value:n,children:t})}function u(){const e=(0,r.useContext)(l);if(null==e)throw new i.dV("ScrollControllerProvider");return e}const d=()=>o.A.canUseDOM?{scrollX:window.pageXOffset,scrollY:window.pageYOffset}:null;function f(e,t){void 0===t&&(t=[]);const{scrollEventsEnabledRef:n}=u(),o=(0,r.useRef)(d()),a=(0,i._q)(e);(0,r.useEffect)((()=>{const e=()=>{if(!n.current)return;const e=d();a(e,o.current),o.current=e},t={passive:!0};return e(),window.addEventListener("scroll",e,t),()=>window.removeEventListener("scroll",e,t)}),[a,n,...t])}function p(){const e=(0,r.useRef)(null),t=(0,a.A)()&&"smooth"===getComputedStyle(document.documentElement).scrollBehavior;return{startScroll:n=>{e.current=t?function(e){return window.scrollTo({top:e,behavior:"smooth"}),()=>{}}(n):function(e){let t=null;const n=document.documentElement.scrollTop>e;return function r(){const o=document.documentElement.scrollTop;(n&&o>e||!n&&ot&&cancelAnimationFrame(t)}(n)},cancelScroll:()=>e.current?.()}}},2967:(e,t,n)=>{"use strict";n.d(t,{Cy:()=>r,tU:()=>o});n(4586);const r="default";function o(e,t){return`docs-${e}-${t}`}},9466:(e,t,n)=>{"use strict";n.d(t,{Wf:()=>l});n(6540);const r="localStorage";function o(e){let{key:t,oldValue:n,newValue:r,storage:o}=e;if(n===r)return;const a=document.createEvent("StorageEvent");a.initStorageEvent("storage",!1,!1,t,n,r,window.location.href,o),window.dispatchEvent(a)}function a(e){if(void 0===e&&(e=r),"undefined"==typeof window)throw new Error("Browser storage is not available on Node.js/Docusaurus SSR process.");if("none"===e)return null;try{return window[e]}catch(n){return t=n,i||(console.warn("Docusaurus browser storage is not available.\nPossible reasons: running Docusaurus in an iframe, in an incognito browser session, or using too strict browser privacy settings.",t),i=!0),null}var t}let i=!1;const s={get:()=>null,set:()=>{},del:()=>{},listen:()=>()=>{}};function l(e,t){if("undefined"==typeof window)return function(e){function t(){throw new Error(`Illegal storage API usage for storage key "${e}".\nDocusaurus storage APIs are not supposed to be called on the server-rendering process.\nPlease only call storage APIs in effects and event handlers.`)}return{get:t,set:t,del:t,listen:t}}(e);const n=a(t?.persistence);return null===n?s:{get:()=>{try{return n.getItem(e)}catch(t){return console.error(`Docusaurus storage error, can't get key=${e}`,t),null}},set:t=>{try{const r=n.getItem(e);n.setItem(e,t),o({key:e,oldValue:r,newValue:t,storage:n})}catch(r){console.error(`Docusaurus storage error, can't set ${e}=${t}`,r)}},del:()=>{try{const t=n.getItem(e);n.removeItem(e),o({key:e,oldValue:t,newValue:null,storage:n})}catch(t){console.error(`Docusaurus storage error, can't delete key=${e}`,t)}},listen:t=>{try{const r=r=>{r.storageArea===n&&r.key===e&&t(r)};return window.addEventListener("storage",r),()=>window.removeEventListener("storage",r)}catch(r){return console.error(`Docusaurus storage error, can't listen for changes of key=${e}`,r),()=>{}}}}}},2131:(e,t,n)=>{"use strict";n.d(t,{o:()=>i});var r=n(4586),o=n(6347),a=n(440);function i(){const{siteConfig:{baseUrl:e,url:t,trailingSlash:n},i18n:{defaultLocale:i,currentLocale:s}}=(0,r.A)(),{pathname:l}=(0,o.zy)(),c=(0,a.applyTrailingSlash)(l,{trailingSlash:n,baseUrl:e}),u=s===i?e:e.replace(`/${s}/`,"/"),d=c.replace(e,"");return{createUrl:function(e){let{locale:n,fullyQualified:r}=e;return`${r?t:""}${function(e){return e===i?`${u}`:`${u}${e}/`}(n)}${d}`}}}},5062:(e,t,n)=>{"use strict";n.d(t,{$:()=>i});var r=n(6540),o=n(6347),a=n(9532);function i(e){const t=(0,o.zy)(),n=(0,a.ZC)(t),i=(0,a._q)(e);(0,r.useEffect)((()=>{n&&t!==n&&i({location:t,previousLocation:n})}),[i,t,n])}},6342:(e,t,n)=>{"use strict";n.d(t,{p:()=>o});var r=n(4586);function o(){return(0,r.A)().siteConfig.themeConfig}},2983:(e,t,n)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.removeTrailingSlash=t.addLeadingSlash=t.addTrailingSlash=void 0;const r=n(2566);function o(e){return e.endsWith("/")?e:`${e}/`}function a(e){return(0,r.removeSuffix)(e,"/")}t.addTrailingSlash=o,t.default=function(e,t){const{trailingSlash:n,baseUrl:r}=t;if(e.startsWith("#"))return e;if(void 0===n)return e;const[i]=e.split(/[#?]/),s="/"===i||i===r?i:(l=i,n?o(l):a(l));var l;return e.replace(i,s)},t.addLeadingSlash=function(e){return(0,r.addPrefix)(e,"/")},t.removeTrailingSlash=a},253:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=void 0,t.getErrorCausalChain=function e(t){return t.cause?[t,...e(t.cause)]:[t]}},440:function(e,t,n){"use strict";var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=t.removePrefix=t.addSuffix=t.removeSuffix=t.addPrefix=t.removeTrailingSlash=t.addLeadingSlash=t.addTrailingSlash=t.applyTrailingSlash=t.blogPostContainerID=void 0,t.blogPostContainerID="__blog-post-container";var o=n(2983);Object.defineProperty(t,"applyTrailingSlash",{enumerable:!0,get:function(){return r(o).default}}),Object.defineProperty(t,"addTrailingSlash",{enumerable:!0,get:function(){return o.addTrailingSlash}}),Object.defineProperty(t,"addLeadingSlash",{enumerable:!0,get:function(){return o.addLeadingSlash}}),Object.defineProperty(t,"removeTrailingSlash",{enumerable:!0,get:function(){return o.removeTrailingSlash}});var a=n(2566);Object.defineProperty(t,"addPrefix",{enumerable:!0,get:function(){return a.addPrefix}}),Object.defineProperty(t,"removeSuffix",{enumerable:!0,get:function(){return a.removeSuffix}}),Object.defineProperty(t,"addSuffix",{enumerable:!0,get:function(){return a.addSuffix}}),Object.defineProperty(t,"removePrefix",{enumerable:!0,get:function(){return a.removePrefix}});var i=n(253);Object.defineProperty(t,"getErrorCausalChain",{enumerable:!0,get:function(){return i.getErrorCausalChain}})},2566:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.removePrefix=t.addSuffix=t.removeSuffix=t.addPrefix=void 0,t.addPrefix=function(e,t){return e.startsWith(t)?e:`${t}${e}`},t.removeSuffix=function(e,t){return""===t?e:e.endsWith(t)?e.slice(0,-t.length):e},t.addSuffix=function(e,t){return e.endsWith(t)?e:`${e}${t}`},t.removePrefix=function(e,t){return e.startsWith(t)?e.slice(t.length):e}},1513:(e,t,n)=>{"use strict";n.d(t,{zR:()=>w,TM:()=>C,yJ:()=>p,sC:()=>A,AO:()=>f});var r=n(8168);function o(e){return"/"===e.charAt(0)}function a(e,t){for(var n=t,r=n+1,o=e.length;r=0;f--){var p=i[f];"."===p?a(i,f):".."===p?(a(i,f),d++):d&&(a(i,f),d--)}if(!c)for(;d--;d)i.unshift("..");!c||""===i[0]||i[0]&&o(i[0])||i.unshift("");var h=i.join("/");return n&&"/"!==h.substr(-1)&&(h+="/"),h};var s=n(1561);function l(e){return"/"===e.charAt(0)?e:"/"+e}function c(e){return"/"===e.charAt(0)?e.substr(1):e}function u(e,t){return function(e,t){return 0===e.toLowerCase().indexOf(t.toLowerCase())&&-1!=="/?#".indexOf(e.charAt(t.length))}(e,t)?e.substr(t.length):e}function d(e){return"/"===e.charAt(e.length-1)?e.slice(0,-1):e}function f(e){var t=e.pathname,n=e.search,r=e.hash,o=t||"/";return n&&"?"!==n&&(o+="?"===n.charAt(0)?n:"?"+n),r&&"#"!==r&&(o+="#"===r.charAt(0)?r:"#"+r),o}function p(e,t,n,o){var a;"string"==typeof e?(a=function(e){var t=e||"/",n="",r="",o=t.indexOf("#");-1!==o&&(r=t.substr(o),t=t.substr(0,o));var a=t.indexOf("?");return-1!==a&&(n=t.substr(a),t=t.substr(0,a)),{pathname:t,search:"?"===n?"":n,hash:"#"===r?"":r}}(e),a.state=t):(void 0===(a=(0,r.A)({},e)).pathname&&(a.pathname=""),a.search?"?"!==a.search.charAt(0)&&(a.search="?"+a.search):a.search="",a.hash?"#"!==a.hash.charAt(0)&&(a.hash="#"+a.hash):a.hash="",void 0!==t&&void 0===a.state&&(a.state=t));try{a.pathname=decodeURI(a.pathname)}catch(s){throw s instanceof URIError?new URIError('Pathname "'+a.pathname+'" could not be decoded. This is likely caused by an invalid percent-encoding.'):s}return n&&(a.key=n),o?a.pathname?"/"!==a.pathname.charAt(0)&&(a.pathname=i(a.pathname,o.pathname)):a.pathname=o.pathname:a.pathname||(a.pathname="/"),a}function h(){var e=null;var t=[];return{setPrompt:function(t){return e=t,function(){e===t&&(e=null)}},confirmTransitionTo:function(t,n,r,o){if(null!=e){var a="function"==typeof e?e(t,n):e;"string"==typeof a?"function"==typeof r?r(a,o):o(!0):o(!1!==a)}else o(!0)},appendListener:function(e){var n=!0;function r(){n&&e.apply(void 0,arguments)}return t.push(r),function(){n=!1,t=t.filter((function(e){return e!==r}))}},notifyListeners:function(){for(var e=arguments.length,n=new Array(e),r=0;rt?n.splice(t,n.length-t,o):n.push(o),d({action:r,location:o,index:t,entries:n})}}))},replace:function(e,t){var r="REPLACE",o=p(e,t,m(),w.location);u.confirmTransitionTo(o,r,n,(function(e){e&&(w.entries[w.index]=o,d({action:r,location:o}))}))},go:y,goBack:function(){y(-1)},goForward:function(){y(1)},canGo:function(e){var t=w.index+e;return t>=0&&t{"use strict";var r=n(4363),o={childContextTypes:!0,contextType:!0,contextTypes:!0,defaultProps:!0,displayName:!0,getDefaultProps:!0,getDerivedStateFromError:!0,getDerivedStateFromProps:!0,mixins:!0,propTypes:!0,type:!0},a={name:!0,length:!0,prototype:!0,caller:!0,callee:!0,arguments:!0,arity:!0},i={$$typeof:!0,compare:!0,defaultProps:!0,displayName:!0,propTypes:!0,type:!0},s={};function l(e){return r.isMemo(e)?i:s[e.$$typeof]||o}s[r.ForwardRef]={$$typeof:!0,render:!0,defaultProps:!0,displayName:!0,propTypes:!0},s[r.Memo]=i;var c=Object.defineProperty,u=Object.getOwnPropertyNames,d=Object.getOwnPropertySymbols,f=Object.getOwnPropertyDescriptor,p=Object.getPrototypeOf,h=Object.prototype;e.exports=function e(t,n,r){if("string"!=typeof n){if(h){var o=p(n);o&&o!==h&&e(t,o,r)}var i=u(n);d&&(i=i.concat(d(n)));for(var s=l(t),m=l(n),g=0;g{"use strict";e.exports=function(e,t,n,r,o,a,i,s){if(!e){var l;if(void 0===t)l=new Error("Minified exception occurred; use the non-minified dev environment for the full error message and additional helpful warnings.");else{var c=[n,r,o,a,i,s],u=0;(l=new Error(t.replace(/%s/g,(function(){return c[u++]})))).name="Invariant Violation"}throw l.framesToPop=1,l}}},4634:e=>{e.exports=Array.isArray||function(e){return"[object Array]"==Object.prototype.toString.call(e)}},689:function(e){e.exports=function(){"use strict";var e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},t=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},n=function(){function e(e,t){for(var n=0;n1&&void 0!==arguments[1])||arguments[1],o=arguments.length>2&&void 0!==arguments[2]?arguments[2]:[],a=arguments.length>3&&void 0!==arguments[3]?arguments[3]:5e3;t(this,e),this.ctx=n,this.iframes=r,this.exclude=o,this.iframesTimeout=a}return n(e,[{key:"getContexts",value:function(){var e=[];return(void 0!==this.ctx&&this.ctx?NodeList.prototype.isPrototypeOf(this.ctx)?Array.prototype.slice.call(this.ctx):Array.isArray(this.ctx)?this.ctx:"string"==typeof this.ctx?Array.prototype.slice.call(document.querySelectorAll(this.ctx)):[this.ctx]:[]).forEach((function(t){var n=e.filter((function(e){return e.contains(t)})).length>0;-1!==e.indexOf(t)||n||e.push(t)})),e}},{key:"getIframeContents",value:function(e,t){var n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:function(){},r=void 0;try{var o=e.contentWindow;if(r=o.document,!o||!r)throw new Error("iframe inaccessible")}catch(a){n()}r&&t(r)}},{key:"isIframeBlank",value:function(e){var t="about:blank",n=e.getAttribute("src").trim();return e.contentWindow.location.href===t&&n!==t&&n}},{key:"observeIframeLoad",value:function(e,t,n){var r=this,o=!1,a=null,i=function i(){if(!o){o=!0,clearTimeout(a);try{r.isIframeBlank(e)||(e.removeEventListener("load",i),r.getIframeContents(e,t,n))}catch(s){n()}}};e.addEventListener("load",i),a=setTimeout(i,this.iframesTimeout)}},{key:"onIframeReady",value:function(e,t,n){try{"complete"===e.contentWindow.document.readyState?this.isIframeBlank(e)?this.observeIframeLoad(e,t,n):this.getIframeContents(e,t,n):this.observeIframeLoad(e,t,n)}catch(r){n()}}},{key:"waitForIframes",value:function(e,t){var n=this,r=0;this.forEachIframe(e,(function(){return!0}),(function(e){r++,n.waitForIframes(e.querySelector("html"),(function(){--r||t()}))}),(function(e){e||t()}))}},{key:"forEachIframe",value:function(t,n,r){var o=this,a=arguments.length>3&&void 0!==arguments[3]?arguments[3]:function(){},i=t.querySelectorAll("iframe"),s=i.length,l=0;i=Array.prototype.slice.call(i);var c=function(){--s<=0&&a(l)};s||c(),i.forEach((function(t){e.matches(t,o.exclude)?c():o.onIframeReady(t,(function(e){n(t)&&(l++,r(e)),c()}),c)}))}},{key:"createIterator",value:function(e,t,n){return document.createNodeIterator(e,t,n,!1)}},{key:"createInstanceOnIframe",value:function(t){return new e(t.querySelector("html"),this.iframes)}},{key:"compareNodeIframe",value:function(e,t,n){if(e.compareDocumentPosition(n)&Node.DOCUMENT_POSITION_PRECEDING){if(null===t)return!0;if(t.compareDocumentPosition(n)&Node.DOCUMENT_POSITION_FOLLOWING)return!0}return!1}},{key:"getIteratorNode",value:function(e){var t=e.previousNode();return{prevNode:t,node:(null===t||e.nextNode())&&e.nextNode()}}},{key:"checkIframeFilter",value:function(e,t,n,r){var o=!1,a=!1;return r.forEach((function(e,t){e.val===n&&(o=t,a=e.handled)})),this.compareNodeIframe(e,t,n)?(!1!==o||a?!1===o||a||(r[o].handled=!0):r.push({val:n,handled:!0}),!0):(!1===o&&r.push({val:n,handled:!1}),!1)}},{key:"handleOpenIframes",value:function(e,t,n,r){var o=this;e.forEach((function(e){e.handled||o.getIframeContents(e.val,(function(e){o.createInstanceOnIframe(e).forEachNode(t,n,r)}))}))}},{key:"iterateThroughNodes",value:function(e,t,n,r,o){for(var a=this,i=this.createIterator(t,e,r),s=[],l=[],c=void 0,u=void 0,d=function(){var e=a.getIteratorNode(i);return u=e.prevNode,c=e.node};d();)this.iframes&&this.forEachIframe(t,(function(e){return a.checkIframeFilter(c,u,e,s)}),(function(t){a.createInstanceOnIframe(t).forEachNode(e,(function(e){return l.push(e)}),r)})),l.push(c);l.forEach((function(e){n(e)})),this.iframes&&this.handleOpenIframes(s,e,n,r),o()}},{key:"forEachNode",value:function(e,t,n){var r=this,o=arguments.length>3&&void 0!==arguments[3]?arguments[3]:function(){},a=this.getContexts(),i=a.length;i||o(),a.forEach((function(a){var s=function(){r.iterateThroughNodes(e,a,t,n,(function(){--i<=0&&o()}))};r.iframes?r.waitForIframes(a,s):s()}))}}],[{key:"matches",value:function(e,t){var n="string"==typeof t?[t]:t,r=e.matches||e.matchesSelector||e.msMatchesSelector||e.mozMatchesSelector||e.oMatchesSelector||e.webkitMatchesSelector;if(r){var o=!1;return n.every((function(t){return!r.call(e,t)||(o=!0,!1)})),o}return!1}}]),e}(),a=function(){function a(e){t(this,a),this.ctx=e,this.ie=!1;var n=window.navigator.userAgent;(n.indexOf("MSIE")>-1||n.indexOf("Trident")>-1)&&(this.ie=!0)}return n(a,[{key:"log",value:function(t){var n=arguments.length>1&&void 0!==arguments[1]?arguments[1]:"debug",r=this.opt.log;this.opt.debug&&"object"===(void 0===r?"undefined":e(r))&&"function"==typeof r[n]&&r[n]("mark.js: "+t)}},{key:"escapeStr",value:function(e){return e.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g,"\\$&")}},{key:"createRegExp",value:function(e){return"disabled"!==this.opt.wildcards&&(e=this.setupWildcardsRegExp(e)),e=this.escapeStr(e),Object.keys(this.opt.synonyms).length&&(e=this.createSynonymsRegExp(e)),(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length)&&(e=this.setupIgnoreJoinersRegExp(e)),this.opt.diacritics&&(e=this.createDiacriticsRegExp(e)),e=this.createMergedBlanksRegExp(e),(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length)&&(e=this.createJoinersRegExp(e)),"disabled"!==this.opt.wildcards&&(e=this.createWildcardsRegExp(e)),e=this.createAccuracyRegExp(e)}},{key:"createSynonymsRegExp",value:function(e){var t=this.opt.synonyms,n=this.opt.caseSensitive?"":"i",r=this.opt.ignoreJoiners||this.opt.ignorePunctuation.length?"\0":"";for(var o in t)if(t.hasOwnProperty(o)){var a=t[o],i="disabled"!==this.opt.wildcards?this.setupWildcardsRegExp(o):this.escapeStr(o),s="disabled"!==this.opt.wildcards?this.setupWildcardsRegExp(a):this.escapeStr(a);""!==i&&""!==s&&(e=e.replace(new RegExp("("+this.escapeStr(i)+"|"+this.escapeStr(s)+")","gm"+n),r+"("+this.processSynomyms(i)+"|"+this.processSynomyms(s)+")"+r))}return e}},{key:"processSynomyms",value:function(e){return(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length)&&(e=this.setupIgnoreJoinersRegExp(e)),e}},{key:"setupWildcardsRegExp",value:function(e){return(e=e.replace(/(?:\\)*\?/g,(function(e){return"\\"===e.charAt(0)?"?":"\x01"}))).replace(/(?:\\)*\*/g,(function(e){return"\\"===e.charAt(0)?"*":"\x02"}))}},{key:"createWildcardsRegExp",value:function(e){var t="withSpaces"===this.opt.wildcards;return e.replace(/\u0001/g,t?"[\\S\\s]?":"\\S?").replace(/\u0002/g,t?"[\\S\\s]*?":"\\S*")}},{key:"setupIgnoreJoinersRegExp",value:function(e){return e.replace(/[^(|)\\]/g,(function(e,t,n){var r=n.charAt(t+1);return/[(|)\\]/.test(r)||""===r?e:e+"\0"}))}},{key:"createJoinersRegExp",value:function(e){var t=[],n=this.opt.ignorePunctuation;return Array.isArray(n)&&n.length&&t.push(this.escapeStr(n.join(""))),this.opt.ignoreJoiners&&t.push("\\u00ad\\u200b\\u200c\\u200d"),t.length?e.split(/\u0000+/).join("["+t.join("")+"]*"):e}},{key:"createDiacriticsRegExp",value:function(e){var t=this.opt.caseSensitive?"":"i",n=this.opt.caseSensitive?["a\xe0\xe1\u1ea3\xe3\u1ea1\u0103\u1eb1\u1eaf\u1eb3\u1eb5\u1eb7\xe2\u1ea7\u1ea5\u1ea9\u1eab\u1ead\xe4\xe5\u0101\u0105","A\xc0\xc1\u1ea2\xc3\u1ea0\u0102\u1eb0\u1eae\u1eb2\u1eb4\u1eb6\xc2\u1ea6\u1ea4\u1ea8\u1eaa\u1eac\xc4\xc5\u0100\u0104","c\xe7\u0107\u010d","C\xc7\u0106\u010c","d\u0111\u010f","D\u0110\u010e","e\xe8\xe9\u1ebb\u1ebd\u1eb9\xea\u1ec1\u1ebf\u1ec3\u1ec5\u1ec7\xeb\u011b\u0113\u0119","E\xc8\xc9\u1eba\u1ebc\u1eb8\xca\u1ec0\u1ebe\u1ec2\u1ec4\u1ec6\xcb\u011a\u0112\u0118","i\xec\xed\u1ec9\u0129\u1ecb\xee\xef\u012b","I\xcc\xcd\u1ec8\u0128\u1eca\xce\xcf\u012a","l\u0142","L\u0141","n\xf1\u0148\u0144","N\xd1\u0147\u0143","o\xf2\xf3\u1ecf\xf5\u1ecd\xf4\u1ed3\u1ed1\u1ed5\u1ed7\u1ed9\u01a1\u1edf\u1ee1\u1edb\u1edd\u1ee3\xf6\xf8\u014d","O\xd2\xd3\u1ece\xd5\u1ecc\xd4\u1ed2\u1ed0\u1ed4\u1ed6\u1ed8\u01a0\u1ede\u1ee0\u1eda\u1edc\u1ee2\xd6\xd8\u014c","r\u0159","R\u0158","s\u0161\u015b\u0219\u015f","S\u0160\u015a\u0218\u015e","t\u0165\u021b\u0163","T\u0164\u021a\u0162","u\xf9\xfa\u1ee7\u0169\u1ee5\u01b0\u1eeb\u1ee9\u1eed\u1eef\u1ef1\xfb\xfc\u016f\u016b","U\xd9\xda\u1ee6\u0168\u1ee4\u01af\u1eea\u1ee8\u1eec\u1eee\u1ef0\xdb\xdc\u016e\u016a","y\xfd\u1ef3\u1ef7\u1ef9\u1ef5\xff","Y\xdd\u1ef2\u1ef6\u1ef8\u1ef4\u0178","z\u017e\u017c\u017a","Z\u017d\u017b\u0179"]:["a\xe0\xe1\u1ea3\xe3\u1ea1\u0103\u1eb1\u1eaf\u1eb3\u1eb5\u1eb7\xe2\u1ea7\u1ea5\u1ea9\u1eab\u1ead\xe4\xe5\u0101\u0105A\xc0\xc1\u1ea2\xc3\u1ea0\u0102\u1eb0\u1eae\u1eb2\u1eb4\u1eb6\xc2\u1ea6\u1ea4\u1ea8\u1eaa\u1eac\xc4\xc5\u0100\u0104","c\xe7\u0107\u010dC\xc7\u0106\u010c","d\u0111\u010fD\u0110\u010e","e\xe8\xe9\u1ebb\u1ebd\u1eb9\xea\u1ec1\u1ebf\u1ec3\u1ec5\u1ec7\xeb\u011b\u0113\u0119E\xc8\xc9\u1eba\u1ebc\u1eb8\xca\u1ec0\u1ebe\u1ec2\u1ec4\u1ec6\xcb\u011a\u0112\u0118","i\xec\xed\u1ec9\u0129\u1ecb\xee\xef\u012bI\xcc\xcd\u1ec8\u0128\u1eca\xce\xcf\u012a","l\u0142L\u0141","n\xf1\u0148\u0144N\xd1\u0147\u0143","o\xf2\xf3\u1ecf\xf5\u1ecd\xf4\u1ed3\u1ed1\u1ed5\u1ed7\u1ed9\u01a1\u1edf\u1ee1\u1edb\u1edd\u1ee3\xf6\xf8\u014dO\xd2\xd3\u1ece\xd5\u1ecc\xd4\u1ed2\u1ed0\u1ed4\u1ed6\u1ed8\u01a0\u1ede\u1ee0\u1eda\u1edc\u1ee2\xd6\xd8\u014c","r\u0159R\u0158","s\u0161\u015b\u0219\u015fS\u0160\u015a\u0218\u015e","t\u0165\u021b\u0163T\u0164\u021a\u0162","u\xf9\xfa\u1ee7\u0169\u1ee5\u01b0\u1eeb\u1ee9\u1eed\u1eef\u1ef1\xfb\xfc\u016f\u016bU\xd9\xda\u1ee6\u0168\u1ee4\u01af\u1eea\u1ee8\u1eec\u1eee\u1ef0\xdb\xdc\u016e\u016a","y\xfd\u1ef3\u1ef7\u1ef9\u1ef5\xffY\xdd\u1ef2\u1ef6\u1ef8\u1ef4\u0178","z\u017e\u017c\u017aZ\u017d\u017b\u0179"],r=[];return e.split("").forEach((function(o){n.every((function(n){if(-1!==n.indexOf(o)){if(r.indexOf(n)>-1)return!1;e=e.replace(new RegExp("["+n+"]","gm"+t),"["+n+"]"),r.push(n)}return!0}))})),e}},{key:"createMergedBlanksRegExp",value:function(e){return e.replace(/[\s]+/gim,"[\\s]+")}},{key:"createAccuracyRegExp",value:function(e){var t=this,n="!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~\xa1\xbf",r=this.opt.accuracy,o="string"==typeof r?r:r.value,a="string"==typeof r?[]:r.limiters,i="";switch(a.forEach((function(e){i+="|"+t.escapeStr(e)})),o){case"partially":default:return"()("+e+")";case"complementary":return"()([^"+(i="\\s"+(i||this.escapeStr(n)))+"]*"+e+"[^"+i+"]*)";case"exactly":return"(^|\\s"+i+")("+e+")(?=$|\\s"+i+")"}}},{key:"getSeparatedKeywords",value:function(e){var t=this,n=[];return e.forEach((function(e){t.opt.separateWordSearch?e.split(" ").forEach((function(e){e.trim()&&-1===n.indexOf(e)&&n.push(e)})):e.trim()&&-1===n.indexOf(e)&&n.push(e)})),{keywords:n.sort((function(e,t){return t.length-e.length})),length:n.length}}},{key:"isNumeric",value:function(e){return Number(parseFloat(e))==e}},{key:"checkRanges",value:function(e){var t=this;if(!Array.isArray(e)||"[object Object]"!==Object.prototype.toString.call(e[0]))return this.log("markRanges() will only accept an array of objects"),this.opt.noMatch(e),[];var n=[],r=0;return e.sort((function(e,t){return e.start-t.start})).forEach((function(e){var o=t.callNoMatchOnInvalidRanges(e,r),a=o.start,i=o.end;o.valid&&(e.start=a,e.length=i-a,n.push(e),r=i)})),n}},{key:"callNoMatchOnInvalidRanges",value:function(e,t){var n=void 0,r=void 0,o=!1;return e&&void 0!==e.start?(r=(n=parseInt(e.start,10))+parseInt(e.length,10),this.isNumeric(e.start)&&this.isNumeric(e.length)&&r-t>0&&r-n>0?o=!0:(this.log("Ignoring invalid or overlapping range: "+JSON.stringify(e)),this.opt.noMatch(e))):(this.log("Ignoring invalid range: "+JSON.stringify(e)),this.opt.noMatch(e)),{start:n,end:r,valid:o}}},{key:"checkWhitespaceRanges",value:function(e,t,n){var r=void 0,o=!0,a=n.length,i=t-a,s=parseInt(e.start,10)-i;return(r=(s=s>a?a:s)+parseInt(e.length,10))>a&&(r=a,this.log("End range automatically set to the max value of "+a)),s<0||r-s<0||s>a||r>a?(o=!1,this.log("Invalid range: "+JSON.stringify(e)),this.opt.noMatch(e)):""===n.substring(s,r).replace(/\s+/g,"")&&(o=!1,this.log("Skipping whitespace only range: "+JSON.stringify(e)),this.opt.noMatch(e)),{start:s,end:r,valid:o}}},{key:"getTextNodes",value:function(e){var t=this,n="",r=[];this.iterator.forEachNode(NodeFilter.SHOW_TEXT,(function(e){r.push({start:n.length,end:(n+=e.textContent).length,node:e})}),(function(e){return t.matchesExclude(e.parentNode)?NodeFilter.FILTER_REJECT:NodeFilter.FILTER_ACCEPT}),(function(){e({value:n,nodes:r})}))}},{key:"matchesExclude",value:function(e){return o.matches(e,this.opt.exclude.concat(["script","style","title","head","html"]))}},{key:"wrapRangeInTextNode",value:function(e,t,n){var r=this.opt.element?this.opt.element:"mark",o=e.splitText(t),a=o.splitText(n-t),i=document.createElement(r);return i.setAttribute("data-markjs","true"),this.opt.className&&i.setAttribute("class",this.opt.className),i.textContent=o.textContent,o.parentNode.replaceChild(i,o),a}},{key:"wrapRangeInMappedTextNode",value:function(e,t,n,r,o){var a=this;e.nodes.every((function(i,s){var l=e.nodes[s+1];if(void 0===l||l.start>t){if(!r(i.node))return!1;var c=t-i.start,u=(n>i.end?i.end:n)-i.start,d=e.value.substr(0,i.start),f=e.value.substr(u+i.start);if(i.node=a.wrapRangeInTextNode(i.node,c,u),e.value=d+f,e.nodes.forEach((function(t,n){n>=s&&(e.nodes[n].start>0&&n!==s&&(e.nodes[n].start-=u),e.nodes[n].end-=u)})),n-=u,o(i.node.previousSibling,i.start),!(n>i.end))return!1;t=i.end}return!0}))}},{key:"wrapMatches",value:function(e,t,n,r,o){var a=this,i=0===t?0:t+1;this.getTextNodes((function(t){t.nodes.forEach((function(t){t=t.node;for(var o=void 0;null!==(o=e.exec(t.textContent))&&""!==o[i];)if(n(o[i],t)){var s=o.index;if(0!==i)for(var l=1;l{"use strict";n.r(t)},1043:(e,t,n)=>{"use strict";n.r(t)},5947:function(e,t,n){var r,o;r=function(){var e,t,n={version:"0.2.0"},r=n.settings={minimum:.08,easing:"ease",positionUsing:"",speed:200,trickle:!0,trickleRate:.02,trickleSpeed:800,showSpinner:!0,barSelector:'[role="bar"]',spinnerSelector:'[role="spinner"]',parent:"body",template:'
'};function o(e,t,n){return en?n:e}function a(e){return 100*(-1+e)}function i(e,t,n){var o;return(o="translate3d"===r.positionUsing?{transform:"translate3d("+a(e)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+a(e)+"%,0)"}:{"margin-left":a(e)+"%"}).transition="all "+t+"ms "+n,o}n.configure=function(e){var t,n;for(t in e)void 0!==(n=e[t])&&e.hasOwnProperty(t)&&(r[t]=n);return this},n.status=null,n.set=function(e){var t=n.isStarted();e=o(e,r.minimum,1),n.status=1===e?null:e;var a=n.render(!t),c=a.querySelector(r.barSelector),u=r.speed,d=r.easing;return a.offsetWidth,s((function(t){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),l(c,i(e,u,d)),1===e?(l(a,{transition:"none",opacity:1}),a.offsetWidth,setTimeout((function(){l(a,{transition:"all "+u+"ms linear",opacity:0}),setTimeout((function(){n.remove(),t()}),u)}),u)):setTimeout(t,u)})),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var e=function(){setTimeout((function(){n.status&&(n.trickle(),e())}),r.trickleSpeed)};return r.trickle&&e(),this},n.done=function(e){return e||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(e){var t=n.status;return t?("number"!=typeof e&&(e=(1-t)*o(Math.random()*t,.1,.95)),t=o(t+e,0,.994),n.set(t)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},e=0,t=0,n.promise=function(r){return r&&"resolved"!==r.state()?(0===t&&n.start(),e++,t++,r.always((function(){0==--t?(e=0,n.done()):n.set((e-t)/e)})),this):this},n.render=function(e){if(n.isRendered())return document.getElementById("nprogress");u(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=r.template;var o,i=t.querySelector(r.barSelector),s=e?"-100":a(n.status||0),c=document.querySelector(r.parent);return l(i,{transition:"all 0 linear",transform:"translate3d("+s+"%,0,0)"}),r.showSpinner||(o=t.querySelector(r.spinnerSelector))&&p(o),c!=document.body&&u(c,"nprogress-custom-parent"),c.appendChild(t),t},n.remove=function(){d(document.documentElement,"nprogress-busy"),d(document.querySelector(r.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&p(e)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var s=function(){var e=[];function t(){var n=e.shift();n&&n(t)}return function(n){e.push(n),1==e.length&&t()}}(),l=function(){var e=["Webkit","O","Moz","ms"],t={};function n(e){return e.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,(function(e,t){return t.toUpperCase()}))}function r(t){var n=document.body.style;if(t in n)return t;for(var r,o=e.length,a=t.charAt(0).toUpperCase()+t.slice(1);o--;)if((r=e[o]+a)in n)return r;return t}function o(e){return e=n(e),t[e]||(t[e]=r(e))}function a(e,t,n){t=o(t),e.style[t]=n}return function(e,t){var n,r,o=arguments;if(2==o.length)for(n in t)void 0!==(r=t[n])&&t.hasOwnProperty(n)&&a(e,n,r);else a(e,o[1],o[2])}}();function c(e,t){return("string"==typeof e?e:f(e)).indexOf(" "+t+" ")>=0}function u(e,t){var n=f(e),r=n+t;c(n,t)||(e.className=r.substring(1))}function d(e,t){var n,r=f(e);c(e,t)&&(n=r.replace(" "+t+" "," "),e.className=n.substring(1,n.length-1))}function f(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function p(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return n},void 0===(o="function"==typeof r?r.call(t,n,t,e):r)||(e.exports=o)},5302:(e,t,n)=>{var r=n(4634);e.exports=p,e.exports.parse=a,e.exports.compile=function(e,t){return s(a(e,t),t)},e.exports.tokensToFunction=s,e.exports.tokensToRegExp=f;var o=new RegExp(["(\\\\.)","([\\/.])?(?:(?:\\:(\\w+)(?:\\(((?:\\\\.|[^\\\\()])+)\\))?|\\(((?:\\\\.|[^\\\\()])+)\\))([+*?])?|(\\*))"].join("|"),"g");function a(e,t){for(var n,r=[],a=0,i=0,s="",u=t&&t.delimiter||"/";null!=(n=o.exec(e));){var d=n[0],f=n[1],p=n.index;if(s+=e.slice(i,p),i=p+d.length,f)s+=f[1];else{var h=e[i],m=n[2],g=n[3],b=n[4],v=n[5],y=n[6],w=n[7];s&&(r.push(s),s="");var k=null!=m&&null!=h&&h!==m,x="+"===y||"*"===y,S="?"===y||"*"===y,_=n[2]||u,E=b||v;r.push({name:g||a++,prefix:m||"",delimiter:_,optional:S,repeat:x,partial:k,asterisk:!!w,pattern:E?c(E):w?".*":"[^"+l(_)+"]+?"})}}return i{e.exports&&(e.exports={core:{meta:{path:"components/prism-core.js",option:"mandatory"},core:"Core"},themes:{meta:{path:"themes/{id}.css",link:"index.html?theme={id}",exclusive:!0},prism:{title:"Default",option:"default"},"prism-dark":"Dark","prism-funky":"Funky","prism-okaidia":{title:"Okaidia",owner:"ocodia"},"prism-twilight":{title:"Twilight",owner:"remybach"},"prism-coy":{title:"Coy",owner:"tshedor"},"prism-solarizedlight":{title:"Solarized Light",owner:"hectormatos2011 "},"prism-tomorrow":{title:"Tomorrow Night",owner:"Rosey"}},languages:{meta:{path:"components/prism-{id}",noCSS:!0,examplesPath:"examples/prism-{id}",addCheckAll:!0},markup:{title:"Markup",alias:["html","xml","svg","mathml","ssml","atom","rss"],aliasTitles:{html:"HTML",xml:"XML",svg:"SVG",mathml:"MathML",ssml:"SSML",atom:"Atom",rss:"RSS"},option:"default"},css:{title:"CSS",option:"default",modify:"markup"},clike:{title:"C-like",option:"default"},javascript:{title:"JavaScript",require:"clike",modify:"markup",optional:"regex",alias:"js",option:"default"},abap:{title:"ABAP",owner:"dellagustin"},abnf:{title:"ABNF",owner:"RunDevelopment"},actionscript:{title:"ActionScript",require:"javascript",modify:"markup",owner:"Golmote"},ada:{title:"Ada",owner:"Lucretia"},agda:{title:"Agda",owner:"xy-ren"},al:{title:"AL",owner:"RunDevelopment"},antlr4:{title:"ANTLR4",alias:"g4",owner:"RunDevelopment"},apacheconf:{title:"Apache Configuration",owner:"GuiTeK"},apex:{title:"Apex",require:["clike","sql"],owner:"RunDevelopment"},apl:{title:"APL",owner:"ngn"},applescript:{title:"AppleScript",owner:"Golmote"},aql:{title:"AQL",owner:"RunDevelopment"},arduino:{title:"Arduino",require:"cpp",alias:"ino",owner:"dkern"},arff:{title:"ARFF",owner:"Golmote"},armasm:{title:"ARM Assembly",alias:"arm-asm",owner:"RunDevelopment"},arturo:{title:"Arturo",alias:"art",optional:["bash","css","javascript","markup","markdown","sql"],owner:"drkameleon"},asciidoc:{alias:"adoc",title:"AsciiDoc",owner:"Golmote"},aspnet:{title:"ASP.NET (C#)",require:["markup","csharp"],owner:"nauzilus"},asm6502:{title:"6502 Assembly",owner:"kzurawel"},asmatmel:{title:"Atmel AVR Assembly",owner:"cerkit"},autohotkey:{title:"AutoHotkey",owner:"aviaryan"},autoit:{title:"AutoIt",owner:"Golmote"},avisynth:{title:"AviSynth",alias:"avs",owner:"Zinfidel"},"avro-idl":{title:"Avro IDL",alias:"avdl",owner:"RunDevelopment"},awk:{title:"AWK",alias:"gawk",aliasTitles:{gawk:"GAWK"},owner:"RunDevelopment"},bash:{title:"Bash",alias:["sh","shell"],aliasTitles:{sh:"Shell",shell:"Shell"},owner:"zeitgeist87"},basic:{title:"BASIC",owner:"Golmote"},batch:{title:"Batch",owner:"Golmote"},bbcode:{title:"BBcode",alias:"shortcode",aliasTitles:{shortcode:"Shortcode"},owner:"RunDevelopment"},bbj:{title:"BBj",owner:"hyyan"},bicep:{title:"Bicep",owner:"johnnyreilly"},birb:{title:"Birb",require:"clike",owner:"Calamity210"},bison:{title:"Bison",require:"c",owner:"Golmote"},bnf:{title:"BNF",alias:"rbnf",aliasTitles:{rbnf:"RBNF"},owner:"RunDevelopment"},bqn:{title:"BQN",owner:"yewscion"},brainfuck:{title:"Brainfuck",owner:"Golmote"},brightscript:{title:"BrightScript",owner:"RunDevelopment"},bro:{title:"Bro",owner:"wayward710"},bsl:{title:"BSL (1C:Enterprise)",alias:"oscript",aliasTitles:{oscript:"OneScript"},owner:"Diversus23"},c:{title:"C",require:"clike",owner:"zeitgeist87"},csharp:{title:"C#",require:"clike",alias:["cs","dotnet"],owner:"mvalipour"},cpp:{title:"C++",require:"c",owner:"zeitgeist87"},cfscript:{title:"CFScript",require:"clike",alias:"cfc",owner:"mjclemente"},chaiscript:{title:"ChaiScript",require:["clike","cpp"],owner:"RunDevelopment"},cil:{title:"CIL",owner:"sbrl"},cilkc:{title:"Cilk/C",require:"c",alias:"cilk-c",owner:"OpenCilk"},cilkcpp:{title:"Cilk/C++",require:"cpp",alias:["cilk-cpp","cilk"],owner:"OpenCilk"},clojure:{title:"Clojure",owner:"troglotit"},cmake:{title:"CMake",owner:"mjrogozinski"},cobol:{title:"COBOL",owner:"RunDevelopment"},coffeescript:{title:"CoffeeScript",require:"javascript",alias:"coffee",owner:"R-osey"},concurnas:{title:"Concurnas",alias:"conc",owner:"jasontatton"},csp:{title:"Content-Security-Policy",owner:"ScottHelme"},cooklang:{title:"Cooklang",owner:"ahue"},coq:{title:"Coq",owner:"RunDevelopment"},crystal:{title:"Crystal",require:"ruby",owner:"MakeNowJust"},"css-extras":{title:"CSS Extras",require:"css",modify:"css",owner:"milesj"},csv:{title:"CSV",owner:"RunDevelopment"},cue:{title:"CUE",owner:"RunDevelopment"},cypher:{title:"Cypher",owner:"RunDevelopment"},d:{title:"D",require:"clike",owner:"Golmote"},dart:{title:"Dart",require:"clike",owner:"Golmote"},dataweave:{title:"DataWeave",owner:"machaval"},dax:{title:"DAX",owner:"peterbud"},dhall:{title:"Dhall",owner:"RunDevelopment"},diff:{title:"Diff",owner:"uranusjr"},django:{title:"Django/Jinja2",require:"markup-templating",alias:"jinja2",owner:"romanvm"},"dns-zone-file":{title:"DNS zone file",owner:"RunDevelopment",alias:"dns-zone"},docker:{title:"Docker",alias:"dockerfile",owner:"JustinBeckwith"},dot:{title:"DOT (Graphviz)",alias:"gv",optional:"markup",owner:"RunDevelopment"},ebnf:{title:"EBNF",owner:"RunDevelopment"},editorconfig:{title:"EditorConfig",owner:"osipxd"},eiffel:{title:"Eiffel",owner:"Conaclos"},ejs:{title:"EJS",require:["javascript","markup-templating"],owner:"RunDevelopment",alias:"eta",aliasTitles:{eta:"Eta"}},elixir:{title:"Elixir",owner:"Golmote"},elm:{title:"Elm",owner:"zwilias"},etlua:{title:"Embedded Lua templating",require:["lua","markup-templating"],owner:"RunDevelopment"},erb:{title:"ERB",require:["ruby","markup-templating"],owner:"Golmote"},erlang:{title:"Erlang",owner:"Golmote"},"excel-formula":{title:"Excel Formula",alias:["xlsx","xls"],owner:"RunDevelopment"},fsharp:{title:"F#",require:"clike",owner:"simonreynolds7"},factor:{title:"Factor",owner:"catb0t"},false:{title:"False",owner:"edukisto"},"firestore-security-rules":{title:"Firestore security rules",require:"clike",owner:"RunDevelopment"},flow:{title:"Flow",require:"javascript",owner:"Golmote"},fortran:{title:"Fortran",owner:"Golmote"},ftl:{title:"FreeMarker Template Language",require:"markup-templating",owner:"RunDevelopment"},gml:{title:"GameMaker Language",alias:"gamemakerlanguage",require:"clike",owner:"LiarOnce"},gap:{title:"GAP (CAS)",owner:"RunDevelopment"},gcode:{title:"G-code",owner:"RunDevelopment"},gdscript:{title:"GDScript",owner:"RunDevelopment"},gedcom:{title:"GEDCOM",owner:"Golmote"},gettext:{title:"gettext",alias:"po",owner:"RunDevelopment"},gherkin:{title:"Gherkin",owner:"hason"},git:{title:"Git",owner:"lgiraudel"},glsl:{title:"GLSL",require:"c",owner:"Golmote"},gn:{title:"GN",alias:"gni",owner:"RunDevelopment"},"linker-script":{title:"GNU Linker Script",alias:"ld",owner:"RunDevelopment"},go:{title:"Go",require:"clike",owner:"arnehormann"},"go-module":{title:"Go module",alias:"go-mod",owner:"RunDevelopment"},gradle:{title:"Gradle",require:"clike",owner:"zeabdelkhalek-badido18"},graphql:{title:"GraphQL",optional:"markdown",owner:"Golmote"},groovy:{title:"Groovy",require:"clike",owner:"robfletcher"},haml:{title:"Haml",require:"ruby",optional:["css","css-extras","coffeescript","erb","javascript","less","markdown","scss","textile"],owner:"Golmote"},handlebars:{title:"Handlebars",require:"markup-templating",alias:["hbs","mustache"],aliasTitles:{mustache:"Mustache"},owner:"Golmote"},haskell:{title:"Haskell",alias:"hs",owner:"bholst"},haxe:{title:"Haxe",require:"clike",optional:"regex",owner:"Golmote"},hcl:{title:"HCL",owner:"outsideris"},hlsl:{title:"HLSL",require:"c",owner:"RunDevelopment"},hoon:{title:"Hoon",owner:"matildepark"},http:{title:"HTTP",optional:["csp","css","hpkp","hsts","javascript","json","markup","uri"],owner:"danielgtaylor"},hpkp:{title:"HTTP Public-Key-Pins",owner:"ScottHelme"},hsts:{title:"HTTP Strict-Transport-Security",owner:"ScottHelme"},ichigojam:{title:"IchigoJam",owner:"BlueCocoa"},icon:{title:"Icon",owner:"Golmote"},"icu-message-format":{title:"ICU Message Format",owner:"RunDevelopment"},idris:{title:"Idris",alias:"idr",owner:"KeenS",require:"haskell"},ignore:{title:".ignore",owner:"osipxd",alias:["gitignore","hgignore","npmignore"],aliasTitles:{gitignore:".gitignore",hgignore:".hgignore",npmignore:".npmignore"}},inform7:{title:"Inform 7",owner:"Golmote"},ini:{title:"Ini",owner:"aviaryan"},io:{title:"Io",owner:"AlesTsurko"},j:{title:"J",owner:"Golmote"},java:{title:"Java",require:"clike",owner:"sherblot"},javadoc:{title:"JavaDoc",require:["markup","java","javadoclike"],modify:"java",optional:"scala",owner:"RunDevelopment"},javadoclike:{title:"JavaDoc-like",modify:["java","javascript","php"],owner:"RunDevelopment"},javastacktrace:{title:"Java stack trace",owner:"RunDevelopment"},jexl:{title:"Jexl",owner:"czosel"},jolie:{title:"Jolie",require:"clike",owner:"thesave"},jq:{title:"JQ",owner:"RunDevelopment"},jsdoc:{title:"JSDoc",require:["javascript","javadoclike","typescript"],modify:"javascript",optional:["actionscript","coffeescript"],owner:"RunDevelopment"},"js-extras":{title:"JS Extras",require:"javascript",modify:"javascript",optional:["actionscript","coffeescript","flow","n4js","typescript"],owner:"RunDevelopment"},json:{title:"JSON",alias:"webmanifest",aliasTitles:{webmanifest:"Web App Manifest"},owner:"CupOfTea696"},json5:{title:"JSON5",require:"json",owner:"RunDevelopment"},jsonp:{title:"JSONP",require:"json",owner:"RunDevelopment"},jsstacktrace:{title:"JS stack trace",owner:"sbrl"},"js-templates":{title:"JS Templates",require:"javascript",modify:"javascript",optional:["css","css-extras","graphql","markdown","markup","sql"],owner:"RunDevelopment"},julia:{title:"Julia",owner:"cdagnino"},keepalived:{title:"Keepalived Configure",owner:"dev-itsheng"},keyman:{title:"Keyman",owner:"mcdurdin"},kotlin:{title:"Kotlin",alias:["kt","kts"],aliasTitles:{kts:"Kotlin Script"},require:"clike",owner:"Golmote"},kumir:{title:"KuMir (\u041a\u0443\u041c\u0438\u0440)",alias:"kum",owner:"edukisto"},kusto:{title:"Kusto",owner:"RunDevelopment"},latex:{title:"LaTeX",alias:["tex","context"],aliasTitles:{tex:"TeX",context:"ConTeXt"},owner:"japborst"},latte:{title:"Latte",require:["clike","markup-templating","php"],owner:"nette"},less:{title:"Less",require:"css",optional:"css-extras",owner:"Golmote"},lilypond:{title:"LilyPond",require:"scheme",alias:"ly",owner:"RunDevelopment"},liquid:{title:"Liquid",require:"markup-templating",owner:"cinhtau"},lisp:{title:"Lisp",alias:["emacs","elisp","emacs-lisp"],owner:"JuanCaicedo"},livescript:{title:"LiveScript",owner:"Golmote"},llvm:{title:"LLVM IR",owner:"porglezomp"},log:{title:"Log file",optional:"javastacktrace",owner:"RunDevelopment"},lolcode:{title:"LOLCODE",owner:"Golmote"},lua:{title:"Lua",owner:"Golmote"},magma:{title:"Magma (CAS)",owner:"RunDevelopment"},makefile:{title:"Makefile",owner:"Golmote"},markdown:{title:"Markdown",require:"markup",optional:"yaml",alias:"md",owner:"Golmote"},"markup-templating":{title:"Markup templating",require:"markup",owner:"Golmote"},mata:{title:"Mata",owner:"RunDevelopment"},matlab:{title:"MATLAB",owner:"Golmote"},maxscript:{title:"MAXScript",owner:"RunDevelopment"},mel:{title:"MEL",owner:"Golmote"},mermaid:{title:"Mermaid",owner:"RunDevelopment"},metafont:{title:"METAFONT",owner:"LaeriExNihilo"},mizar:{title:"Mizar",owner:"Golmote"},mongodb:{title:"MongoDB",owner:"airs0urce",require:"javascript"},monkey:{title:"Monkey",owner:"Golmote"},moonscript:{title:"MoonScript",alias:"moon",owner:"RunDevelopment"},n1ql:{title:"N1QL",owner:"TMWilds"},n4js:{title:"N4JS",require:"javascript",optional:"jsdoc",alias:"n4jsd",owner:"bsmith-n4"},"nand2tetris-hdl":{title:"Nand To Tetris HDL",owner:"stephanmax"},naniscript:{title:"Naninovel Script",owner:"Elringus",alias:"nani"},nasm:{title:"NASM",owner:"rbmj"},neon:{title:"NEON",owner:"nette"},nevod:{title:"Nevod",owner:"nezaboodka"},nginx:{title:"nginx",owner:"volado"},nim:{title:"Nim",owner:"Golmote"},nix:{title:"Nix",owner:"Golmote"},nsis:{title:"NSIS",owner:"idleberg"},objectivec:{title:"Objective-C",require:"c",alias:"objc",owner:"uranusjr"},ocaml:{title:"OCaml",owner:"Golmote"},odin:{title:"Odin",owner:"edukisto"},opencl:{title:"OpenCL",require:"c",modify:["c","cpp"],owner:"Milania1"},openqasm:{title:"OpenQasm",alias:"qasm",owner:"RunDevelopment"},oz:{title:"Oz",owner:"Golmote"},parigp:{title:"PARI/GP",owner:"Golmote"},parser:{title:"Parser",require:"markup",owner:"Golmote"},pascal:{title:"Pascal",alias:"objectpascal",aliasTitles:{objectpascal:"Object Pascal"},owner:"Golmote"},pascaligo:{title:"Pascaligo",owner:"DefinitelyNotAGoat"},psl:{title:"PATROL Scripting Language",owner:"bertysentry"},pcaxis:{title:"PC-Axis",alias:"px",owner:"RunDevelopment"},peoplecode:{title:"PeopleCode",alias:"pcode",owner:"RunDevelopment"},perl:{title:"Perl",owner:"Golmote"},php:{title:"PHP",require:"markup-templating",owner:"milesj"},phpdoc:{title:"PHPDoc",require:["php","javadoclike"],modify:"php",owner:"RunDevelopment"},"php-extras":{title:"PHP Extras",require:"php",modify:"php",owner:"milesj"},"plant-uml":{title:"PlantUML",alias:"plantuml",owner:"RunDevelopment"},plsql:{title:"PL/SQL",require:"sql",owner:"Golmote"},powerquery:{title:"PowerQuery",alias:["pq","mscript"],owner:"peterbud"},powershell:{title:"PowerShell",owner:"nauzilus"},processing:{title:"Processing",require:"clike",owner:"Golmote"},prolog:{title:"Prolog",owner:"Golmote"},promql:{title:"PromQL",owner:"arendjr"},properties:{title:".properties",owner:"Golmote"},protobuf:{title:"Protocol Buffers",require:"clike",owner:"just-boris"},pug:{title:"Pug",require:["markup","javascript"],optional:["coffeescript","ejs","handlebars","less","livescript","markdown","scss","stylus","twig"],owner:"Golmote"},puppet:{title:"Puppet",owner:"Golmote"},pure:{title:"Pure",optional:["c","cpp","fortran"],owner:"Golmote"},purebasic:{title:"PureBasic",require:"clike",alias:"pbfasm",owner:"HeX0R101"},purescript:{title:"PureScript",require:"haskell",alias:"purs",owner:"sriharshachilakapati"},python:{title:"Python",alias:"py",owner:"multipetros"},qsharp:{title:"Q#",require:"clike",alias:"qs",owner:"fedonman"},q:{title:"Q (kdb+ database)",owner:"Golmote"},qml:{title:"QML",require:"javascript",owner:"RunDevelopment"},qore:{title:"Qore",require:"clike",owner:"temnroegg"},r:{title:"R",owner:"Golmote"},racket:{title:"Racket",require:"scheme",alias:"rkt",owner:"RunDevelopment"},cshtml:{title:"Razor C#",alias:"razor",require:["markup","csharp"],optional:["css","css-extras","javascript","js-extras"],owner:"RunDevelopment"},jsx:{title:"React JSX",require:["markup","javascript"],optional:["jsdoc","js-extras","js-templates"],owner:"vkbansal"},tsx:{title:"React TSX",require:["jsx","typescript"]},reason:{title:"Reason",require:"clike",owner:"Golmote"},regex:{title:"Regex",owner:"RunDevelopment"},rego:{title:"Rego",owner:"JordanSh"},renpy:{title:"Ren'py",alias:"rpy",owner:"HyuchiaDiego"},rescript:{title:"ReScript",alias:"res",owner:"vmarcosp"},rest:{title:"reST (reStructuredText)",owner:"Golmote"},rip:{title:"Rip",owner:"ravinggenius"},roboconf:{title:"Roboconf",owner:"Golmote"},robotframework:{title:"Robot Framework",alias:"robot",owner:"RunDevelopment"},ruby:{title:"Ruby",require:"clike",alias:"rb",owner:"samflores"},rust:{title:"Rust",owner:"Golmote"},sas:{title:"SAS",optional:["groovy","lua","sql"],owner:"Golmote"},sass:{title:"Sass (Sass)",require:"css",optional:"css-extras",owner:"Golmote"},scss:{title:"Sass (SCSS)",require:"css",optional:"css-extras",owner:"MoOx"},scala:{title:"Scala",require:"java",owner:"jozic"},scheme:{title:"Scheme",owner:"bacchus123"},"shell-session":{title:"Shell session",require:"bash",alias:["sh-session","shellsession"],owner:"RunDevelopment"},smali:{title:"Smali",owner:"RunDevelopment"},smalltalk:{title:"Smalltalk",owner:"Golmote"},smarty:{title:"Smarty",require:"markup-templating",optional:"php",owner:"Golmote"},sml:{title:"SML",alias:"smlnj",aliasTitles:{smlnj:"SML/NJ"},owner:"RunDevelopment"},solidity:{title:"Solidity (Ethereum)",alias:"sol",require:"clike",owner:"glachaud"},"solution-file":{title:"Solution file",alias:"sln",owner:"RunDevelopment"},soy:{title:"Soy (Closure Template)",require:"markup-templating",owner:"Golmote"},sparql:{title:"SPARQL",require:"turtle",owner:"Triply-Dev",alias:"rq"},"splunk-spl":{title:"Splunk SPL",owner:"RunDevelopment"},sqf:{title:"SQF: Status Quo Function (Arma 3)",require:"clike",owner:"RunDevelopment"},sql:{title:"SQL",owner:"multipetros"},squirrel:{title:"Squirrel",require:"clike",owner:"RunDevelopment"},stan:{title:"Stan",owner:"RunDevelopment"},stata:{title:"Stata Ado",require:["mata","java","python"],owner:"RunDevelopment"},iecst:{title:"Structured Text (IEC 61131-3)",owner:"serhioromano"},stylus:{title:"Stylus",owner:"vkbansal"},supercollider:{title:"SuperCollider",alias:"sclang",owner:"RunDevelopment"},swift:{title:"Swift",owner:"chrischares"},systemd:{title:"Systemd configuration file",owner:"RunDevelopment"},"t4-templating":{title:"T4 templating",owner:"RunDevelopment"},"t4-cs":{title:"T4 Text Templates (C#)",require:["t4-templating","csharp"],alias:"t4",owner:"RunDevelopment"},"t4-vb":{title:"T4 Text Templates (VB)",require:["t4-templating","vbnet"],owner:"RunDevelopment"},tap:{title:"TAP",owner:"isaacs",require:"yaml"},tcl:{title:"Tcl",owner:"PeterChaplin"},tt2:{title:"Template Toolkit 2",require:["clike","markup-templating"],owner:"gflohr"},textile:{title:"Textile",require:"markup",optional:"css",owner:"Golmote"},toml:{title:"TOML",owner:"RunDevelopment"},tremor:{title:"Tremor",alias:["trickle","troy"],owner:"darach",aliasTitles:{trickle:"trickle",troy:"troy"}},turtle:{title:"Turtle",alias:"trig",aliasTitles:{trig:"TriG"},owner:"jakubklimek"},twig:{title:"Twig",require:"markup-templating",owner:"brandonkelly"},typescript:{title:"TypeScript",require:"javascript",optional:"js-templates",alias:"ts",owner:"vkbansal"},typoscript:{title:"TypoScript",alias:"tsconfig",aliasTitles:{tsconfig:"TSConfig"},owner:"dkern"},unrealscript:{title:"UnrealScript",alias:["uscript","uc"],owner:"RunDevelopment"},uorazor:{title:"UO Razor Script",owner:"jaseowns"},uri:{title:"URI",alias:"url",aliasTitles:{url:"URL"},owner:"RunDevelopment"},v:{title:"V",require:"clike",owner:"taggon"},vala:{title:"Vala",require:"clike",optional:"regex",owner:"TemplarVolk"},vbnet:{title:"VB.Net",require:"basic",owner:"Bigsby"},velocity:{title:"Velocity",require:"markup",owner:"Golmote"},verilog:{title:"Verilog",owner:"a-rey"},vhdl:{title:"VHDL",owner:"a-rey"},vim:{title:"vim",owner:"westonganger"},"visual-basic":{title:"Visual Basic",alias:["vb","vba"],aliasTitles:{vba:"VBA"},owner:"Golmote"},warpscript:{title:"WarpScript",owner:"RunDevelopment"},wasm:{title:"WebAssembly",owner:"Golmote"},"web-idl":{title:"Web IDL",alias:"webidl",owner:"RunDevelopment"},wgsl:{title:"WGSL",owner:"Dr4gonthree"},wiki:{title:"Wiki markup",require:"markup",owner:"Golmote"},wolfram:{title:"Wolfram language",alias:["mathematica","nb","wl"],aliasTitles:{mathematica:"Mathematica",nb:"Mathematica Notebook"},owner:"msollami"},wren:{title:"Wren",owner:"clsource"},xeora:{title:"Xeora",require:"markup",alias:"xeoracube",aliasTitles:{xeoracube:"XeoraCube"},owner:"freakmaxi"},"xml-doc":{title:"XML doc (.net)",require:"markup",modify:["csharp","fsharp","vbnet"],owner:"RunDevelopment"},xojo:{title:"Xojo (REALbasic)",owner:"Golmote"},xquery:{title:"XQuery",require:"markup",owner:"Golmote"},yaml:{title:"YAML",alias:"yml",owner:"hason"},yang:{title:"YANG",owner:"RunDevelopment"},zig:{title:"Zig",owner:"RunDevelopment"}},plugins:{meta:{path:"plugins/{id}/prism-{id}",link:"plugins/{id}/"},"line-highlight":{title:"Line Highlight",description:"Highlights specific lines and/or line ranges."},"line-numbers":{title:"Line Numbers",description:"Line number at the beginning of code lines.",owner:"kuba-kubula"},"show-invisibles":{title:"Show Invisibles",description:"Show hidden characters such as tabs and line breaks.",optional:["autolinker","data-uri-highlight"]},autolinker:{title:"Autolinker",description:"Converts URLs and emails in code to clickable links. Parses Markdown links in comments."},wpd:{title:"WebPlatform Docs",description:'Makes tokens link to WebPlatform.org documentation. The links open in a new tab.'},"custom-class":{title:"Custom Class",description:"This plugin allows you to prefix Prism's default classes (.comment can become .namespace--comment) or replace them with your defined ones (like .editor__comment). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the highlightAll and highlightAllUnder methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},8722:(e,t,n)=>{const r=n(6969),o=n(8380),a=new Set;function i(e){void 0===e?e=Object.keys(r.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...a,...Object.keys(Prism.languages)];o(r,e,t).load((e=>{if(!(e in r.languages))return void(i.silent||console.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(3157).resolve(t)],delete Prism.languages[e],n(3157)(t),a.add(e)}))}i.silent=!1,e.exports=i},9700:()=>{!function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,o,a){if(n.language===r){var i=n.tokenStack=[];n.code=n.code.replace(o,(function(e){if("function"==typeof a&&!a(e))return e;for(var o,s=i.length;-1!==n.code.indexOf(o=t(r,s));)++s;return i[s]=e,o})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var o=0,a=Object.keys(n.tokenStack);!function i(s){for(var l=0;l=a.length);l++){var c=s[l];if("string"==typeof c||c.content&&"string"==typeof c.content){var u=a[o],d=n.tokenStack[u],f="string"==typeof c?c:c.content,p=t(r,u),h=f.indexOf(p);if(h>-1){++o;var m=f.substring(0,h),g=new e.Token(r,e.tokenize(d,n.grammar),"language-"+r,d),b=f.substring(h+p.length),v=[];m&&v.push.apply(v,i([m])),v.push(g),b&&v.push.apply(v,i([b])),"string"==typeof c?s.splice.apply(s,[l,1].concat(v)):c.content=v}}else c.content&&i(c.content)}return s}(n.tokens)}}}})}(Prism)},8692:(e,t,n)=>{var r={"./":8722};function o(e){var t=a(e);return n(t)}function a(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}o.keys=function(){return Object.keys(r)},o.resolve=a,e.exports=o,o.id=8692},3157:(e,t,n)=>{var r={"./":8722};function o(e){var t=a(e);return n(t)}function a(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}o.keys=function(){return Object.keys(r)},o.resolve=a,e.exports=o,o.id=3157},8380:e=>{"use strict";var t=function(){var e=function(){};function t(e,t){Array.isArray(e)?e.forEach(t):null!=e&&t(e,0)}function n(e){for(var t={},n=0,r=e.length;n "));var s={},l=e[r];if(l){function c(t){if(!(t in e))throw new Error(r+" depends on an unknown component "+t);if(!(t in s))for(var i in o(t,a),s[t]=!0,n[t])s[i]=!0}t(l.require,c),t(l.optional,c),t(l.modify,c)}n[r]=s,a.pop()}}return function(e){var t=n[e];return t||(o(e,r),t=n[e]),t}}function o(e){for(var t in e)return!0;return!1}return function(a,i,s){var l=function(e){var t={};for(var n in e){var r=e[n];for(var o in r)if("meta"!=o){var a=r[o];t[o]="string"==typeof a?{title:a}:a}}return t}(a),c=function(e){var n;return function(r){if(r in e)return r;if(!n)for(var o in n={},e){var a=e[o];t(a&&a.alias,(function(t){if(t in n)throw new Error(t+" cannot be alias for both "+o+" and "+n[t]);if(t in e)throw new Error(t+" cannot be alias of "+o+" because it is a component.");n[t]=o}))}return n[r]||r}}(l);i=i.map(c),s=(s||[]).map(c);var u=n(i),d=n(s);i.forEach((function e(n){var r=l[n];t(r&&r.require,(function(t){t in d||(u[t]=!0,e(t))}))}));for(var f,p=r(l),h=u;o(h);){for(var m in f={},h){var g=l[m];t(g&&g.modify,(function(e){e in d&&(f[e]=!0)}))}for(var b in d)if(!(b in u))for(var v in p(b))if(v in u){f[b]=!0;break}for(var y in h=f)u[y]=!0}var w={getIds:function(){var e=[];return w.load((function(t){e.push(t)})),e},load:function(t,n){return function(t,n,r,o){var a=o?o.series:void 0,i=o?o.parallel:e,s={},l={};function c(e){if(e in s)return s[e];l[e]=!0;var o,u=[];for(var d in t(e))d in n&&u.push(d);if(0===u.length)o=r(e);else{var f=i(u.map((function(e){var t=c(e);return delete l[e],t})));a?o=a(f,(function(){return r(e)})):r(e)}return s[e]=o}for(var u in n)c(u);var d=[];for(var f in l)d.push(s[f]);return i(d)}(p,u,t,n)}};return w}}();e.exports=t},2694:(e,t,n)=>{"use strict";var r=n(6925);function o(){}function a(){}a.resetWarningCache=o,e.exports=function(){function e(e,t,n,o,a,i){if(i!==r){var s=new Error("Calling PropTypes validators directly is not supported by the `prop-types` package. Use PropTypes.checkPropTypes() to call them. Read more at http://fb.me/use-check-prop-types");throw s.name="Invariant Violation",s}}function t(){return e}e.isRequired=e;var n={array:e,bigint:e,bool:e,func:e,number:e,object:e,string:e,symbol:e,any:e,arrayOf:t,element:e,elementType:e,instanceOf:t,node:e,objectOf:t,oneOf:t,oneOfType:t,shape:t,exact:t,checkPropTypes:a,resetWarningCache:o};return n.PropTypes=n,n}},5556:(e,t,n)=>{e.exports=n(2694)()},6925:e=>{"use strict";e.exports="SECRET_DO_NOT_PASS_THIS_OR_YOU_WILL_BE_FIRED"},2551:(e,t,n)=>{"use strict";var r=n(6540),o=n(9982);function a(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;n