#open api documents

[marsdevs]

OpenAPI Documentation Tools Overview

Confused by API documentation? This podcast dives into the world of OpenAPI tools, simplifying the process of designing, building, and sharing your API specs. From Swagger UI to code generation, discover the right tools to streamline your workflow and empower developers. Listen and unlock the full potential of your API!

Click here to know more: www.marsdevs.com

[rocketlanterns]

So I use a browser extension on ff called simple tab groups, which lets me bundle a bunch of tabs into different contexts and manage them as groups.

On my normal setup, I only have like 3 tabs, but when I want to work on one of my projects, I can open the group that I keep that projects documentation in, and have it all handy instantly, and when I'm done I can switch back to my usual socials and just right click + discard the group to unload everything.

I run between 40-80 tabs but never more than 20 at a time, and that's only for the worst of documentation stuff.

when you are done with a tab you can close it. every browser in the world has a feature that lets you open recently closed tabs. also there is browsing history. need to visit a webpage often? may i introduce you to the bookmarks feature. there’s no reason to leave your tabs open. hoarder behavior.

[manonamora-if]

The 100% Good Twine SugarCube Guide!

The 100% Good Twine SugarCube Guide is a coding guide for the SugarCube format of Twine. It is meant as an alternative to the SugarCube documentation, with further explanations, interactive examples, and organised by difficulty. The goal of this guide is to make the learning curve for new SugarCube user less steep, and provide a comprehensive and wide look over the format.

VIEW / DOWNLOAD THE GUIDE!!!!

The Guide is compartmentalised in (currently) four categories:

THE BASICS or the absolute basics to start with SugarCube. No need for extra knowledge. Just the base needed to make something.

THE BASICS + adding interactivity, and creating a fully rounded IF game May require a bit of CSS knowledge (formatting rules)

INTERMEDIATE MODE adding more customisation and complex code Will probably require some CSS knowledge, and maybe some JavaScript

ADVANCE USE the most complex macros and APIs Will surely require some JavaScript/jQuery knowledge

Note: The Advanced Use includes all the APIs, macros, and methods not covered by the previous categories. This includes code requiring very advance knowledge of JavaScript/jQuery to be used properly.

Each category explains many aspects of the format, tailored to a specific level of the user. More simpler explanations and examples are available in earlier chapters, compared to the later ones.

If something is unclear, you found a mistake, you would like more examples in the guide, or would like a feature covered, let me know!

The Guide currently covers all macros (as of SugarCube v.2.37.3), all functions and methods, and APIs. It touches upon the use of HTML, CSS, JavaScript and jQuery, when relevant. It also discusses aspects of accessibility.

The Guides also provides a list of further resources, for the different coding languages.

The Guide is available in a downloadable form for offline view:

HTML file that can be opened in Twine

.tw file that can be opened in Twine

source code, separating the chapters, .js and .css files

GITHUB REPO | RAISE AN ISSUE | TWINE RESOURCES TWEEGO | TEMPLATES | CSCRIPT 2 SG GUIDE

Twine® is an “an open-source tool for telling interactive, non-linear stories” originally created by Chris Klimas maintained in several different repositories (Twinery.org). Twine is also a registered trademark of the Interactive Fiction Technology Foundation.

SugarCube is a free (gratis and libre) coding format for Twine/Twee created and maintained by TME.

VIEW / DOWNLOAD THE GUIDE!!!!

As of this release (v2.0.0), it is up to date with the version 2.37.3. If you are looking for the guide covering SugarCube 2.36.1, you can find it on my GitHub.

Note: the Guide is now complete. There won't be further substantial updates.

[changes]

Tuesday, August 13th, 2024

🌟 New

Tumblr URLs in Replies will now become clickable links!

Speaking of Replies, they’re threaded now!

Did you just get promoted to moderator in your Community, but don’t know what to do? Behold the new documentation!

Community admins can now ban members! Banned members will not be able to re-join or even see the Community they were banned from.

We’re opening up the Communities API to third-party developers via the public Tumblr API. Stay tuned in our public docs repo for updates on the different endpoints!

🛠 Fixed

It was difficult to read long alt text on the web, and this has now been fixed! Please keep in mind that alt text should be a brief description of your image, as if you were describing it to someone over the phone, solely to make your post accessible to folks using a screen reader.

On the web, it was previously impossible in many cases to add a Read More block to the top of a post, and now you can!

🚧 Ongoing

Folks with the Android app are unable to block anonymous Asks, but they can still be blocked on the web, and there will be a fix in the next update.

🌱 Upcoming

We’re still hard at work on even more features for Communities!

We’re also … collecting … a new perk for Premium subscribers, stay tuned! 😉

Experiencing an issue? Check for Known Issues and file a Support Request if you have something new. We’ll get back to you as soon as we can!

Want to share your feedback about something? Check out our Work in Progress blog and start a discussion with the community.

Wanna support Tumblr directly with some money? Check out Premium and the Supporter badge in TumblrMart!

[cookiethebirddoll]

It appears to be very possible and actually pretty easy to view the exact numbers of a running poll without voting in it on Tumblr. The data is available at:

https://tumblr.com/api/v2/polls/{blog-identifier}/{post-id}/{poll-id}/results

Most of the information about this can be found at:

However, this particular endpoint does not have documentation and we don't know how to get the poll-id. You don't actually need to, though. If you open the networking console and filter for "results", it will show this data for any polls that have been loaded.

The actual data is in the response JSON under response > results. It appears that the data is in the same order as the poll is displayed, although we only tested this on one poll.

It would be pretty easy to write a browser plugin to add a Show Results button using this data and/or to display exact numbers in the results.

[cyle]

I'm guessing the new Original Post implementation will strictly capture posts where the blog owner is the OP.

Has the team considered adding in an option where you can also see all the posts the blog owner has added to?

A lot of Tumblr's charm is the collaborative aspects of posts and I know most of my top bangers were made in conversation with other users.

I've actually been working on a little project to scrape all the meta I've posted on a blog into a single document and have run into trouble achieving this. It would've been easy if I'd tagged everything consistently but over the years my tags changed 😔

The Tumblr API doesn't have an explicit method to get purely original posts, so I used a 3rd party tool (Jet Black Code) to pull my original posts. To try to get my "added on" comments, I downloaded my blog backup file, hoping to write up some quick code to pick out posts where the last blog with content on the chain was mine.

Unfortunately, it's less obvious than I thought it would be because in those cases my contribution isn't actually marked with my username like it is for everyone else in the reblog chain. 🤔 I'll need to dig into it more to see if I can rely on the formatting of the final block for these cases.

i don't know if we've thought of that specific case, but that does sound neat. i know there are a lot of capabilities we're looking to add to search, like including reblogs in search results (which should be coming soon i hope), and improving in-blog search. in general, i'd love to spend a lot of time making our API better for the special things people want to do like that, but i just do not have the time. but maybe we'll be able to open up stuff like this as our capabilities improve.

[triviallytrue]

i am not really interested in game development but i am interested in modding (or more specifically cheat creation) as a specialized case of reverse-engineering and modifying software running on your machine

like okay for a lot of games the devs provide some sort of easy toolkit which lets even relatively nontechnical players write mods, and these are well-documented, and then games which don't have those often have a single-digit number of highly technical modders who figure out how to do injection and create some kind of api for the less technical modders to use, and that api is often pretty well documented, but the process of creating it absolutely isn't

it's even more interesting for cheat development because it's something hostile to the creators of the software, you are actively trying to break their shit and they are trying to stop you, and of course it's basically completely undocumented because cheat developers both don't want competitors and also don't want the game devs to patch their methods....

maybe some of why this is hard is because it's pretty different for different types of games. i think i'm starting to get a handle on how to do it for this one game - so i know there's a way to do packet sniffing on the game, where the game has a dedicated port and it sends tcp packets, and you can use the game's tick system and also a brute-force attack on its very rudimentary encryption to access the raw packets pretty easily.

through trial and error (i assume) people have figured out how to decode the packets and match them up to various ingame events, which is already used in a publicly available open source tool to do stuff like DPS calculation.

i think, without too much trouble, you could probably step this up and intercept/modify existing packets? like it looks like while damage is calculated on the server side, whether or not you hit an enemy is calculated on the client side and you could maybe modify it to always hit... idk.

apparently the free cheats out there (which i would not touch with a 100 foot pole, odds those have something in them that steals your login credentials is close to 100%) operate off a proxy server model, which i assume intercepts your packets, modifies them based on what cheats you tell it you have active, and then forwards them to the server.

but they also manage to give you an ingame GUI to create those cheats, which is clearly something i don't understand. the foss sniffer opens itself up in a new window instead of modifying the ingame GUI.

man i really want to like. shadow these guys and see their dev process for a day because i'm really curious. and also read their codebase. but alas

[marsdevs]

6 Best OpenAPI Documentation Tools

Unless you re alone utilizing the API, you should thoroughly document it But manually would be tedious. But which is the best? To solve your dilemma, MarsDevs will highlight some of the best API documentation tools available to make documentation simpler! Let’s start with the basics.

[archiveyourblog]

How to back up your Tumblr blog

Not sure if all of you heard the news, but Wordpress laid off 16% of its staff, which happened to include senior tumblr staff like cyle. According to 3liza, the amount of staff running tumblr is about 25.

Welp. Will Tumblr finally die? I don't know. It's pretty likely, since this site costs millions to run and to host all this content, but I'll stay till the end. But I backed up my blog, with the help of a post that can't be reblogged rn.

you can reblog this one though.

Quoth butchlinkle: "In your blog settings you have the ability to initiate a blog export, and this will generate a backup for your blog.

Fair warning though, if you’ve been on the platform for a long time this archive is likely to be quite hefty in file size. This blog I have had for 5 years with 22k posts, and the export from tumblr came to be 48GB. My previous blog I made in 2011 and has 95k posts, so needless to say I did not use tumblr’s built in export to back that one up.

If you want more control over exactly what you back up from your blog, I recommend that you use tumblr-utils instead. It allows you to backup specific tags, post types, and to ignore posts that you did not create (reblogs where you’ve added a comment count unfortunately do not count unless you use the older version of the script made with python 2.7).

To use it:

download and install python

create an application on tumblr to get an api key

create a folder where you would like to save your backups and right click to open it in the terminal/command prompt, or type cmd.exe in the address bar from inside that folder

Backing up just my original posts from this blog with this command came to 632MB rather than 48GB, and also gave me the option to save my posts in JSON format which will be useful for converting my posts to a new format for self hosting.

On that note I’m currently looking into figuring out a simple (and ideally free) way of self hosting a static site blog that utilises activitypub, and also converting my old posts to re-host on said blog.

This post series by maho.dev on implementing activitypub with any static site is my primary source of guidance atm if you also want to try figure that out yourself, as well as having an explanation for why you’d even want to do this if you don’t already know

but if tumblr goes down before I get things sorted and write up a post about it then i’ll be reporting back on it via my bsky, mastodon, and toyhouse accounts

if you dont have an account on any of these I’ll also be sharing an update via my personal site’s RSS feed, link of which includes an explanation of what RSS is and some feed readers you can use, I highly recommend checking it out as getting a feed reader is going to be the best way you can stay connected with people if they scatter across the internet!

tldr: download tumblr-utils to backup your blog more efficiently, introduce yourself to RSS and get a feed reader to stay connected with people, consider saving mine so you can find out how to self host your blog later if tumblr goes down."

here's a guide from the notes: https://docs.google.com/document/u/0/d/1yBWlk-yEgpSoEh3c9oLhz_kbLtUGqbqzOpCtJsvQgjI/mobilebasic?pli=1#h.u9vj7pezwpcy

Back up those blogs. This was way faster than trying to use Webarchive, and webarchive seems to be only good for saving text, audio, and video, because it saved none of the images. And remember: I did not write this guide, and I do not know a thing about coding or fixing bugs.

[starmod]

500 mods? LETS PRAY WE DON'T CRASH!

Welcome to the blog where I document my stardew more mods then needed journey,

Give me recomendations for mods to add btw!!!

(also, yes this is the second time I made this list, I fucked up the first time lmao)

the mods:

stardrop, required to actually keep the updates regurally scheduled and to ensure you know what the names of mods are (half the mods are linked to dateable clint)

the google drive link to the full 1.84GB mod download folder

where to watch the playthrough:

twitch, live aproximatly every wednesday. unschedules due to me not being on a schedule in general.

youtube: vods and properly edited videos, these will appear an undetermined amound of times after streams

[wtnvapi]

making this blog to document the creation (and hopefully improvement) of a welcome to night vale api since, what the hell, no one else has, it's been a few years since i ran a wtnv blog, and i need a fun project to look at that's not work. open to suggestions for features/site design <3

[blogsajs2024]

Get Chatbot service for business with APIWAA

In today’s fast-paced digital world, businesses are constantly looking for innovative ways to connect with their customers more effectively and efficiently. One of the most powerful tools available to achieve this is the APIWAA. By integrating APIWAA into your business operations, you can enhance communication, improve customer service, and drive engagement to new heights.

What is APIWAA?

APIWAA is a powerful communication tool that allows businesses to integrate WhatsApp messaging into their existing systems and workflows. Unlike the standard WhatsApp Business app, the API is designed for medium to large businesses, offering scalability and a range of advanced features that streamline customer interactions. It provides a programmable interface that enables businesses to send and receive messages, automate responses, and manage communication at scale.

1.Enhanced Customer Communication: With APIWAA, businesses can offer real-time customer support and engagement. The ability to send instant replies to customer queries, provide order updates, and share promotional content ensures a smooth and efficient communication process. This level of responsiveness helps build trust and loyalty among customers.

2.Automation and scalability: The APIWAA allows for the automation of routine tasks, such as sending appointment reminders, order confirmations, and personalized messages based on customer interactions. This not only saves time but also ensures consistent and accurate communication. The API’s scalability means it can handle a large volume of messages simultaneously, making it ideal for businesses of all sizes.

3.Rich Media support: Unlike traditional SMS, APIWAA supports rich media messages, including images, videos, documents, and interactive buttons. This capability allows businesses to create engaging and visually appealing messages that can capture the attention of their audience more effectively.

4.Secure and Reliable: Security is a top priority for APIWAA. The platform uses end-to-end encryption to protect messages and data, ensuring that customer information remains private and secure. This level of security helps businesses comply with data protection regulations and provides peace of mind to both the business and its customers.

Use Cases: Customer Support: Provide instant responses to customer inquiries, resolve issues quickly, and offer support 24/7.

Marketing Campaigns: Send targeted promotions, offers, and updates directly to customers’ WhatsApp accounts, ensuring high open and engagement rates.

Order Notifications: Keep customers informed with real-time updates on order status, shipping details, and delivery confirmations.

Appointment Reminders: Automate appointment reminders to reduce no-shows and improve customer experience.

Conclusion: The APIWAA is a game-changer for businesses looking to enhance their communication strategy. By integrating this powerful tool, businesses can improve customer engagement, streamline operations, and ultimately drive growth. Whether you’re a small startup or a large enterprise, the APIWAA offers the flexibility and functionality needed to stay ahead in today’s competitive market. Embrace the future of communication with APIWAA and unlock your business’s full potential.

[fermented-writers-block]

Hey all, small update on the r/InfinityTrain archive efforts here.

As it turns out, the mods on the subreddit have opened it back up to the public and I am no longer the only person allowed to view it, so you can go and check it out now.

That being said, with tomorrow being the start of the API changes, it’d still be in your best interests to archive what you can and want to while Reddit still works. In the meantime, since it’s still the last day of Pride month at the time of starting this draft and because I’ve managed to do a considerable amount of work without yet losing steam, I’m happy to share a peek at the current progress on my subreddit archive:

As you can see, I’m still going to finish my archiving of what I can, as who knows what may happen to the original information sources.

Especially because Twitter now requires you to have an account to do anything - including merely browsing and seeing posts - and who knows whether embed support on other sites will be going away too.

In other words, if you want to still have a guaranteed way to check info from the Twitter accounts of the crew but don’t want to make an account/in case Twitter gets royally screwed up, it is incredibly important to document any and all concept art, post threads, and links shared by the Infinity Train crew.

In fact, I have set up a Google drive folder to consolidate efforts into one place for all who wants to help with this task below:

Inside, I have set up two folders: posts by the crew, and noteworthy fan art/analysis by fans that the crew have taken particular note of. And to help with organizing all the links and information together, I have set up the simplified google sheet below:

For the process of organizing, here’s a general outline of how archiving can be done:

Find the Twitter post you want to archive, whether it’s in a Discord server, on the Wayback Machine website (since Owen mass deleted his tweets often),

Copy the link to the Google sheet with - if you can - the month and year the post was created

Take a picture of the full post/decent chunks of a Twitter thread

If possible, change the file name of the picture to a title or brief description outlining the content within the post

Upload the photo to the respective subfolder and type the file name in the respective Google Sheet

Now, I have a few additional docs and subfolders than these key ones, but I hope that the drive is overall easy to navigate and understand, and here’s to saving Infinity Train fandom history for all to see and know that we were here!

[iphonehistory]

Apple Unveils Mac OS X

Next Generation OS Features New “Aqua” User Interface

MACWORLD EXPO, SAN FRANCISCO

January 5, 2000

Reasserting its leadership in personal computer operating systems, Apple® today unveiled Mac® OS X, the next generation Macintosh® operating system. Steve Jobs demonstrated Mac OS X to an audience of over 4,000 people during his Macworld Expo keynote today, and over 100 developers have pledged their support for the new operating system, including Adobe and Microsoft. Pre-release versions of Mac OS X will be delivered to Macintosh software developers by the end of this month, and will be commercially released this summer.

“Mac OS X will delight consumers with its simplicity and amaze professionals with its power,” said Steve Jobs, Apple’s iCEO. “Apple’s innovation is leading the way in personal computer operating systems once again.”

The new technology Aqua, created by Apple, is a major advancement in personal computer user interfaces. Aqua features the “Dock” — a revolutionary new way to organize everything from applications and documents to web sites and streaming video. Aqua also features a completely new Finder which dramatically simplifies the storing, organizing and retrieving of files—and unifies these functions on the host computer and across local area networks and the Internet. Aqua offers a stunning new visual appearance, with luminous and semi-transparent elements such as buttons, scroll bars and windows, and features fluid animation to enhance the user’s experience. Aqua is a major advancement in personal computer user interfaces, from the same company that started it all in 1984 with the original Macintosh.

Aqua is made possible by Mac OS X’s new graphics system, which features all-new 2D, 3D and multimedia graphics. 2D graphics are performed by Apple’s new “Quartz” graphics system which is based on the PDF Internet standard and features on-the-fly PDF rendering, anti-aliasing and compositing—a first for any operating system. 3D graphics are based on OpenGL, the industry’s most-widely supported 3D graphics technology, and multimedia is based on the QuickTime™ industry standard for digital multimedia.

At the core of Mac OS X is Darwin, Apple’s advanced operating system kernel. Darwin is Linux-like, featuring the same Free BSD Unix support and open-source model. Darwin brings an entirely new foundation to the Mac OS, offering Mac users true memory protection for higher reliability, preemptive multitasking for smoother operation among multiple applications and fully Internet-standard TCP/IP networking. As a result, Mac OS X is the most reliable and robust Apple operating system ever.

Gentle Migration

Apple has designed Mac OS X to enable a gentle migration for its customers and developers from their current installed base of Macintosh operating systems. Mac OS X can run most of the over 13,000 existing Macintosh applications without modification. However, to take full advantage of Mac OS X’s new features, developers must “tune-up” their applications to use “Carbon”, the updated version of APIs (Application Program Interfaces) used to program Macintosh computers. Apple expects most of the popular Macintosh applications to be available in “Carbonized” versions this summer.

Developer Support

Apple today also announced that more than 100 leading developers have pledged their support for the new operating system, including Adobe, Agfa, Connectix, id, Macromedia, Metrowerks, Microsoft, Palm Computing, Quark, SPSS and Wolfram (see related supporting quote sheet).

Availability

Mac OS X will be rolled out over a 12 month period. Macintosh developers have already received two pre-releases of the software, and they will receive another pre-release later this month—the first to incorporate Aqua. Developers will receive the final “beta” pre-release this spring. Mac OS X will go on sale as a shrink-wrapped software product this summer, and will be pre-loaded as the standard operating system on all Macintosh computers beginning in early 2001. Mac OS X is designed to run on all Apple Macintosh computers using PowerPC G3 and G4 processor chips, and requires a minimum of 64 MB of memory.

[obavee]

Exploring the Power of STON.fi’s API & SDK Demo App: A Developer’s Game-Changer

If you're a developer diving into the world of blockchain, especially within the TON ecosystem, you know how overwhelming it can feel to get everything just right. From understanding decentralized finance (DeFi) to building seamless integration, the process is filled with complex layers. But what if there was an easier way to get started with integrating powerful features like token swaps into your app?

STON.fi has launched something that could change the way you work: the STON.fi API & SDK Demo App. This isn’t just a demo—it’s a practical, real-world example that brings the power of the TON blockchain right into your hands.

Why Should You Care?

Think of this demo app as your personal guide in a foreign city. You know your destination, but the roads are unfamiliar. This app shows you exactly how to integrate key features (like swaps) into your decentralized apps (dApps), step by step. Rather than spending hours or days figuring it out, you get a hands-on example of what works, which can save you a lot of time.

Here’s What Makes This Demo App Special

1. It’s Easy to Understand

Instead of vague documentation or unclear tutorials, this demo app shows you a live, working example. It’s like watching a professional chef cook a meal and then being handed the recipe. You see exactly how everything comes together.

2. A Quick Head Start

Let’s face it—time is valuable. As a developer, you don’t want to reinvent the wheel. This demo gives you a clear starting point, making the development process smoother and faster.

3. Shows You the Full Potential

The app isn’t just about showing you how to add one simple feature; it gives you insight into what’s possible with STON.fi’s tools, opening up the door to more advanced ideas and future projects.

Let’s Break It Down

Imagine you’re designing an app where users can trade tokens easily. You’ve got the app’s main features in mind, but you need to figure out how to incorporate a simple token swap function. The STON.fi demo app is your perfect starting point. It gives you a pre-built, working example of how to integrate token swaps, saving you the headache of figuring out how to do it from scratch.

It’s like buying a DIY kit for a project—you get the materials (API & SDK), plus a guide that shows you how to put it all together. No guesswork.

Real Use Cases

1. Building a Wallet with Token Swaps

If you're building a wallet app and want to offer token swaps to your users, this demo app shows you exactly how to integrate that feature. Instead of piecing it together through trial and error, you get a clear roadmap that saves you time.

2. Creating a DeFi Lending Platform

Maybe you’re working on a DeFi lending platform where users can exchange assets. While your main goal is lending, a swap feature makes the process smoother for your users. This demo app walks you through how to add that feature seamlessly.

Why This is a Big Deal

Here’s the thing: the blockchain space is about simplifying processes and opening up new opportunities. Developers should be able to focus on innovation, not get stuck on the technical details. This demo app cuts through the complexity and provides a working example, so you can get to building quickly.

In traditional finance, things move slowly because they’re burdened with outdated systems and red tape. Blockchain, on the other hand, thrives on speed, innovation, and flexibility. Tools like the STON.fi demo app are key in accelerating this innovation by making the technical side easier for developers.

I’ve been in the blockchain space long enough to see how frustrating and time-consuming integrating new features can be. It’s like being handed a complex puzzle without a guide—sure, you might get there eventually, but it’s a lot of wasted effort.

That’s why tools like this demo app are so powerful. They give you clarity. They give you a head start. And most importantly, they save you time. I’ve seen developers waste days just trying to figure out how to add simple functions. With this tool, you can skip that frustration and jump straight into what matters: building great apps.

If you're a developer in the TON ecosystem, the STON.fi API & SDK Demo App is a must-have resource. It’s more than just a demo; it’s a practical tool that helps you integrate powerful features into your projects faster and more efficiently.

Try the API and DEMO

Innovation in blockchain shouldn’t be complicated. The right tools can make all the difference in helping you bring your ideas to life. So dive in, explore the demo, and see how STON.fi can enhance your development experience.

Great things happen when developers have the tools they need. This is one of those tools.

[govindhtech]

What is Argo CD? And When Was Argo CD Established?

What Is Argo CD?

Argo CD is declarative Kubernetes GitOps continuous delivery.

In DevOps, ArgoCD is a Continuous Delivery (CD) technology that has become well-liked for delivering applications to Kubernetes. It is based on the GitOps deployment methodology.

When was Argo CD Established?

Argo CD was created at Intuit and made publicly available following Applatix’s 2018 acquisition by Intuit. The founding developers of Applatix, Hong Wang, Jesse Suen, and Alexander Matyushentsev, made the Argo project open-source in 2017.

Why Argo CD?

Declarative and version-controlled application definitions, configurations, and environments are ideal. Automated, auditable, and easily comprehensible application deployment and lifecycle management are essential.

Getting Started

Quick Start

kubectl create namespace argocd kubectl apply -n argocd -f https://raw.githubusercontent.com/argoproj/argo-cd/stable/manifests/install.yaml

For some features, more user-friendly documentation is offered. Refer to the upgrade guide if you want to upgrade your Argo CD. Those interested in creating third-party connectors can access developer-oriented resources.

How it works

Argo CD defines the intended application state by employing Git repositories as the source of truth, in accordance with the GitOps pattern. There are various approaches to specify Kubernetes manifests:

Applications for Customization

Helm charts

JSONNET files

Simple YAML/JSON manifest directory

Any custom configuration management tool that is set up as a plugin

The deployment of the intended application states in the designated target settings is automated by Argo CD. Deployments of applications can monitor changes to branches, tags, or pinned to a particular manifest version at a Git commit.

Architecture

The implementation of Argo CD is a Kubernetes controller that continually observes active apps and contrasts their present, live state with the target state (as defined in the Git repository). Out Of Sync is the term used to describe a deployed application whose live state differs from the target state. In addition to reporting and visualizing the differences, Argo CD offers the ability to manually or automatically sync the current state back to the intended goal state. The designated target environments can automatically apply and reflect any changes made to the intended target state in the Git repository.

Components

API Server

The Web UI, CLI, and CI/CD systems use the API, which is exposed by the gRPC/REST server. Its duties include the following:

Status reporting and application management

Launching application functions (such as rollback, sync, and user-defined actions)

Cluster credential management and repository (k8s secrets)

RBAC enforcement

Authentication, and auth delegation to outside identity providers

Git webhook event listener/forwarder

Repository Server

An internal service called the repository server keeps a local cache of the Git repository containing the application manifests. When given the following inputs, it is in charge of creating and returning the Kubernetes manifests:

URL of the repository

Revision (tag, branch, commit)

Path of the application

Template-specific configurations: helm values.yaml, parameters

A Kubernetes controller known as the application controller keeps an eye on all active apps and contrasts their actual, live state with the intended target state as defined in the repository. When it identifies an Out Of Sync application state, it may take remedial action. It is in charge of calling any user-specified hooks for lifecycle events (Sync, PostSync, and PreSync).

Features

Applications are automatically deployed to designated target environments.

Multiple configuration management/templating tools (Kustomize, Helm, Jsonnet, and plain-YAML) are supported.

Capacity to oversee and implement across several clusters

Integration of SSO (OIDC, OAuth2, LDAP, SAML 2.0, Microsoft, LinkedIn, GitHub, GitLab)

RBAC and multi-tenancy authorization policies

Rollback/Roll-anywhere to any Git repository-committed application configuration

Analysis of the application resources’ health state

Automated visualization and detection of configuration drift

Applications can be synced manually or automatically to their desired state.

Web user interface that shows program activity in real time

CLI for CI integration and automation

Integration of webhooks (GitHub, BitBucket, GitLab)

Tokens of access for automation

Hooks for PreSync, Sync, and PostSync to facilitate intricate application rollouts (such as canary and blue/green upgrades)

Application event and API call audit trails

Prometheus measurements

To override helm parameters in Git, use parameter overrides.

Read more on Govindhtech.com